Class ImportDataConfig.Builder (3.25.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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ImportDataConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ImportDataConfig.Builder
Overrides

build()

public ImportDataConfig build()
Returns
TypeDescription
ImportDataConfig

buildPartial()

public ImportDataConfig buildPartial()
Returns
TypeDescription
ImportDataConfig

clear()

public ImportDataConfig.Builder clear()
Returns
TypeDescription
ImportDataConfig.Builder
Overrides

clearAnnotationLabels()

public ImportDataConfig.Builder clearAnnotationLabels()
Returns
TypeDescription
ImportDataConfig.Builder

clearDataItemLabels()

public ImportDataConfig.Builder clearDataItemLabels()
Returns
TypeDescription
ImportDataConfig.Builder

clearField(Descriptors.FieldDescriptor field)

public ImportDataConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ImportDataConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ImportDataConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ImportDataConfig.Builder
Overrides

clearSource()

public ImportDataConfig.Builder clearSource()
Returns
TypeDescription
ImportDataConfig.Builder

clone()

public ImportDataConfig.Builder clone()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

getAnnotationLabels()

public Map<String,String> getAnnotationLabels()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
String

getDataItemLabels()

public Map<String,String> getDataItemLabels()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
String

getDefaultInstanceForType()

public ImportDataConfig getDefaultInstanceForType()
Returns
TypeDescription
ImportDataConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getGcsSource()

public GcsSource getGcsSource()

The Google Cloud Storage location for the input content.

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

Returns
TypeDescription
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
TypeDescription
GcsSource.Builder

getGcsSourceOrBuilder()

public GcsSourceOrBuilder getGcsSourceOrBuilder()

The Google Cloud Storage location for the input content.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for importSchemaUri.

getMutableAnnotationLabels()

public Map<String,String> getMutableAnnotationLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getMutableDataItemLabels()

public Map<String,String> getMutableDataItemLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getSourceCase()

public ImportDataConfig.SourceCase getSourceCase()
Returns
TypeDescription
ImportDataConfig.SourceCase

hasGcsSource()

public boolean hasGcsSource()

The Google Cloud Storage location for the input content.

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

Returns
TypeDescription
boolean

Whether the gcsSource field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ImportDataConfig other)

public ImportDataConfig.Builder mergeFrom(ImportDataConfig other)
Parameter
NameDescription
otherImportDataConfig
Returns
TypeDescription
ImportDataConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ImportDataConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportDataConfig.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ImportDataConfig.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
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
NameDescription
valueGcsSource
Returns
TypeDescription
ImportDataConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ImportDataConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valuesMap<String,String>
Returns
TypeDescription
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
NameDescription
valuesMap<String,String>
Returns
TypeDescription
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
NameDescription
keyString
valueString
Returns
TypeDescription
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
NameDescription
keyString
valueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
ImportDataConfig.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ImportDataConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueGcsSource
Returns
TypeDescription
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
NameDescription
builderForValueGcsSource.Builder
Returns
TypeDescription
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
NameDescription
valueString

The importSchemaUri to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for importSchemaUri to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ImportDataConfig.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ImportDataConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ImportDataConfig.Builder
Overrides