Package com.google.cloud.aiplatform.v1beta1

Class ImportDataConfig

  • All Implemented Interfaces:
    ImportDataConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ImportDataConfig
extends com.google.protobuf.GeneratedMessageV3
implements ImportDataConfigOrBuilder
     Describes the location from where we import data into a Dataset, together
 with the labels that will be applied to the DataItems and the Annotations.
    Protobuf type google.cloud.aiplatform.v1beta1.ImportDataConfig
    See Also:
    Serialized Form

    • Field Detail

      • GCS_SOURCE_FIELD_NUMBER

        public static final int GCS_SOURCE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DATA_ITEM_LABELS_FIELD_NUMBER

        public static final int DATA_ITEM_LABELS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ANNOTATION_LABELS_FIELD_NUMBER

        public static final int ANNOTATION_LABELS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • IMPORT_SCHEMA_URI_FIELD_NUMBER

        public static final int IMPORT_SCHEMA_URI_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasGcsSource

        public boolean hasGcsSource()
         The Google Cloud Storage location for the input content.
        .google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 1;
        Specified by:
        hasGcsSource in interface ImportDataConfigOrBuilder
        Returns:
        Whether the gcsSource field is set.

      • getGcsSource

        public GcsSource getGcsSource()
         The Google Cloud Storage location for the input content.
        .google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 1;
        Specified by:
        getGcsSource in interface ImportDataConfigOrBuilder
        Returns:
        The gcsSource.

      • getDataItemLabelsCount

        public int getDataItemLabelsCount()
        Description copied from interface: ImportDataConfigOrBuilder
         Labels that will be applied to newly imported DataItems. If an identical
 DataItem as one being imported already exists in the Dataset, then these
 labels will be appended to these of the already existing one, and if labels
 with identical key is imported before, the old label value will be
 overwritten. If two DataItems are identical in the same import data
 operation, the labels will be combined and if key collision happens in this
 case, one of the values will be picked randomly. Two DataItems are
 considered identical if their content bytes are identical (e.g. image bytes
 or pdf bytes).
 These labels will be overridden by Annotation labels specified inside index
 file referenced by
 [import_schema_uri][google.cloud.aiplatform.v1beta1.ImportDataConfig.import_schema_uri],
 e.g. jsonl file.
        map<string, string> data_item_labels = 2;
        Specified by:
        getDataItemLabelsCount in interface ImportDataConfigOrBuilder

      • containsDataItemLabels

        public boolean containsDataItemLabels​(String key)
         Labels that will be applied to newly imported DataItems. If an identical
 DataItem as one being imported already exists in the Dataset, then these
 labels will be appended to these of the already existing one, and if labels
 with identical key is imported before, the old label value will be
 overwritten. If two DataItems are identical in the same import data
 operation, the labels will be combined and if key collision happens in this
 case, one of the values will be picked randomly. Two DataItems are
 considered identical if their content bytes are identical (e.g. image bytes
 or pdf bytes).
 These labels will be overridden by Annotation labels specified inside index
 file referenced by
 [import_schema_uri][google.cloud.aiplatform.v1beta1.ImportDataConfig.import_schema_uri],
 e.g. jsonl file.
        map<string, string> data_item_labels = 2;
        Specified by:
        containsDataItemLabels in interface ImportDataConfigOrBuilder

      • getDataItemLabelsMap

        public Map<String,​String> getDataItemLabelsMap()
         Labels that will be applied to newly imported DataItems. If an identical
 DataItem as one being imported already exists in the Dataset, then these
 labels will be appended to these of the already existing one, and if labels
 with identical key is imported before, the old label value will be
 overwritten. If two DataItems are identical in the same import data
 operation, the labels will be combined and if key collision happens in this
 case, one of the values will be picked randomly. Two DataItems are
 considered identical if their content bytes are identical (e.g. image bytes
 or pdf bytes).
 These labels will be overridden by Annotation labels specified inside index
 file referenced by
 [import_schema_uri][google.cloud.aiplatform.v1beta1.ImportDataConfig.import_schema_uri],
 e.g. jsonl file.
        map<string, string> data_item_labels = 2;
        Specified by:
        getDataItemLabelsMap in interface ImportDataConfigOrBuilder

      • getDataItemLabelsOrDefault

        public String getDataItemLabelsOrDefault​(String key,
                                         String defaultValue)
         Labels that will be applied to newly imported DataItems. If an identical
 DataItem as one being imported already exists in the Dataset, then these
 labels will be appended to these of the already existing one, and if labels
 with identical key is imported before, the old label value will be
 overwritten. If two DataItems are identical in the same import data
 operation, the labels will be combined and if key collision happens in this
 case, one of the values will be picked randomly. Two DataItems are
 considered identical if their content bytes are identical (e.g. image bytes
 or pdf bytes).
 These labels will be overridden by Annotation labels specified inside index
 file referenced by
 [import_schema_uri][google.cloud.aiplatform.v1beta1.ImportDataConfig.import_schema_uri],
 e.g. jsonl file.
        map<string, string> data_item_labels = 2;
        Specified by:
        getDataItemLabelsOrDefault in interface ImportDataConfigOrBuilder

      • getDataItemLabelsOrThrow

        public String getDataItemLabelsOrThrow​(String key)
         Labels that will be applied to newly imported DataItems. If an identical
 DataItem as one being imported already exists in the Dataset, then these
 labels will be appended to these of the already existing one, and if labels
 with identical key is imported before, the old label value will be
 overwritten. If two DataItems are identical in the same import data
 operation, the labels will be combined and if key collision happens in this
 case, one of the values will be picked randomly. Two DataItems are
 considered identical if their content bytes are identical (e.g. image bytes
 or pdf bytes).
 These labels will be overridden by Annotation labels specified inside index
 file referenced by
 [import_schema_uri][google.cloud.aiplatform.v1beta1.ImportDataConfig.import_schema_uri],
 e.g. jsonl file.
        map<string, string> data_item_labels = 2;
        Specified by:
        getDataItemLabelsOrThrow in interface ImportDataConfigOrBuilder

      • getAnnotationLabelsCount

        public int getAnnotationLabelsCount()
        Description copied from interface: ImportDataConfigOrBuilder
         Labels that will be applied to newly imported Annotations. If two
 Annotations are identical, one of them will be deduped. Two Annotations are
 considered identical if their
 [payload][google.cloud.aiplatform.v1beta1.Annotation.payload],
 [payload_schema_uri][google.cloud.aiplatform.v1beta1.Annotation.payload_schema_uri]
 and all of their
 [labels][google.cloud.aiplatform.v1beta1.Annotation.labels] are the same.
 These labels will be overridden by Annotation labels specified inside index
 file referenced by
 [import_schema_uri][google.cloud.aiplatform.v1beta1.ImportDataConfig.import_schema_uri],
 e.g. jsonl file.
        map<string, string> annotation_labels = 3;
        Specified by:
        getAnnotationLabelsCount in interface ImportDataConfigOrBuilder

      • containsAnnotationLabels

        public boolean containsAnnotationLabels​(String key)
         Labels that will be applied to newly imported Annotations. If two
 Annotations are identical, one of them will be deduped. Two Annotations are
 considered identical if their
 [payload][google.cloud.aiplatform.v1beta1.Annotation.payload],
 [payload_schema_uri][google.cloud.aiplatform.v1beta1.Annotation.payload_schema_uri]
 and all of their
 [labels][google.cloud.aiplatform.v1beta1.Annotation.labels] are the same.
 These labels will be overridden by Annotation labels specified inside index
 file referenced by
 [import_schema_uri][google.cloud.aiplatform.v1beta1.ImportDataConfig.import_schema_uri],
 e.g. jsonl file.
        map<string, string> annotation_labels = 3;
        Specified by:
        containsAnnotationLabels in interface ImportDataConfigOrBuilder

      • getAnnotationLabelsMap

        public Map<String,​String> getAnnotationLabelsMap()
         Labels that will be applied to newly imported Annotations. If two
 Annotations are identical, one of them will be deduped. Two Annotations are
 considered identical if their
 [payload][google.cloud.aiplatform.v1beta1.Annotation.payload],
 [payload_schema_uri][google.cloud.aiplatform.v1beta1.Annotation.payload_schema_uri]
 and all of their
 [labels][google.cloud.aiplatform.v1beta1.Annotation.labels] are the same.
 These labels will be overridden by Annotation labels specified inside index
 file referenced by
 [import_schema_uri][google.cloud.aiplatform.v1beta1.ImportDataConfig.import_schema_uri],
 e.g. jsonl file.
        map<string, string> annotation_labels = 3;
        Specified by:
        getAnnotationLabelsMap in interface ImportDataConfigOrBuilder

      • getAnnotationLabelsOrDefault

        public String getAnnotationLabelsOrDefault​(String key,
                                           String defaultValue)
         Labels that will be applied to newly imported Annotations. If two
 Annotations are identical, one of them will be deduped. Two Annotations are
 considered identical if their
 [payload][google.cloud.aiplatform.v1beta1.Annotation.payload],
 [payload_schema_uri][google.cloud.aiplatform.v1beta1.Annotation.payload_schema_uri]
 and all of their
 [labels][google.cloud.aiplatform.v1beta1.Annotation.labels] are the same.
 These labels will be overridden by Annotation labels specified inside index
 file referenced by
 [import_schema_uri][google.cloud.aiplatform.v1beta1.ImportDataConfig.import_schema_uri],
 e.g. jsonl file.
        map<string, string> annotation_labels = 3;
        Specified by:
        getAnnotationLabelsOrDefault in interface ImportDataConfigOrBuilder

      • getAnnotationLabelsOrThrow

        public String getAnnotationLabelsOrThrow​(String key)
         Labels that will be applied to newly imported Annotations. If two
 Annotations are identical, one of them will be deduped. Two Annotations are
 considered identical if their
 [payload][google.cloud.aiplatform.v1beta1.Annotation.payload],
 [payload_schema_uri][google.cloud.aiplatform.v1beta1.Annotation.payload_schema_uri]
 and all of their
 [labels][google.cloud.aiplatform.v1beta1.Annotation.labels] are the same.
 These labels will be overridden by Annotation labels specified inside index
 file referenced by
 [import_schema_uri][google.cloud.aiplatform.v1beta1.ImportDataConfig.import_schema_uri],
 e.g. jsonl file.
        map<string, string> annotation_labels = 3;
        Specified by:
        getAnnotationLabelsOrThrow in interface ImportDataConfigOrBuilder

      • getImportSchemaUri

        public String getImportSchemaUri()
         Required. Points to a YAML file stored on Google Cloud Storage describing
 the import format. Validation will be done against the schema. The schema
 is defined as an [OpenAPI 3.0.2 Schema
 Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
        string import_schema_uri = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getImportSchemaUri in interface ImportDataConfigOrBuilder
        Returns:
        The importSchemaUri.

      • getImportSchemaUriBytes

        public com.google.protobuf.ByteString getImportSchemaUriBytes()
         Required. Points to a YAML file stored on Google Cloud Storage describing
 the import format. Validation will be done against the schema. The schema
 is defined as an [OpenAPI 3.0.2 Schema
 Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
        string import_schema_uri = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getImportSchemaUriBytes in interface ImportDataConfigOrBuilder
        Returns:
        The bytes for importSchemaUri.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static ImportDataConfig parseFrom​(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ImportDataConfig parseFrom​(ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ImportDataConfig parseFrom​(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ImportDataConfig parseFrom​(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ImportDataConfig parseFrom​(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ImportDataConfig parseFrom​(byte[] data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ImportDataConfig parseFrom​(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException
        Throws:
        IOException

      • newBuilderForType

        public ImportDataConfig.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ImportDataConfig.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ImportDataConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<ImportDataConfig> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public ImportDataConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder