Class InputDataConfig.Builder (3.54.0)

public static final class InputDataConfig.Builder extends GeneratedMessageV3.Builder<InputDataConfig.Builder> implements InputDataConfigOrBuilder

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

Protobuf type google.cloud.aiplatform.v1.InputDataConfig

Inheritance

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

Implements

InputDataConfigOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

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

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public InputDataConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`InputDataConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public InputDataConfig build()

Returns
Type	Description
`InputDataConfig`

buildPartial()

public InputDataConfig buildPartial()

Returns
Type	Description
`InputDataConfig`

clear()

public InputDataConfig.Builder clear()

Returns
Type	Description
`InputDataConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAnnotationSchemaUri()

public InputDataConfig.Builder clearAnnotationSchemaUri()

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
`InputDataConfig.Builder`	This builder for chaining.

clearAnnotationsFilter()

public InputDataConfig.Builder clearAnnotationsFilter()

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
`InputDataConfig.Builder`	This builder for chaining.

clearBigqueryDestination()

public InputDataConfig.Builder clearBigqueryDestination()

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.v1.BigQueryDestination bigquery_destination = 10;

Returns
Type	Description
`InputDataConfig.Builder`

clearDatasetId()

public InputDataConfig.Builder clearDatasetId()

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.v1.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
`InputDataConfig.Builder`	This builder for chaining.

clearDestination()

public InputDataConfig.Builder clearDestination()

Returns
Type	Description
`InputDataConfig.Builder`

clearField(Descriptors.FieldDescriptor field)

public InputDataConfig.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`InputDataConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFilterSplit()

public InputDataConfig.Builder clearFilterSplit()

Split based on the provided filters for each set.

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

Returns
Type	Description
`InputDataConfig.Builder`

clearFractionSplit()

public InputDataConfig.Builder clearFractionSplit()

Split based on fractions defining the size of each set.

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

Returns
Type	Description
`InputDataConfig.Builder`

clearGcsDestination()

public InputDataConfig.Builder clearGcsDestination()

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.v1.GcsDestination gcs_destination = 8;

Returns
Type	Description
`InputDataConfig.Builder`

clearOneof(Descriptors.OneofDescriptor oneof)

public InputDataConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`InputDataConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearPersistMlUseAssignment()

public InputDataConfig.Builder clearPersistMlUseAssignment()

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

bool persist_ml_use_assignment = 11;

Returns
Type	Description
`InputDataConfig.Builder`	This builder for chaining.

clearPredefinedSplit()

public InputDataConfig.Builder clearPredefinedSplit()

Supported only for tabular Datasets.

Split based on a predefined key.

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

Returns
Type	Description
`InputDataConfig.Builder`

clearSavedQueryId()

public InputDataConfig.Builder clearSavedQueryId()

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
`InputDataConfig.Builder`	This builder for chaining.

clearSplit()

public InputDataConfig.Builder clearSplit()

Returns
Type	Description
`InputDataConfig.Builder`

clearStratifiedSplit()

public InputDataConfig.Builder clearStratifiedSplit()

Supported only for tabular Datasets.

Split based on the distribution of the specified column.

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

Returns
Type	Description
`InputDataConfig.Builder`

clearTimestampSplit()

public InputDataConfig.Builder clearTimestampSplit()

Supported only for tabular Datasets.

Split based on the timestamp of the input data pieces.

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

Returns
Type	Description
`InputDataConfig.Builder`

clone()

public InputDataConfig.Builder clone()

Returns
Type	Description
`InputDataConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAnnotationSchemaUri()

public String getAnnotationSchemaUri()

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

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.

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.

string annotations_filter = 6;

Returns
Type	Description
`String`	The annotationsFilter.

getAnnotationsFilterBytes()

public ByteString getAnnotationsFilterBytes()

Applicable only to Datasets that have DataItems and Annotations.

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.

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.v1.BigQueryDestination bigquery_destination = 10;

Returns
Type	Description
`BigQueryDestination`	The bigqueryDestination.

getBigqueryDestinationBuilder()

public BigQueryDestination.Builder getBigqueryDestinationBuilder()

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

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.v1.BigQueryDestination bigquery_destination = 10;

Returns
Type	Description
`BigQueryDestination.Builder`

getBigqueryDestinationOrBuilder()

public BigQueryDestinationOrBuilder getBigqueryDestinationOrBuilder()

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

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.v1.BigQueryDestination bigquery_destination = 10;

Returns
Type	Description
`BigQueryDestinationOrBuilder`

getDatasetId()

public String getDatasetId()

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

Returns
Type	Description
`String`	The datasetId.

getDatasetIdBytes()

public ByteString getDatasetIdBytes()

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`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.v1.FilterSplit filter_split = 3;

Returns
Type	Description
`FilterSplit`	The filterSplit.

getFilterSplitBuilder()

public FilterSplit.Builder getFilterSplitBuilder()

Split based on the provided filters for each set.

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

Returns
Type	Description
`FilterSplit.Builder`

getFilterSplitOrBuilder()

public FilterSplitOrBuilder getFilterSplitOrBuilder()

Split based on the provided filters for each set.

.google.cloud.aiplatform.v1.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.v1.FractionSplit fraction_split = 2;

Returns
Type	Description
`FractionSplit`	The fractionSplit.

getFractionSplitBuilder()

public FractionSplit.Builder getFractionSplitBuilder()

Split based on fractions defining the size of each set.

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

Returns
Type	Description
`FractionSplit.Builder`

getFractionSplitOrBuilder()

public FractionSplitOrBuilder getFractionSplitOrBuilder()

Split based on fractions defining the size of each set.

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

Returns
Type	Description
`FractionSplitOrBuilder`

getGcsDestination()

public GcsDestination getGcsDestination()

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.v1.GcsDestination gcs_destination = 8;

Returns
Type	Description
`GcsDestination`	The gcsDestination.

getGcsDestinationBuilder()

public GcsDestination.Builder getGcsDestinationBuilder()

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.v1.GcsDestination gcs_destination = 8;

Returns
Type	Description
`GcsDestination.Builder`

getGcsDestinationOrBuilder()

public GcsDestinationOrBuilder getGcsDestinationOrBuilder()

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.v1.GcsDestination gcs_destination = 8;

Returns
Type	Description
`GcsDestinationOrBuilder`

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.v1.PredefinedSplit predefined_split = 4;

Returns
Type	Description
`PredefinedSplit`	The predefinedSplit.

getPredefinedSplitBuilder()

public PredefinedSplit.Builder getPredefinedSplitBuilder()

Supported only for tabular Datasets.

Split based on a predefined key.

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

Returns
Type	Description
`PredefinedSplit.Builder`

getPredefinedSplitOrBuilder()

public PredefinedSplitOrBuilder getPredefinedSplitOrBuilder()

Supported only for tabular Datasets.

Split based on a predefined key.

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

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.v1.StratifiedSplit stratified_split = 12;

Returns
Type	Description
`StratifiedSplit`	The stratifiedSplit.

getStratifiedSplitBuilder()

public StratifiedSplit.Builder getStratifiedSplitBuilder()

Supported only for tabular Datasets.

Split based on the distribution of the specified column.

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

Returns
Type	Description
`StratifiedSplit.Builder`

getStratifiedSplitOrBuilder()

public StratifiedSplitOrBuilder getStratifiedSplitOrBuilder()

Supported only for tabular Datasets.

Split based on the distribution of the specified column.

.google.cloud.aiplatform.v1.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.v1.TimestampSplit timestamp_split = 5;

Returns
Type	Description
`TimestampSplit`	The timestampSplit.

getTimestampSplitBuilder()

public TimestampSplit.Builder getTimestampSplitBuilder()

Supported only for tabular Datasets.

Split based on the timestamp of the input data pieces.

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

Returns
Type	Description
`TimestampSplit.Builder`

getTimestampSplitOrBuilder()

public TimestampSplitOrBuilder getTimestampSplitOrBuilder()

Supported only for tabular Datasets.

Split based on the timestamp of the input data pieces.

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

Returns
Type	Description
`TimestampSplitOrBuilder`

hasBigqueryDestination()

public boolean hasBigqueryDestination()

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

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.v1.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.v1.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.v1.FractionSplit fraction_split = 2;

Returns
Type	Description
`boolean`	Whether the fractionSplit field is set.

hasGcsDestination()

public boolean hasGcsDestination()

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.v1.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.v1.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.v1.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.v1.TimestampSplit timestamp_split = 5;

Returns
Type	Description
`boolean`	Whether the timestampSplit field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeBigqueryDestination(BigQueryDestination value)

public InputDataConfig.Builder mergeBigqueryDestination(BigQueryDestination value)

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

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.v1.BigQueryDestination bigquery_destination = 10;

Parameter
Name	Description
`value`	`BigQueryDestination`

Returns
Type	Description
`InputDataConfig.Builder`

mergeFilterSplit(FilterSplit value)

public InputDataConfig.Builder mergeFilterSplit(FilterSplit value)

Split based on the provided filters for each set.

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

Parameter
Name	Description
`value`	`FilterSplit`

Returns
Type	Description
`InputDataConfig.Builder`

mergeFractionSplit(FractionSplit value)

public InputDataConfig.Builder mergeFractionSplit(FractionSplit value)

Split based on fractions defining the size of each set.

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

Parameter
Name	Description
`value`	`FractionSplit`

Returns
Type	Description
`InputDataConfig.Builder`

mergeFrom(InputDataConfig other)

public InputDataConfig.Builder mergeFrom(InputDataConfig other)

Parameter
Name	Description
`other`	`InputDataConfig`

Returns
Type	Description
`InputDataConfig.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public InputDataConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`InputDataConfig.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public InputDataConfig.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`InputDataConfig.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeGcsDestination(GcsDestination value)

public InputDataConfig.Builder mergeGcsDestination(GcsDestination value)

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.v1.GcsDestination gcs_destination = 8;

Parameter
Name	Description
`value`	`GcsDestination`

Returns
Type	Description
`InputDataConfig.Builder`

mergePredefinedSplit(PredefinedSplit value)

public InputDataConfig.Builder mergePredefinedSplit(PredefinedSplit value)

Supported only for tabular Datasets.

Split based on a predefined key.

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

Parameter
Name	Description
`value`	`PredefinedSplit`

Returns
Type	Description
`InputDataConfig.Builder`

mergeStratifiedSplit(StratifiedSplit value)

public InputDataConfig.Builder mergeStratifiedSplit(StratifiedSplit value)

Supported only for tabular Datasets.

Split based on the distribution of the specified column.

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

Parameter
Name	Description
`value`	`StratifiedSplit`

Returns
Type	Description
`InputDataConfig.Builder`

mergeTimestampSplit(TimestampSplit value)

public InputDataConfig.Builder mergeTimestampSplit(TimestampSplit value)

Supported only for tabular Datasets.

Split based on the timestamp of the input data pieces.

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

Parameter
Name	Description
`value`	`TimestampSplit`

Returns
Type	Description
`InputDataConfig.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final InputDataConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`InputDataConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setAnnotationSchemaUri(String value)

public InputDataConfig.Builder setAnnotationSchemaUri(String value)

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

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;

Parameter
Name	Description
`value`	`String` The annotationSchemaUri to set.

Returns
Type	Description
`InputDataConfig.Builder`	This builder for chaining.

setAnnotationSchemaUriBytes(ByteString value)

public InputDataConfig.Builder setAnnotationSchemaUriBytes(ByteString value)

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

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;

Parameter
Name	Description
`value`	`ByteString` The bytes for annotationSchemaUri to set.

Returns
Type	Description
`InputDataConfig.Builder`	This builder for chaining.

setAnnotationsFilter(String value)

public InputDataConfig.Builder setAnnotationsFilter(String value)

Applicable only to Datasets that have DataItems and Annotations.

string annotations_filter = 6;

Parameter
Name	Description
`value`	`String` The annotationsFilter to set.

Returns
Type	Description
`InputDataConfig.Builder`	This builder for chaining.

setAnnotationsFilterBytes(ByteString value)

public InputDataConfig.Builder setAnnotationsFilterBytes(ByteString value)

Applicable only to Datasets that have DataItems and Annotations.

string annotations_filter = 6;

Parameter
Name	Description
`value`	`ByteString` The bytes for annotationsFilter to set.

Returns
Type	Description
`InputDataConfig.Builder`	This builder for chaining.

setBigqueryDestination(BigQueryDestination value)

public InputDataConfig.Builder setBigqueryDestination(BigQueryDestination value)

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

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.v1.BigQueryDestination bigquery_destination = 10;

Parameter
Name	Description
`value`	`BigQueryDestination`

Returns
Type	Description
`InputDataConfig.Builder`

setBigqueryDestination(BigQueryDestination.Builder builderForValue)

public InputDataConfig.Builder setBigqueryDestination(BigQueryDestination.Builder builderForValue)

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

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.v1.BigQueryDestination bigquery_destination = 10;

Parameter
Name	Description
`builderForValue`	`BigQueryDestination.Builder`

Returns
Type	Description
`InputDataConfig.Builder`

setDatasetId(String value)

public InputDataConfig.Builder setDatasetId(String value)

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

Parameter
Name	Description
`value`	`String` The datasetId to set.

Returns
Type	Description
`InputDataConfig.Builder`	This builder for chaining.

setDatasetIdBytes(ByteString value)

public InputDataConfig.Builder setDatasetIdBytes(ByteString value)

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

Parameter
Name	Description
`value`	`ByteString` The bytes for datasetId to set.

Returns
Type	Description
`InputDataConfig.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public InputDataConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`InputDataConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFilterSplit(FilterSplit value)

public InputDataConfig.Builder setFilterSplit(FilterSplit value)

Split based on the provided filters for each set.

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

Parameter
Name	Description
`value`	`FilterSplit`

Returns
Type	Description
`InputDataConfig.Builder`

setFilterSplit(FilterSplit.Builder builderForValue)

public InputDataConfig.Builder setFilterSplit(FilterSplit.Builder builderForValue)

Split based on the provided filters for each set.

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

Parameter
Name	Description
`builderForValue`	`FilterSplit.Builder`

Returns
Type	Description
`InputDataConfig.Builder`

setFractionSplit(FractionSplit value)

public InputDataConfig.Builder setFractionSplit(FractionSplit value)

Split based on fractions defining the size of each set.

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

Parameter
Name	Description
`value`	`FractionSplit`

Returns
Type	Description
`InputDataConfig.Builder`

setFractionSplit(FractionSplit.Builder builderForValue)

public InputDataConfig.Builder setFractionSplit(FractionSplit.Builder builderForValue)

Split based on fractions defining the size of each set.

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

Parameter
Name	Description
`builderForValue`	`FractionSplit.Builder`

Returns
Type	Description
`InputDataConfig.Builder`

setGcsDestination(GcsDestination value)

public InputDataConfig.Builder setGcsDestination(GcsDestination value)

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.v1.GcsDestination gcs_destination = 8;

Parameter
Name	Description
`value`	`GcsDestination`

Returns
Type	Description
`InputDataConfig.Builder`

setGcsDestination(GcsDestination.Builder builderForValue)

public InputDataConfig.Builder setGcsDestination(GcsDestination.Builder builderForValue)

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.v1.GcsDestination gcs_destination = 8;

Parameter
Name	Description
`builderForValue`	`GcsDestination.Builder`

Returns
Type	Description
`InputDataConfig.Builder`

setPersistMlUseAssignment(boolean value)

public InputDataConfig.Builder setPersistMlUseAssignment(boolean value)

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

bool persist_ml_use_assignment = 11;

Parameter
Name	Description
`value`	`boolean` The persistMlUseAssignment to set.

Returns
Type	Description
`InputDataConfig.Builder`	This builder for chaining.

setPredefinedSplit(PredefinedSplit value)

public InputDataConfig.Builder setPredefinedSplit(PredefinedSplit value)

Supported only for tabular Datasets.

Split based on a predefined key.

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

Parameter
Name	Description
`value`	`PredefinedSplit`

Returns
Type	Description
`InputDataConfig.Builder`

setPredefinedSplit(PredefinedSplit.Builder builderForValue)

public InputDataConfig.Builder setPredefinedSplit(PredefinedSplit.Builder builderForValue)

Supported only for tabular Datasets.

Split based on a predefined key.

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

Parameter
Name	Description
`builderForValue`	`PredefinedSplit.Builder`

Returns
Type	Description
`InputDataConfig.Builder`

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

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`InputDataConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSavedQueryId(String value)

public InputDataConfig.Builder setSavedQueryId(String value)

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 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;

Parameter
Name	Description
`value`	`String` The savedQueryId to set.

Returns
Type	Description
`InputDataConfig.Builder`	This builder for chaining.

setSavedQueryIdBytes(ByteString value)

public InputDataConfig.Builder setSavedQueryIdBytes(ByteString value)

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 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;

Parameter
Name	Description
`value`	`ByteString` The bytes for savedQueryId to set.

Returns
Type	Description
`InputDataConfig.Builder`	This builder for chaining.

setStratifiedSplit(StratifiedSplit value)

public InputDataConfig.Builder setStratifiedSplit(StratifiedSplit value)

Supported only for tabular Datasets.

Split based on the distribution of the specified column.

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

Parameter
Name	Description
`value`	`StratifiedSplit`

Returns
Type	Description
`InputDataConfig.Builder`

setStratifiedSplit(StratifiedSplit.Builder builderForValue)

public InputDataConfig.Builder setStratifiedSplit(StratifiedSplit.Builder builderForValue)

Supported only for tabular Datasets.

Split based on the distribution of the specified column.

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

Parameter
Name	Description
`builderForValue`	`StratifiedSplit.Builder`

Returns
Type	Description
`InputDataConfig.Builder`

setTimestampSplit(TimestampSplit value)

public InputDataConfig.Builder setTimestampSplit(TimestampSplit value)

Supported only for tabular Datasets.

Split based on the timestamp of the input data pieces.

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

Parameter
Name	Description
`value`	`TimestampSplit`

Returns
Type	Description
`InputDataConfig.Builder`

setTimestampSplit(TimestampSplit.Builder builderForValue)

public InputDataConfig.Builder setTimestampSplit(TimestampSplit.Builder builderForValue)

Supported only for tabular Datasets.

Split based on the timestamp of the input data pieces.

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

Parameter
Name	Description
`builderForValue`	`TimestampSplit.Builder`

Returns
Type	Description
`InputDataConfig.Builder`

setUnknownFields(UnknownFieldSet unknownFields)

public final InputDataConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`InputDataConfig.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)