Class ImportDataConfig (3.31.0)

public final class ImportDataConfig extends 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

Static Fields

ANNOTATION_LABELS_FIELD_NUMBER

public static final int ANNOTATION_LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

DATA_ITEM_LABELS_FIELD_NUMBER

public static final int DATA_ITEM_LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

GCS_SOURCE_FIELD_NUMBER

public static final int GCS_SOURCE_FIELD_NUMBER
Field Value
TypeDescription
int

IMPORT_SCHEMA_URI_FIELD_NUMBER

public static final int IMPORT_SCHEMA_URI_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ImportDataConfig getDefaultInstance()
Returns
TypeDescription
ImportDataConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ImportDataConfig.Builder newBuilder()
Returns
TypeDescription
ImportDataConfig.Builder

newBuilder(ImportDataConfig prototype)

public static ImportDataConfig.Builder newBuilder(ImportDataConfig prototype)
Parameter
NameDescription
prototypeImportDataConfig
Returns
TypeDescription
ImportDataConfig.Builder

parseDelimitedFrom(InputStream input)

public static ImportDataConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ImportDataConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportDataConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportDataConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ImportDataConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ImportDataConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ImportDataConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportDataConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ImportDataConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ImportDataConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ImportDataConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportDataConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ImportDataConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ImportDataConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportDataConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportDataConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ImportDataConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ImportDataConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportDataConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportDataConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ImportDataConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ImportDataConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ImportDataConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportDataConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ImportDataConfig> parser()
Returns
TypeDescription
Parser<ImportDataConfig>

Methods

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

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

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

getGcsSource()

public GcsSource getGcsSource()

The Google Cloud Storage location for the input content.

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

Returns
TypeDescription
GcsSource

The gcsSource.

getGcsSourceOrBuilder()

public GcsSourceOrBuilder getGcsSourceOrBuilder()

The Google Cloud Storage location for the input content.

.google.cloud.aiplatform.v1beta1.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.

getParserForType()

public Parser<ImportDataConfig> getParserForType()
Returns
TypeDescription
Parser<ImportDataConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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.v1beta1.GcsSource gcs_source = 1;

Returns
TypeDescription
boolean

Whether the gcsSource field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ImportDataConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ImportDataConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException