public static final class BatchPredictionJob.InstanceConfig extends com.google.protobuf.GeneratedMessageV3 implements BatchPredictionJob.InstanceConfigOrBuilder
Configuration defining how to transform batch prediction input instances to the instances that the Model accepts.Protobuf type
google.cloud.aiplatform.v1beta1.BatchPredictionJob.InstanceConfig| Modifier and Type | Class and Description |
|---|---|
static class |
BatchPredictionJob.InstanceConfig.Builder
Configuration defining how to transform batch prediction input instances to
the instances that the Model accepts.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
EXCLUDED_FIELDS_FIELD_NUMBER |
static int |
INCLUDED_FIELDS_FIELD_NUMBER |
static int |
INSTANCE_TYPE_FIELD_NUMBER |
static int |
KEY_FIELD_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
static BatchPredictionJob.InstanceConfig |
getDefaultInstance() |
BatchPredictionJob.InstanceConfig |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
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.
|
com.google.protobuf.Parser<BatchPredictionJob.InstanceConfig> |
getParserForType() |
int |
getSerializedSize() |
int |
hashCode() |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static BatchPredictionJob.InstanceConfig.Builder |
newBuilder() |
static BatchPredictionJob.InstanceConfig.Builder |
newBuilder(BatchPredictionJob.InstanceConfig prototype) |
BatchPredictionJob.InstanceConfig.Builder |
newBuilderForType() |
protected BatchPredictionJob.InstanceConfig.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static BatchPredictionJob.InstanceConfig |
parseDelimitedFrom(InputStream input) |
static BatchPredictionJob.InstanceConfig |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static BatchPredictionJob.InstanceConfig |
parseFrom(byte[] data) |
static BatchPredictionJob.InstanceConfig |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static BatchPredictionJob.InstanceConfig |
parseFrom(ByteBuffer data) |
static BatchPredictionJob.InstanceConfig |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static BatchPredictionJob.InstanceConfig |
parseFrom(com.google.protobuf.ByteString data) |
static BatchPredictionJob.InstanceConfig |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static BatchPredictionJob.InstanceConfig |
parseFrom(com.google.protobuf.CodedInputStream input) |
static BatchPredictionJob.InstanceConfig |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static BatchPredictionJob.InstanceConfig |
parseFrom(InputStream input) |
static BatchPredictionJob.InstanceConfig |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<BatchPredictionJob.InstanceConfig> |
parser() |
BatchPredictionJob.InstanceConfig.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int INSTANCE_TYPE_FIELD_NUMBER
public static final int KEY_FIELD_FIELD_NUMBER
public static final int INCLUDED_FIELDS_FIELD_NUMBER
public static final int EXCLUDED_FIELDS_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String getInstanceType()
The format of the instance that the Model accepts. Vertex AI will
convert compatible
[batch prediction input instance
formats][google.cloud.aiplatform.v1beta1.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.v1beta1.BatchPredictionJob.InstanceConfig.included_fields]
is populated.
[included_fields][google.cloud.aiplatform.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.BatchPredictionJob.InstanceConfig.included_fields]
is populated.
[included_fields][google.cloud.aiplatform.v1beta1.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.v1beta1.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.v1beta1.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 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.v1beta1.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.v1beta1.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 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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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 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.v1beta1.BatchPredictionJob.InstanceConfig.key_field] is not specified. When excluded_fields is populated, [included_fields][google.cloud.aiplatform.v1beta1.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.v1beta1.BatchPredictionJob.InstanceConfig.key_field] is not specified. When excluded_fields is populated, [included_fields][google.cloud.aiplatform.v1beta1.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.v1beta1.BatchPredictionJob.InstanceConfig.key_field] is not specified. When excluded_fields is populated, [included_fields][google.cloud.aiplatform.v1beta1.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.v1beta1.BatchPredictionJob.InstanceConfig.key_field] is not specified. When excluded_fields is populated, [included_fields][google.cloud.aiplatform.v1beta1.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 final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static BatchPredictionJob.InstanceConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static BatchPredictionJob.InstanceConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static BatchPredictionJob.InstanceConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static BatchPredictionJob.InstanceConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static BatchPredictionJob.InstanceConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static BatchPredictionJob.InstanceConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static BatchPredictionJob.InstanceConfig parseFrom(InputStream input) throws IOException
IOExceptionpublic static BatchPredictionJob.InstanceConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static BatchPredictionJob.InstanceConfig parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static BatchPredictionJob.InstanceConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static BatchPredictionJob.InstanceConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static BatchPredictionJob.InstanceConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic BatchPredictionJob.InstanceConfig.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static BatchPredictionJob.InstanceConfig.Builder newBuilder()
public static BatchPredictionJob.InstanceConfig.Builder newBuilder(BatchPredictionJob.InstanceConfig prototype)
public BatchPredictionJob.InstanceConfig.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected BatchPredictionJob.InstanceConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static BatchPredictionJob.InstanceConfig getDefaultInstance()
public static com.google.protobuf.Parser<BatchPredictionJob.InstanceConfig> parser()
public com.google.protobuf.Parser<BatchPredictionJob.InstanceConfig> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public BatchPredictionJob.InstanceConfig getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2025 Google LLC. All rights reserved.