Class ImportDataConfig.Builder (3.54.0)

public static final class ImportDataConfig.Builder extends GeneratedMessageV3.Builder<ImportDataConfig.Builder> 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.v1.ImportDataConfig

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ImportDataConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ImportDataConfig.Builder
Overrides

build()

public ImportDataConfig build()
Returns
Type Description
ImportDataConfig

buildPartial()

public ImportDataConfig buildPartial()
Returns
Type Description
ImportDataConfig

clear()

public ImportDataConfig.Builder clear()
Returns
Type Description
ImportDataConfig.Builder
Overrides

clearAnnotationLabels()

public ImportDataConfig.Builder clearAnnotationLabels()
Returns
Type Description
ImportDataConfig.Builder

clearDataItemLabels()

public ImportDataConfig.Builder clearDataItemLabels()
Returns
Type Description
ImportDataConfig.Builder

clearField(Descriptors.FieldDescriptor field)

public ImportDataConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ImportDataConfig.Builder
Overrides

clearGcsSource()

public ImportDataConfig.Builder clearGcsSource()

The Google Cloud Storage location for the input content.

.google.cloud.aiplatform.v1.GcsSource gcs_source = 1;

Returns
Type Description
ImportDataConfig.Builder

clearImportSchemaUri()

public ImportDataConfig.Builder clearImportSchemaUri()

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.

string import_schema_uri = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ImportDataConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ImportDataConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ImportDataConfig.Builder
Overrides

clearSource()

public ImportDataConfig.Builder clearSource()
Returns
Type Description
ImportDataConfig.Builder

clone()

public ImportDataConfig.Builder clone()
Returns
Type Description
ImportDataConfig.Builder
Overrides

containsAnnotationLabels(String key)

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, payload_schema_uri and all of their labels are the same. These labels will be overridden by Annotation labels specified inside index file referenced by import_schema_uri, e.g. jsonl file.

map<string, string> annotation_labels = 3;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsDataItemLabels(String key)

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, e.g. jsonl file.

map<string, string> data_item_labels = 2;

Parameter
Name Description
key String
Returns
Type Description
boolean

getAnnotationLabels() (deprecated)

public Map<String,String> getAnnotationLabels()
Returns
Type Description
Map<String,String>

getAnnotationLabelsCount()

public int getAnnotationLabelsCount()

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, payload_schema_uri and all of their labels are the same. These labels will be overridden by Annotation labels specified inside index file referenced by import_schema_uri, e.g. jsonl file.

map<string, string> annotation_labels = 3;

Returns
Type Description
int

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, payload_schema_uri and all of their labels are the same. These labels will be overridden by Annotation labels specified inside index file referenced by import_schema_uri, e.g. jsonl file.

map<string, string> annotation_labels = 3;

Returns
Type Description
Map<String,String>

getAnnotationLabelsOrDefault(String key, String defaultValue)

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, payload_schema_uri and all of their labels are the same. These labels will be overridden by Annotation labels specified inside index file referenced by import_schema_uri, e.g. jsonl file.

map<string, string> annotation_labels = 3;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getAnnotationLabelsOrThrow(String key)

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, payload_schema_uri and all of their labels are the same. These labels will be overridden by Annotation labels specified inside index file referenced by import_schema_uri, e.g. jsonl file.

map<string, string> annotation_labels = 3;

Parameter
Name Description
key String
Returns
Type Description
String

getDataItemLabels() (deprecated)

public Map<String,String> getDataItemLabels()
Returns
Type Description
Map<String,String>

getDataItemLabelsCount()

public int getDataItemLabelsCount()

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, e.g. jsonl file.

map<string, string> data_item_labels = 2;

Returns
Type Description
int

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, e.g. jsonl file.

map<string, string> data_item_labels = 2;

Returns
Type Description
Map<String,String>

getDataItemLabelsOrDefault(String key, String defaultValue)

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, e.g. jsonl file.

map<string, string> data_item_labels = 2;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getDataItemLabelsOrThrow(String key)

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, e.g. jsonl file.

map<string, string> data_item_labels = 2;

Parameter
Name Description
key String
Returns
Type Description
String

getDefaultInstanceForType()

public ImportDataConfig getDefaultInstanceForType()
Returns
Type Description
ImportDataConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getGcsSource()

public GcsSource getGcsSource()

The Google Cloud Storage location for the input content.

.google.cloud.aiplatform.v1.GcsSource gcs_source = 1;

Returns
Type Description
GcsSource

The gcsSource.

getGcsSourceBuilder()

public GcsSource.Builder getGcsSourceBuilder()

The Google Cloud Storage location for the input content.

.google.cloud.aiplatform.v1.GcsSource gcs_source = 1;

Returns
Type Description
GcsSource.Builder

getGcsSourceOrBuilder()

public GcsSourceOrBuilder getGcsSourceOrBuilder()

The Google Cloud Storage location for the input content.

.google.cloud.aiplatform.v1.GcsSource gcs_source = 1;

Returns
Type Description
GcsSourceOrBuilder

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.

string import_schema_uri = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The importSchemaUri.

getImportSchemaUriBytes()

public 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.

string import_schema_uri = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for importSchemaUri.

getMutableAnnotationLabels() (deprecated)

public Map<String,String> getMutableAnnotationLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getMutableDataItemLabels() (deprecated)

public Map<String,String> getMutableDataItemLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getSourceCase()

public ImportDataConfig.SourceCase getSourceCase()
Returns
Type Description
ImportDataConfig.SourceCase

hasGcsSource()

public boolean hasGcsSource()

The Google Cloud Storage location for the input content.

.google.cloud.aiplatform.v1.GcsSource gcs_source = 1;

Returns
Type Description
boolean

Whether the gcsSource field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ImportDataConfig other)

public ImportDataConfig.Builder mergeFrom(ImportDataConfig other)
Parameter
Name Description
other ImportDataConfig
Returns
Type Description
ImportDataConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ImportDataConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportDataConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ImportDataConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ImportDataConfig.Builder
Overrides

mergeGcsSource(GcsSource value)

public ImportDataConfig.Builder mergeGcsSource(GcsSource value)

The Google Cloud Storage location for the input content.

.google.cloud.aiplatform.v1.GcsSource gcs_source = 1;

Parameter
Name Description
value GcsSource
Returns
Type Description
ImportDataConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ImportDataConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ImportDataConfig.Builder
Overrides

putAllAnnotationLabels(Map<String,String> values)

public ImportDataConfig.Builder putAllAnnotationLabels(Map<String,String> values)

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, payload_schema_uri and all of their labels are the same. These labels will be overridden by Annotation labels specified inside index file referenced by import_schema_uri, e.g. jsonl file.

map<string, string> annotation_labels = 3;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
ImportDataConfig.Builder

putAllDataItemLabels(Map<String,String> values)

public ImportDataConfig.Builder putAllDataItemLabels(Map<String,String> values)

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, e.g. jsonl file.

map<string, string> data_item_labels = 2;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
ImportDataConfig.Builder

putAnnotationLabels(String key, String value)

public ImportDataConfig.Builder putAnnotationLabels(String key, String value)

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, payload_schema_uri and all of their labels are the same. These labels will be overridden by Annotation labels specified inside index file referenced by import_schema_uri, e.g. jsonl file.

map<string, string> annotation_labels = 3;

Parameters
Name Description
key String
value String
Returns
Type Description
ImportDataConfig.Builder

putDataItemLabels(String key, String value)

public ImportDataConfig.Builder putDataItemLabels(String key, String value)

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, e.g. jsonl file.

map<string, string> data_item_labels = 2;

Parameters
Name Description
key String
value String
Returns
Type Description
ImportDataConfig.Builder

removeAnnotationLabels(String key)

public ImportDataConfig.Builder removeAnnotationLabels(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, payload_schema_uri and all of their labels are the same. These labels will be overridden by Annotation labels specified inside index file referenced by import_schema_uri, e.g. jsonl file.

map<string, string> annotation_labels = 3;

Parameter
Name Description
key String
Returns
Type Description
ImportDataConfig.Builder

removeDataItemLabels(String key)

public ImportDataConfig.Builder removeDataItemLabels(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, e.g. jsonl file.

map<string, string> data_item_labels = 2;

Parameter
Name Description
key String
Returns
Type Description
ImportDataConfig.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ImportDataConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ImportDataConfig.Builder
Overrides

setGcsSource(GcsSource value)

public ImportDataConfig.Builder setGcsSource(GcsSource value)

The Google Cloud Storage location for the input content.

.google.cloud.aiplatform.v1.GcsSource gcs_source = 1;

Parameter
Name Description
value GcsSource
Returns
Type Description
ImportDataConfig.Builder

setGcsSource(GcsSource.Builder builderForValue)

public ImportDataConfig.Builder setGcsSource(GcsSource.Builder builderForValue)

The Google Cloud Storage location for the input content.

.google.cloud.aiplatform.v1.GcsSource gcs_source = 1;

Parameter
Name Description
builderForValue GcsSource.Builder
Returns
Type Description
ImportDataConfig.Builder

setImportSchemaUri(String value)

public ImportDataConfig.Builder setImportSchemaUri(String value)

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.

string import_schema_uri = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The importSchemaUri to set.

Returns
Type Description
ImportDataConfig.Builder

This builder for chaining.

setImportSchemaUriBytes(ByteString value)

public ImportDataConfig.Builder setImportSchemaUriBytes(ByteString value)

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.

string import_schema_uri = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for importSchemaUri to set.

Returns
Type Description
ImportDataConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ImportDataConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ImportDataConfig.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ImportDataConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ImportDataConfig.Builder
Overrides