public static final class BatchPredictionJob.InstanceConfig.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<BatchPredictionJob.InstanceConfig.Builder> implements BatchPredictionJob.InstanceConfigOrBuilder
Configuration defining how to transform batch prediction input instances to the instances that the Model accepts.Protobuf type
google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig| Modifier and Type | Method and Description |
|---|---|
BatchPredictionJob.InstanceConfig.Builder |
addAllExcludedFields(Iterable<String> values)
Fields that will be excluded in the prediction instance that is
sent to the Model.
|
BatchPredictionJob.InstanceConfig.Builder |
addAllIncludedFields(Iterable<String> values)
Fields that will be included in the prediction instance that is
sent to the Model.
|
BatchPredictionJob.InstanceConfig.Builder |
addExcludedFields(String value)
Fields that will be excluded in the prediction instance that is
sent to the Model.
|
BatchPredictionJob.InstanceConfig.Builder |
addExcludedFieldsBytes(com.google.protobuf.ByteString value)
Fields that will be excluded in the prediction instance that is
sent to the Model.
|
BatchPredictionJob.InstanceConfig.Builder |
addIncludedFields(String value)
Fields that will be included in the prediction instance that is
sent to the Model.
|
BatchPredictionJob.InstanceConfig.Builder |
addIncludedFieldsBytes(com.google.protobuf.ByteString value)
Fields that will be included in the prediction instance that is
sent to the Model.
|
BatchPredictionJob.InstanceConfig.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
BatchPredictionJob.InstanceConfig |
build() |
BatchPredictionJob.InstanceConfig |
buildPartial() |
BatchPredictionJob.InstanceConfig.Builder |
clear() |
BatchPredictionJob.InstanceConfig.Builder |
clearExcludedFields()
Fields that will be excluded in the prediction instance that is
sent to the Model.
|
BatchPredictionJob.InstanceConfig.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
BatchPredictionJob.InstanceConfig.Builder |
clearIncludedFields()
Fields that will be included in the prediction instance that is
sent to the Model.
|
BatchPredictionJob.InstanceConfig.Builder |
clearInstanceType()
The format of the instance that the Model accepts.
|
BatchPredictionJob.InstanceConfig.Builder |
clearKeyField()
The name of the field that is considered as a key.
|
BatchPredictionJob.InstanceConfig.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
BatchPredictionJob.InstanceConfig.Builder |
clone() |
BatchPredictionJob.InstanceConfig |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
String |
getExcludedFields(int index)
Fields that will be excluded in the prediction instance that is
sent to the Model.
|
com.google.protobuf.ByteString |
getExcludedFieldsBytes(int index)
Fields that will be excluded in the prediction instance that is
sent to the Model.
|
int |
getExcludedFieldsCount()
Fields that will be excluded in the prediction instance that is
sent to the Model.
|
com.google.protobuf.ProtocolStringList |
getExcludedFieldsList()
Fields that will be excluded in the prediction instance that is
sent to the Model.
|
String |
getIncludedFields(int index)
Fields that will be included in the prediction instance that is
sent to the Model.
|
com.google.protobuf.ByteString |
getIncludedFieldsBytes(int index)
Fields that will be included in the prediction instance that is
sent to the Model.
|
int |
getIncludedFieldsCount()
Fields that will be included in the prediction instance that is
sent to the Model.
|
com.google.protobuf.ProtocolStringList |
getIncludedFieldsList()
Fields that will be included in the prediction instance that is
sent to the Model.
|
String |
getInstanceType()
The format of the instance that the Model accepts.
|
com.google.protobuf.ByteString |
getInstanceTypeBytes()
The format of the instance that the Model accepts.
|
String |
getKeyField()
The name of the field that is considered as a key.
|
com.google.protobuf.ByteString |
getKeyFieldBytes()
The name of the field that is considered as a key.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
BatchPredictionJob.InstanceConfig.Builder |
mergeFrom(BatchPredictionJob.InstanceConfig other) |
BatchPredictionJob.InstanceConfig.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
BatchPredictionJob.InstanceConfig.Builder |
mergeFrom(com.google.protobuf.Message other) |
BatchPredictionJob.InstanceConfig.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
BatchPredictionJob.InstanceConfig.Builder |
setExcludedFields(int index,
String value)
Fields that will be excluded in the prediction instance that is
sent to the Model.
|
BatchPredictionJob.InstanceConfig.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
BatchPredictionJob.InstanceConfig.Builder |
setIncludedFields(int index,
String value)
Fields that will be included in the prediction instance that is
sent to the Model.
|
BatchPredictionJob.InstanceConfig.Builder |
setInstanceType(String value)
The format of the instance that the Model accepts.
|
BatchPredictionJob.InstanceConfig.Builder |
setInstanceTypeBytes(com.google.protobuf.ByteString value)
The format of the instance that the Model accepts.
|
BatchPredictionJob.InstanceConfig.Builder |
setKeyField(String value)
The name of the field that is considered as a key.
|
BatchPredictionJob.InstanceConfig.Builder |
setKeyFieldBytes(com.google.protobuf.ByteString value)
The name of the field that is considered as a key.
|
BatchPredictionJob.InstanceConfig.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
BatchPredictionJob.InstanceConfig.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<BatchPredictionJob.InstanceConfig.Builder>public BatchPredictionJob.InstanceConfig.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<BatchPredictionJob.InstanceConfig.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<BatchPredictionJob.InstanceConfig.Builder>public BatchPredictionJob.InstanceConfig getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic BatchPredictionJob.InstanceConfig build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic BatchPredictionJob.InstanceConfig buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic BatchPredictionJob.InstanceConfig.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<BatchPredictionJob.InstanceConfig.Builder>public BatchPredictionJob.InstanceConfig.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<BatchPredictionJob.InstanceConfig.Builder>public BatchPredictionJob.InstanceConfig.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<BatchPredictionJob.InstanceConfig.Builder>public BatchPredictionJob.InstanceConfig.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<BatchPredictionJob.InstanceConfig.Builder>public BatchPredictionJob.InstanceConfig.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<BatchPredictionJob.InstanceConfig.Builder>public BatchPredictionJob.InstanceConfig.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<BatchPredictionJob.InstanceConfig.Builder>public BatchPredictionJob.InstanceConfig.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<BatchPredictionJob.InstanceConfig.Builder>public BatchPredictionJob.InstanceConfig.Builder mergeFrom(BatchPredictionJob.InstanceConfig other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<BatchPredictionJob.InstanceConfig.Builder>public BatchPredictionJob.InstanceConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<BatchPredictionJob.InstanceConfig.Builder>IOExceptionpublic String getInstanceType()
The format of the instance that the Model accepts. Vertex AI will
convert compatible
[batch prediction input instance
formats][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.instances_format]
to the specified format.
Supported values are:
* `object`: Each input is converted to JSON object format.
* For `bigquery`, each row is converted to an object.
* For `jsonl`, each line of the JSONL input must be an object.
* Does not apply to `csv`, `file-list`, `tf-record`, or
`tf-record-gzip`.
* `array`: Each input is converted to JSON array format.
* For `bigquery`, each row is converted to an array. The order
of columns is determined by the BigQuery column order, unless
[included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
is populated.
[included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
must be populated for specifying field orders.
* For `jsonl`, if each line of the JSONL input is an object,
[included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
must be populated for specifying field orders.
* Does not apply to `csv`, `file-list`, `tf-record`, or
`tf-record-gzip`.
If not specified, Vertex AI converts the batch prediction input as
follows:
* For `bigquery` and `csv`, the behavior is the same as `array`. The
order of columns is the same as defined in the file or table, unless
[included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
is populated.
* For `jsonl`, the prediction instance format is determined by
each line of the input.
* For `tf-record`/`tf-record-gzip`, each record will be converted to
an object in the format of `{"b64": <value>}`, where `<value>` is
the Base64-encoded string of the content of the record.
* For `file-list`, each file in the list will be converted to an
object in the format of `{"b64": <value>}`, where `<value>` is
the Base64-encoded string of the content of the file.
string instance_type = 1;getInstanceType in interface BatchPredictionJob.InstanceConfigOrBuilderpublic com.google.protobuf.ByteString getInstanceTypeBytes()
The format of the instance that the Model accepts. Vertex AI will
convert compatible
[batch prediction input instance
formats][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.instances_format]
to the specified format.
Supported values are:
* `object`: Each input is converted to JSON object format.
* For `bigquery`, each row is converted to an object.
* For `jsonl`, each line of the JSONL input must be an object.
* Does not apply to `csv`, `file-list`, `tf-record`, or
`tf-record-gzip`.
* `array`: Each input is converted to JSON array format.
* For `bigquery`, each row is converted to an array. The order
of columns is determined by the BigQuery column order, unless
[included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
is populated.
[included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
must be populated for specifying field orders.
* For `jsonl`, if each line of the JSONL input is an object,
[included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
must be populated for specifying field orders.
* Does not apply to `csv`, `file-list`, `tf-record`, or
`tf-record-gzip`.
If not specified, Vertex AI converts the batch prediction input as
follows:
* For `bigquery` and `csv`, the behavior is the same as `array`. The
order of columns is the same as defined in the file or table, unless
[included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
is populated.
* For `jsonl`, the prediction instance format is determined by
each line of the input.
* For `tf-record`/`tf-record-gzip`, each record will be converted to
an object in the format of `{"b64": <value>}`, where `<value>` is
the Base64-encoded string of the content of the record.
* For `file-list`, each file in the list will be converted to an
object in the format of `{"b64": <value>}`, where `<value>` is
the Base64-encoded string of the content of the file.
string instance_type = 1;getInstanceTypeBytes in interface BatchPredictionJob.InstanceConfigOrBuilderpublic BatchPredictionJob.InstanceConfig.Builder setInstanceType(String value)
The format of the instance that the Model accepts. Vertex AI will
convert compatible
[batch prediction input instance
formats][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.instances_format]
to the specified format.
Supported values are:
* `object`: Each input is converted to JSON object format.
* For `bigquery`, each row is converted to an object.
* For `jsonl`, each line of the JSONL input must be an object.
* Does not apply to `csv`, `file-list`, `tf-record`, or
`tf-record-gzip`.
* `array`: Each input is converted to JSON array format.
* For `bigquery`, each row is converted to an array. The order
of columns is determined by the BigQuery column order, unless
[included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
is populated.
[included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
must be populated for specifying field orders.
* For `jsonl`, if each line of the JSONL input is an object,
[included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
must be populated for specifying field orders.
* Does not apply to `csv`, `file-list`, `tf-record`, or
`tf-record-gzip`.
If not specified, Vertex AI converts the batch prediction input as
follows:
* For `bigquery` and `csv`, the behavior is the same as `array`. The
order of columns is the same as defined in the file or table, unless
[included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
is populated.
* For `jsonl`, the prediction instance format is determined by
each line of the input.
* For `tf-record`/`tf-record-gzip`, each record will be converted to
an object in the format of `{"b64": <value>}`, where `<value>` is
the Base64-encoded string of the content of the record.
* For `file-list`, each file in the list will be converted to an
object in the format of `{"b64": <value>}`, where `<value>` is
the Base64-encoded string of the content of the file.
string instance_type = 1;value - The instanceType to set.public BatchPredictionJob.InstanceConfig.Builder clearInstanceType()
The format of the instance that the Model accepts. Vertex AI will
convert compatible
[batch prediction input instance
formats][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.instances_format]
to the specified format.
Supported values are:
* `object`: Each input is converted to JSON object format.
* For `bigquery`, each row is converted to an object.
* For `jsonl`, each line of the JSONL input must be an object.
* Does not apply to `csv`, `file-list`, `tf-record`, or
`tf-record-gzip`.
* `array`: Each input is converted to JSON array format.
* For `bigquery`, each row is converted to an array. The order
of columns is determined by the BigQuery column order, unless
[included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
is populated.
[included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
must be populated for specifying field orders.
* For `jsonl`, if each line of the JSONL input is an object,
[included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
must be populated for specifying field orders.
* Does not apply to `csv`, `file-list`, `tf-record`, or
`tf-record-gzip`.
If not specified, Vertex AI converts the batch prediction input as
follows:
* For `bigquery` and `csv`, the behavior is the same as `array`. The
order of columns is the same as defined in the file or table, unless
[included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
is populated.
* For `jsonl`, the prediction instance format is determined by
each line of the input.
* For `tf-record`/`tf-record-gzip`, each record will be converted to
an object in the format of `{"b64": <value>}`, where `<value>` is
the Base64-encoded string of the content of the record.
* For `file-list`, each file in the list will be converted to an
object in the format of `{"b64": <value>}`, where `<value>` is
the Base64-encoded string of the content of the file.
string instance_type = 1;public BatchPredictionJob.InstanceConfig.Builder setInstanceTypeBytes(com.google.protobuf.ByteString value)
The format of the instance that the Model accepts. Vertex AI will
convert compatible
[batch prediction input instance
formats][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.instances_format]
to the specified format.
Supported values are:
* `object`: Each input is converted to JSON object format.
* For `bigquery`, each row is converted to an object.
* For `jsonl`, each line of the JSONL input must be an object.
* Does not apply to `csv`, `file-list`, `tf-record`, or
`tf-record-gzip`.
* `array`: Each input is converted to JSON array format.
* For `bigquery`, each row is converted to an array. The order
of columns is determined by the BigQuery column order, unless
[included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
is populated.
[included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
must be populated for specifying field orders.
* For `jsonl`, if each line of the JSONL input is an object,
[included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
must be populated for specifying field orders.
* Does not apply to `csv`, `file-list`, `tf-record`, or
`tf-record-gzip`.
If not specified, Vertex AI converts the batch prediction input as
follows:
* For `bigquery` and `csv`, the behavior is the same as `array`. The
order of columns is the same as defined in the file or table, unless
[included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields]
is populated.
* For `jsonl`, the prediction instance format is determined by
each line of the input.
* For `tf-record`/`tf-record-gzip`, each record will be converted to
an object in the format of `{"b64": <value>}`, where `<value>` is
the Base64-encoded string of the content of the record.
* For `file-list`, each file in the list will be converted to an
object in the format of `{"b64": <value>}`, where `<value>` is
the Base64-encoded string of the content of the file.
string instance_type = 1;value - The bytes for instanceType to set.public String getKeyField()
The name of the field that is considered as a key.
The values identified by the key field is not included in the transformed
instances that is sent to the Model. This is similar to
specifying this name of the field in
[excluded_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.excluded_fields].
In addition, the batch prediction output will not include the instances.
Instead the output will only include the value of the key field, in a
field named `key` in the output:
* For `jsonl` output format, the output will have a `key` field
instead of the `instance` field.
* For `csv`/`bigquery` output format, the output will have have a `key`
column instead of the instance feature columns.
The input must be JSONL with objects at each line, CSV, BigQuery
or TfRecord.
string key_field = 2;getKeyField in interface BatchPredictionJob.InstanceConfigOrBuilderpublic com.google.protobuf.ByteString getKeyFieldBytes()
The name of the field that is considered as a key.
The values identified by the key field is not included in the transformed
instances that is sent to the Model. This is similar to
specifying this name of the field in
[excluded_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.excluded_fields].
In addition, the batch prediction output will not include the instances.
Instead the output will only include the value of the key field, in a
field named `key` in the output:
* For `jsonl` output format, the output will have a `key` field
instead of the `instance` field.
* For `csv`/`bigquery` output format, the output will have have a `key`
column instead of the instance feature columns.
The input must be JSONL with objects at each line, CSV, BigQuery
or TfRecord.
string key_field = 2;getKeyFieldBytes in interface BatchPredictionJob.InstanceConfigOrBuilderpublic BatchPredictionJob.InstanceConfig.Builder setKeyField(String value)
The name of the field that is considered as a key.
The values identified by the key field is not included in the transformed
instances that is sent to the Model. This is similar to
specifying this name of the field in
[excluded_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.excluded_fields].
In addition, the batch prediction output will not include the instances.
Instead the output will only include the value of the key field, in a
field named `key` in the output:
* For `jsonl` output format, the output will have a `key` field
instead of the `instance` field.
* For `csv`/`bigquery` output format, the output will have have a `key`
column instead of the instance feature columns.
The input must be JSONL with objects at each line, CSV, BigQuery
or TfRecord.
string key_field = 2;value - The keyField to set.public BatchPredictionJob.InstanceConfig.Builder clearKeyField()
The name of the field that is considered as a key.
The values identified by the key field is not included in the transformed
instances that is sent to the Model. This is similar to
specifying this name of the field in
[excluded_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.excluded_fields].
In addition, the batch prediction output will not include the instances.
Instead the output will only include the value of the key field, in a
field named `key` in the output:
* For `jsonl` output format, the output will have a `key` field
instead of the `instance` field.
* For `csv`/`bigquery` output format, the output will have have a `key`
column instead of the instance feature columns.
The input must be JSONL with objects at each line, CSV, BigQuery
or TfRecord.
string key_field = 2;public BatchPredictionJob.InstanceConfig.Builder setKeyFieldBytes(com.google.protobuf.ByteString value)
The name of the field that is considered as a key.
The values identified by the key field is not included in the transformed
instances that is sent to the Model. This is similar to
specifying this name of the field in
[excluded_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.excluded_fields].
In addition, the batch prediction output will not include the instances.
Instead the output will only include the value of the key field, in a
field named `key` in the output:
* For `jsonl` output format, the output will have a `key` field
instead of the `instance` field.
* For `csv`/`bigquery` output format, the output will have have a `key`
column instead of the instance feature columns.
The input must be JSONL with objects at each line, CSV, BigQuery
or TfRecord.
string key_field = 2;value - The bytes for keyField to set.public com.google.protobuf.ProtocolStringList getIncludedFieldsList()
Fields that will be included in the prediction instance that is sent to the Model. If [instance_type][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.instance_type] is `array`, the order of field names in included_fields also determines the order of the values in the array. When included_fields is populated, [excluded_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.excluded_fields] must be empty. The input must be JSONL with objects at each line, BigQuery or TfRecord.
repeated string included_fields = 3;getIncludedFieldsList in interface BatchPredictionJob.InstanceConfigOrBuilderpublic int getIncludedFieldsCount()
Fields that will be included in the prediction instance that is sent to the Model. If [instance_type][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.instance_type] is `array`, the order of field names in included_fields also determines the order of the values in the array. When included_fields is populated, [excluded_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.excluded_fields] must be empty. The input must be JSONL with objects at each line, BigQuery or TfRecord.
repeated string included_fields = 3;getIncludedFieldsCount in interface BatchPredictionJob.InstanceConfigOrBuilderpublic String getIncludedFields(int index)
Fields that will be included in the prediction instance that is sent to the Model. If [instance_type][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.instance_type] is `array`, the order of field names in included_fields also determines the order of the values in the array. When included_fields is populated, [excluded_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.excluded_fields] must be empty. The input must be JSONL with objects at each line, BigQuery or TfRecord.
repeated string included_fields = 3;getIncludedFields in interface BatchPredictionJob.InstanceConfigOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getIncludedFieldsBytes(int index)
Fields that will be included in the prediction instance that is sent to the Model. If [instance_type][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.instance_type] is `array`, the order of field names in included_fields also determines the order of the values in the array. When included_fields is populated, [excluded_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.excluded_fields] must be empty. The input must be JSONL with objects at each line, BigQuery or TfRecord.
repeated string included_fields = 3;getIncludedFieldsBytes in interface BatchPredictionJob.InstanceConfigOrBuilderindex - The index of the value to return.public BatchPredictionJob.InstanceConfig.Builder setIncludedFields(int index, String value)
Fields that will be included in the prediction instance that is sent to the Model. If [instance_type][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.instance_type] is `array`, the order of field names in included_fields also determines the order of the values in the array. When included_fields is populated, [excluded_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.excluded_fields] must be empty. The input must be JSONL with objects at each line, BigQuery or TfRecord.
repeated string included_fields = 3;index - The index to set the value at.value - The includedFields to set.public BatchPredictionJob.InstanceConfig.Builder addIncludedFields(String value)
Fields that will be included in the prediction instance that is sent to the Model. If [instance_type][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.instance_type] is `array`, the order of field names in included_fields also determines the order of the values in the array. When included_fields is populated, [excluded_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.excluded_fields] must be empty. The input must be JSONL with objects at each line, BigQuery or TfRecord.
repeated string included_fields = 3;value - The includedFields to add.public BatchPredictionJob.InstanceConfig.Builder addAllIncludedFields(Iterable<String> values)
Fields that will be included in the prediction instance that is sent to the Model. If [instance_type][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.instance_type] is `array`, the order of field names in included_fields also determines the order of the values in the array. When included_fields is populated, [excluded_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.excluded_fields] must be empty. The input must be JSONL with objects at each line, BigQuery or TfRecord.
repeated string included_fields = 3;values - The includedFields to add.public BatchPredictionJob.InstanceConfig.Builder clearIncludedFields()
Fields that will be included in the prediction instance that is sent to the Model. If [instance_type][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.instance_type] is `array`, the order of field names in included_fields also determines the order of the values in the array. When included_fields is populated, [excluded_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.excluded_fields] must be empty. The input must be JSONL with objects at each line, BigQuery or TfRecord.
repeated string included_fields = 3;public BatchPredictionJob.InstanceConfig.Builder addIncludedFieldsBytes(com.google.protobuf.ByteString value)
Fields that will be included in the prediction instance that is sent to the Model. If [instance_type][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.instance_type] is `array`, the order of field names in included_fields also determines the order of the values in the array. When included_fields is populated, [excluded_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.excluded_fields] must be empty. The input must be JSONL with objects at each line, BigQuery or TfRecord.
repeated string included_fields = 3;value - The bytes of the includedFields to add.public com.google.protobuf.ProtocolStringList getExcludedFieldsList()
Fields that will be excluded in the prediction instance that is sent to the Model. Excluded will be attached to the batch prediction output if [key_field][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.key_field] is not specified. When excluded_fields is populated, [included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields] must be empty. The input must be JSONL with objects at each line, BigQuery or TfRecord.
repeated string excluded_fields = 4;getExcludedFieldsList in interface BatchPredictionJob.InstanceConfigOrBuilderpublic int getExcludedFieldsCount()
Fields that will be excluded in the prediction instance that is sent to the Model. Excluded will be attached to the batch prediction output if [key_field][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.key_field] is not specified. When excluded_fields is populated, [included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields] must be empty. The input must be JSONL with objects at each line, BigQuery or TfRecord.
repeated string excluded_fields = 4;getExcludedFieldsCount in interface BatchPredictionJob.InstanceConfigOrBuilderpublic String getExcludedFields(int index)
Fields that will be excluded in the prediction instance that is sent to the Model. Excluded will be attached to the batch prediction output if [key_field][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.key_field] is not specified. When excluded_fields is populated, [included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields] must be empty. The input must be JSONL with objects at each line, BigQuery or TfRecord.
repeated string excluded_fields = 4;getExcludedFields in interface BatchPredictionJob.InstanceConfigOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getExcludedFieldsBytes(int index)
Fields that will be excluded in the prediction instance that is sent to the Model. Excluded will be attached to the batch prediction output if [key_field][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.key_field] is not specified. When excluded_fields is populated, [included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields] must be empty. The input must be JSONL with objects at each line, BigQuery or TfRecord.
repeated string excluded_fields = 4;getExcludedFieldsBytes in interface BatchPredictionJob.InstanceConfigOrBuilderindex - The index of the value to return.public BatchPredictionJob.InstanceConfig.Builder setExcludedFields(int index, String value)
Fields that will be excluded in the prediction instance that is sent to the Model. Excluded will be attached to the batch prediction output if [key_field][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.key_field] is not specified. When excluded_fields is populated, [included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields] must be empty. The input must be JSONL with objects at each line, BigQuery or TfRecord.
repeated string excluded_fields = 4;index - The index to set the value at.value - The excludedFields to set.public BatchPredictionJob.InstanceConfig.Builder addExcludedFields(String value)
Fields that will be excluded in the prediction instance that is sent to the Model. Excluded will be attached to the batch prediction output if [key_field][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.key_field] is not specified. When excluded_fields is populated, [included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields] must be empty. The input must be JSONL with objects at each line, BigQuery or TfRecord.
repeated string excluded_fields = 4;value - The excludedFields to add.public BatchPredictionJob.InstanceConfig.Builder addAllExcludedFields(Iterable<String> values)
Fields that will be excluded in the prediction instance that is sent to the Model. Excluded will be attached to the batch prediction output if [key_field][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.key_field] is not specified. When excluded_fields is populated, [included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields] must be empty. The input must be JSONL with objects at each line, BigQuery or TfRecord.
repeated string excluded_fields = 4;values - The excludedFields to add.public BatchPredictionJob.InstanceConfig.Builder clearExcludedFields()
Fields that will be excluded in the prediction instance that is sent to the Model. Excluded will be attached to the batch prediction output if [key_field][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.key_field] is not specified. When excluded_fields is populated, [included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields] must be empty. The input must be JSONL with objects at each line, BigQuery or TfRecord.
repeated string excluded_fields = 4;public BatchPredictionJob.InstanceConfig.Builder addExcludedFieldsBytes(com.google.protobuf.ByteString value)
Fields that will be excluded in the prediction instance that is sent to the Model. Excluded will be attached to the batch prediction output if [key_field][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.key_field] is not specified. When excluded_fields is populated, [included_fields][google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.included_fields] must be empty. The input must be JSONL with objects at each line, BigQuery or TfRecord.
repeated string excluded_fields = 4;value - The bytes of the excludedFields to add.public final BatchPredictionJob.InstanceConfig.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<BatchPredictionJob.InstanceConfig.Builder>public final BatchPredictionJob.InstanceConfig.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<BatchPredictionJob.InstanceConfig.Builder>Copyright © 2025 Google LLC. All rights reserved.