Class InputDataConfig (3.45.0)

Version 3.45.0

• 3.52.0 (latest)
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public final class InputDataConfig extends GeneratedMessageV3 implements InputDataConfigOrBuilder

Specifies Vertex AI owned input data to be used for training, and possibly evaluating, the Model.

Protobuf type google.cloud.aiplatform.v1beta1.InputDataConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > InputDataConfig

Implements

InputDataConfigOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ANNOTATIONS_FILTER_FIELD_NUMBER

public static final int ANNOTATIONS_FILTER_FIELD_NUMBER

Field Value
Type	Description
int

ANNOTATION_SCHEMA_URI_FIELD_NUMBER

public static final int ANNOTATION_SCHEMA_URI_FIELD_NUMBER

Field Value
Type	Description
int

BIGQUERY_DESTINATION_FIELD_NUMBER

public static final int BIGQUERY_DESTINATION_FIELD_NUMBER

Field Value
Type	Description
int

DATASET_ID_FIELD_NUMBER

public static final int DATASET_ID_FIELD_NUMBER

Field Value
Type	Description
int

FILTER_SPLIT_FIELD_NUMBER

public static final int FILTER_SPLIT_FIELD_NUMBER

Field Value
Type	Description
int

FRACTION_SPLIT_FIELD_NUMBER

public static final int FRACTION_SPLIT_FIELD_NUMBER

Field Value
Type	Description
int

GCS_DESTINATION_FIELD_NUMBER

public static final int GCS_DESTINATION_FIELD_NUMBER

Field Value
Type	Description
int

PERSIST_ML_USE_ASSIGNMENT_FIELD_NUMBER

public static final int PERSIST_ML_USE_ASSIGNMENT_FIELD_NUMBER

Field Value
Type	Description
int

PREDEFINED_SPLIT_FIELD_NUMBER

public static final int PREDEFINED_SPLIT_FIELD_NUMBER

Field Value
Type	Description
int

SAVED_QUERY_ID_FIELD_NUMBER

public static final int SAVED_QUERY_ID_FIELD_NUMBER

Field Value
Type	Description
int

STRATIFIED_SPLIT_FIELD_NUMBER

public static final int STRATIFIED_SPLIT_FIELD_NUMBER

Field Value
Type	Description
int

TIMESTAMP_SPLIT_FIELD_NUMBER

public static final int TIMESTAMP_SPLIT_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static InputDataConfig getDefaultInstance()

Returns
Type	Description
InputDataConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static InputDataConfig.Builder newBuilder()

Returns
Type	Description
InputDataConfig.Builder

newBuilder(InputDataConfig prototype)

public static InputDataConfig.Builder newBuilder(InputDataConfig prototype)

Parameter
Name	Description
prototype	InputDataConfig

Returns
Type	Description
InputDataConfig.Builder

parseDelimitedFrom(InputStream input)

public static InputDataConfig parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
InputDataConfig

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static InputDataConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
InputDataConfig

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static InputDataConfig parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
InputDataConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static InputDataConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
InputDataConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static InputDataConfig parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
InputDataConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static InputDataConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
InputDataConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static InputDataConfig parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
InputDataConfig

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static InputDataConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
InputDataConfig

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static InputDataConfig parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
InputDataConfig

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static InputDataConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
InputDataConfig

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static InputDataConfig parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
InputDataConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static InputDataConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
InputDataConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<InputDataConfig> parser()

Returns
Type	Description
Parser<InputDataConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getAnnotationSchemaUri()

public String getAnnotationSchemaUri()

Applicable only to custom training with Datasets that have DataItems and Annotations.

Cloud Storage URI that points to a YAML file describing the annotation schema. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/annotation/ , note that the chosen schema must be consistent with metadata of the Dataset specified by dataset_id.

Only Annotations that both match this schema and belong to DataItems not ignored by the split method are used in respectively training, validation or test role, depending on the role of the DataItem they are on.

When used in conjunction with annotations_filter, the Annotations used for training are filtered by both annotations_filter and annotation_schema_uri.

string annotation_schema_uri = 9;

Returns
Type	Description
String	The annotationSchemaUri.

getAnnotationSchemaUriBytes()

public ByteString getAnnotationSchemaUriBytes()

Applicable only to custom training with Datasets that have DataItems and Annotations.

Cloud Storage URI that points to a YAML file describing the annotation schema. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/annotation/ , note that the chosen schema must be consistent with metadata of the Dataset specified by dataset_id.

Only Annotations that both match this schema and belong to DataItems not ignored by the split method are used in respectively training, validation or test role, depending on the role of the DataItem they are on.

When used in conjunction with annotations_filter, the Annotations used for training are filtered by both annotations_filter and annotation_schema_uri.

string annotation_schema_uri = 9;

Returns
Type	Description
ByteString	The bytes for annotationSchemaUri.

getAnnotationsFilter()

public String getAnnotationsFilter()

Applicable only to Datasets that have DataItems and Annotations.

A filter on Annotations of the Dataset. Only Annotations that both match this filter and belong to DataItems not ignored by the split method are used in respectively training, validation or test role, depending on the role of the DataItem they are on (for the auto-assigned that role is decided by Vertex AI). A filter with same syntax as the one used in ListAnnotations may be used, but note here it filters across all Annotations of the Dataset, and not just within a single DataItem.

string annotations_filter = 6;

Returns
Type	Description
String	The annotationsFilter.

getAnnotationsFilterBytes()

public ByteString getAnnotationsFilterBytes()

Applicable only to Datasets that have DataItems and Annotations.

A filter on Annotations of the Dataset. Only Annotations that both match this filter and belong to DataItems not ignored by the split method are used in respectively training, validation or test role, depending on the role of the DataItem they are on (for the auto-assigned that role is decided by Vertex AI). A filter with same syntax as the one used in ListAnnotations may be used, but note here it filters across all Annotations of the Dataset, and not just within a single DataItem.

string annotations_filter = 6;

Returns
Type	Description
ByteString	The bytes for annotationsFilter.

getBigqueryDestination()

public BigQueryDestination getBigqueryDestination()

Only applicable to custom training with tabular Dataset with BigQuery source.

The BigQuery project location where the training data is to be written to. In the given project a new dataset is created with name dataset_<dataset-id><annotation-type><timestamp-of-training-call> where timestamp is in YYYY_MM_DDThh_mm_ss_sssZ format. All training input data is written into that dataset. In the dataset three tables are created, training, validation and test.

• AIP_DATA_FORMAT = "bigquery".

• AIP_TRAINING_DATA_URI = "bigquery_destination.dataset_<dataset-id><annotation-type><time>.training"

• AIP_VALIDATION_DATA_URI = "bigquery_destination.dataset_<dataset-id><annotation-type><time>.validation"

• AIP_TEST_DATA_URI = "bigquery_destination.dataset_<dataset-id><annotation-type><time>.test"

.google.cloud.aiplatform.v1beta1.BigQueryDestination bigquery_destination = 10;

Returns
Type	Description
BigQueryDestination	The bigqueryDestination.

getBigqueryDestinationOrBuilder()

public BigQueryDestinationOrBuilder getBigqueryDestinationOrBuilder()

Only applicable to custom training with tabular Dataset with BigQuery source.

The BigQuery project location where the training data is to be written to. In the given project a new dataset is created with name dataset_<dataset-id><annotation-type><timestamp-of-training-call> where timestamp is in YYYY_MM_DDThh_mm_ss_sssZ format. All training input data is written into that dataset. In the dataset three tables are created, training, validation and test.

• AIP_DATA_FORMAT = "bigquery".

• AIP_TRAINING_DATA_URI = "bigquery_destination.dataset_<dataset-id><annotation-type><time>.training"

• AIP_VALIDATION_DATA_URI = "bigquery_destination.dataset_<dataset-id><annotation-type><time>.validation"

• AIP_TEST_DATA_URI = "bigquery_destination.dataset_<dataset-id><annotation-type><time>.test"

.google.cloud.aiplatform.v1beta1.BigQueryDestination bigquery_destination = 10;

Returns
Type	Description
BigQueryDestinationOrBuilder

getDatasetId()

public String getDatasetId()

Required. The ID of the Dataset in the same Project and Location which data will be used to train the Model. The Dataset must use schema compatible with Model being trained, and what is compatible should be described in the used TrainingPipeline's [training_task_definition] [google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition]. For tabular Datasets, all their data is exported to training, to pick and choose from.

string dataset_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The datasetId.

getDatasetIdBytes()

public ByteString getDatasetIdBytes()

Required. The ID of the Dataset in the same Project and Location which data will be used to train the Model. The Dataset must use schema compatible with Model being trained, and what is compatible should be described in the used TrainingPipeline's [training_task_definition] [google.cloud.aiplatform.v1beta1.TrainingPipeline.training_task_definition]. For tabular Datasets, all their data is exported to training, to pick and choose from.

string dataset_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for datasetId.

getDefaultInstanceForType()

public InputDataConfig getDefaultInstanceForType()

Returns
Type	Description
InputDataConfig

getDestinationCase()

public InputDataConfig.DestinationCase getDestinationCase()

Returns
Type	Description
InputDataConfig.DestinationCase

getFilterSplit()

public FilterSplit getFilterSplit()

Split based on the provided filters for each set.

.google.cloud.aiplatform.v1beta1.FilterSplit filter_split = 3;

Returns
Type	Description
FilterSplit	The filterSplit.

getFilterSplitOrBuilder()

public FilterSplitOrBuilder getFilterSplitOrBuilder()

Split based on the provided filters for each set.

.google.cloud.aiplatform.v1beta1.FilterSplit filter_split = 3;

Returns
Type	Description
FilterSplitOrBuilder

getFractionSplit()

public FractionSplit getFractionSplit()

Split based on fractions defining the size of each set.

.google.cloud.aiplatform.v1beta1.FractionSplit fraction_split = 2;

Returns
Type	Description
FractionSplit	The fractionSplit.

getFractionSplitOrBuilder()

public FractionSplitOrBuilder getFractionSplitOrBuilder()

Split based on fractions defining the size of each set.

.google.cloud.aiplatform.v1beta1.FractionSplit fraction_split = 2;

Returns
Type	Description
FractionSplitOrBuilder

getGcsDestination()

public GcsDestination getGcsDestination()

The Cloud Storage location where the training data is to be written to. In the given directory a new directory is created with name: dataset-<dataset-id>-<annotation-type>-<timestamp-of-training-call> where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. All training input data is written into that directory.

The Vertex AI environment variables representing Cloud Storage data URIs are represented in the Cloud Storage wildcard format to support sharded data. e.g.: "gs://.../training-*.jsonl"

• AIP_DATA_FORMAT = "jsonl" for non-tabular data, "csv" for tabular data

• AIP_TRAINING_DATA_URI = "gcs_destination/dataset-<dataset-id>-<annotation-type>-<time>/training-*.${AIP_DATA_FORMAT}"

• AIP_VALIDATION_DATA_URI = "gcs_destination/dataset-<dataset-id>-<annotation-type>-<time>/validation-*.${AIP_DATA_FORMAT}"

• AIP_TEST_DATA_URI = "gcs_destination/dataset-<dataset-id>-<annotation-type>-<time>/test-*.${AIP_DATA_FORMAT}"

.google.cloud.aiplatform.v1beta1.GcsDestination gcs_destination = 8;

Returns
Type	Description
GcsDestination	The gcsDestination.

getGcsDestinationOrBuilder()

public GcsDestinationOrBuilder getGcsDestinationOrBuilder()

The Cloud Storage location where the training data is to be written to. In the given directory a new directory is created with name: dataset-<dataset-id>-<annotation-type>-<timestamp-of-training-call> where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. All training input data is written into that directory.

The Vertex AI environment variables representing Cloud Storage data URIs are represented in the Cloud Storage wildcard format to support sharded data. e.g.: "gs://.../training-*.jsonl"

• AIP_DATA_FORMAT = "jsonl" for non-tabular data, "csv" for tabular data

• AIP_TRAINING_DATA_URI = "gcs_destination/dataset-<dataset-id>-<annotation-type>-<time>/training-*.${AIP_DATA_FORMAT}"

• AIP_VALIDATION_DATA_URI = "gcs_destination/dataset-<dataset-id>-<annotation-type>-<time>/validation-*.${AIP_DATA_FORMAT}"

• AIP_TEST_DATA_URI = "gcs_destination/dataset-<dataset-id>-<annotation-type>-<time>/test-*.${AIP_DATA_FORMAT}"

.google.cloud.aiplatform.v1beta1.GcsDestination gcs_destination = 8;

Returns
Type	Description
GcsDestinationOrBuilder

getParserForType()

public Parser<InputDataConfig> getParserForType()

Returns
Type	Description
Parser<InputDataConfig>

Overrides

GeneratedMessageV3.getParserForType()

getPersistMlUseAssignment()

public boolean getPersistMlUseAssignment()

Whether to persist the ML use assignment to data item system labels.

bool persist_ml_use_assignment = 11;

Returns
Type	Description
boolean	The persistMlUseAssignment.

getPredefinedSplit()

public PredefinedSplit getPredefinedSplit()

Supported only for tabular Datasets.

Split based on a predefined key.

.google.cloud.aiplatform.v1beta1.PredefinedSplit predefined_split = 4;

Returns
Type	Description
PredefinedSplit	The predefinedSplit.

getPredefinedSplitOrBuilder()

public PredefinedSplitOrBuilder getPredefinedSplitOrBuilder()

Supported only for tabular Datasets.

Split based on a predefined key.

.google.cloud.aiplatform.v1beta1.PredefinedSplit predefined_split = 4;

Returns
Type	Description
PredefinedSplitOrBuilder

getSavedQueryId()

public String getSavedQueryId()

Only applicable to Datasets that have SavedQueries.

The ID of a SavedQuery (annotation set) under the Dataset specified by dataset_id used for filtering Annotations for training.

Only Annotations that are associated with this SavedQuery are used in respectively training. When used in conjunction with annotations_filter, the Annotations used for training are filtered by both saved_query_id and annotations_filter.

Only one of saved_query_id and annotation_schema_uri should be specified as both of them represent the same thing: problem type.

string saved_query_id = 7;

Returns
Type	Description
String	The savedQueryId.

getSavedQueryIdBytes()

public ByteString getSavedQueryIdBytes()

Only applicable to Datasets that have SavedQueries.

The ID of a SavedQuery (annotation set) under the Dataset specified by dataset_id used for filtering Annotations for training.

Only Annotations that are associated with this SavedQuery are used in respectively training. When used in conjunction with annotations_filter, the Annotations used for training are filtered by both saved_query_id and annotations_filter.

Only one of saved_query_id and annotation_schema_uri should be specified as both of them represent the same thing: problem type.

string saved_query_id = 7;

Returns
Type	Description
ByteString	The bytes for savedQueryId.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getSplitCase()

public InputDataConfig.SplitCase getSplitCase()

Returns
Type	Description
InputDataConfig.SplitCase

getStratifiedSplit()

public StratifiedSplit getStratifiedSplit()

Supported only for tabular Datasets.

Split based on the distribution of the specified column.

.google.cloud.aiplatform.v1beta1.StratifiedSplit stratified_split = 12;

Returns
Type	Description
StratifiedSplit	The stratifiedSplit.

getStratifiedSplitOrBuilder()

public StratifiedSplitOrBuilder getStratifiedSplitOrBuilder()

Supported only for tabular Datasets.

Split based on the distribution of the specified column.

.google.cloud.aiplatform.v1beta1.StratifiedSplit stratified_split = 12;

Returns
Type	Description
StratifiedSplitOrBuilder

getTimestampSplit()

public TimestampSplit getTimestampSplit()

Supported only for tabular Datasets.

Split based on the timestamp of the input data pieces.

.google.cloud.aiplatform.v1beta1.TimestampSplit timestamp_split = 5;

Returns
Type	Description
TimestampSplit	The timestampSplit.

getTimestampSplitOrBuilder()

public TimestampSplitOrBuilder getTimestampSplitOrBuilder()

Supported only for tabular Datasets.

Split based on the timestamp of the input data pieces.

.google.cloud.aiplatform.v1beta1.TimestampSplit timestamp_split = 5;

Returns
Type	Description
TimestampSplitOrBuilder

hasBigqueryDestination()

public boolean hasBigqueryDestination()

Only applicable to custom training with tabular Dataset with BigQuery source.

The BigQuery project location where the training data is to be written to. In the given project a new dataset is created with name dataset_<dataset-id><annotation-type><timestamp-of-training-call> where timestamp is in YYYY_MM_DDThh_mm_ss_sssZ format. All training input data is written into that dataset. In the dataset three tables are created, training, validation and test.

• AIP_DATA_FORMAT = "bigquery".

• AIP_TRAINING_DATA_URI = "bigquery_destination.dataset_<dataset-id><annotation-type><time>.training"

• AIP_VALIDATION_DATA_URI = "bigquery_destination.dataset_<dataset-id><annotation-type><time>.validation"

• AIP_TEST_DATA_URI = "bigquery_destination.dataset_<dataset-id><annotation-type><time>.test"

.google.cloud.aiplatform.v1beta1.BigQueryDestination bigquery_destination = 10;

Returns
Type	Description
boolean	Whether the bigqueryDestination field is set.

hasFilterSplit()

public boolean hasFilterSplit()

Split based on the provided filters for each set.

.google.cloud.aiplatform.v1beta1.FilterSplit filter_split = 3;

Returns
Type	Description
boolean	Whether the filterSplit field is set.

hasFractionSplit()

public boolean hasFractionSplit()

Split based on fractions defining the size of each set.

.google.cloud.aiplatform.v1beta1.FractionSplit fraction_split = 2;

Returns
Type	Description
boolean	Whether the fractionSplit field is set.

hasGcsDestination()

public boolean hasGcsDestination()

The Cloud Storage location where the training data is to be written to. In the given directory a new directory is created with name: dataset-<dataset-id>-<annotation-type>-<timestamp-of-training-call> where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. All training input data is written into that directory.

The Vertex AI environment variables representing Cloud Storage data URIs are represented in the Cloud Storage wildcard format to support sharded data. e.g.: "gs://.../training-*.jsonl"

• AIP_DATA_FORMAT = "jsonl" for non-tabular data, "csv" for tabular data

• AIP_TRAINING_DATA_URI = "gcs_destination/dataset-<dataset-id>-<annotation-type>-<time>/training-*.${AIP_DATA_FORMAT}"

• AIP_VALIDATION_DATA_URI = "gcs_destination/dataset-<dataset-id>-<annotation-type>-<time>/validation-*.${AIP_DATA_FORMAT}"

• AIP_TEST_DATA_URI = "gcs_destination/dataset-<dataset-id>-<annotation-type>-<time>/test-*.${AIP_DATA_FORMAT}"

.google.cloud.aiplatform.v1beta1.GcsDestination gcs_destination = 8;

Returns
Type	Description
boolean	Whether the gcsDestination field is set.

hasPredefinedSplit()

public boolean hasPredefinedSplit()

Supported only for tabular Datasets.

Split based on a predefined key.

.google.cloud.aiplatform.v1beta1.PredefinedSplit predefined_split = 4;

Returns
Type	Description
boolean	Whether the predefinedSplit field is set.

hasStratifiedSplit()

public boolean hasStratifiedSplit()

Supported only for tabular Datasets.

Split based on the distribution of the specified column.

.google.cloud.aiplatform.v1beta1.StratifiedSplit stratified_split = 12;

Returns
Type	Description
boolean	Whether the stratifiedSplit field is set.

hasTimestampSplit()

public boolean hasTimestampSplit()

Supported only for tabular Datasets.

Split based on the timestamp of the input data pieces.

.google.cloud.aiplatform.v1beta1.TimestampSplit timestamp_split = 5;

Returns
Type	Description
boolean	Whether the timestampSplit field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public InputDataConfig.Builder newBuilderForType()

Returns
Type	Description
InputDataConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected InputDataConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
InputDataConfig.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public InputDataConfig.Builder toBuilder()

Returns
Type	Description
InputDataConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException