Class BatchPredictionJob.InstanceConfig (3.45.0)

public static final class BatchPredictionJob.InstanceConfig extends 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.v1.BatchPredictionJob.InstanceConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > BatchPredictionJob.InstanceConfig

Static Fields

EXCLUDED_FIELDS_FIELD_NUMBER

public static final int EXCLUDED_FIELDS_FIELD_NUMBER
Field Value
Type Description
int

INCLUDED_FIELDS_FIELD_NUMBER

public static final int INCLUDED_FIELDS_FIELD_NUMBER
Field Value
Type Description
int

INSTANCE_TYPE_FIELD_NUMBER

public static final int INSTANCE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

KEY_FIELD_FIELD_NUMBER

public static final int KEY_FIELD_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BatchPredictionJob.InstanceConfig getDefaultInstance()
Returns
Type Description
BatchPredictionJob.InstanceConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static BatchPredictionJob.InstanceConfig.Builder newBuilder()
Returns
Type Description
BatchPredictionJob.InstanceConfig.Builder

newBuilder(BatchPredictionJob.InstanceConfig prototype)

public static BatchPredictionJob.InstanceConfig.Builder newBuilder(BatchPredictionJob.InstanceConfig prototype)
Parameter
Name Description
prototype BatchPredictionJob.InstanceConfig
Returns
Type Description
BatchPredictionJob.InstanceConfig.Builder

parseDelimitedFrom(InputStream input)

public static BatchPredictionJob.InstanceConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BatchPredictionJob.InstanceConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchPredictionJob.InstanceConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchPredictionJob.InstanceConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static BatchPredictionJob.InstanceConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
BatchPredictionJob.InstanceConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BatchPredictionJob.InstanceConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchPredictionJob.InstanceConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BatchPredictionJob.InstanceConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
BatchPredictionJob.InstanceConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BatchPredictionJob.InstanceConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchPredictionJob.InstanceConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BatchPredictionJob.InstanceConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BatchPredictionJob.InstanceConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchPredictionJob.InstanceConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchPredictionJob.InstanceConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static BatchPredictionJob.InstanceConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BatchPredictionJob.InstanceConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchPredictionJob.InstanceConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchPredictionJob.InstanceConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static BatchPredictionJob.InstanceConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BatchPredictionJob.InstanceConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BatchPredictionJob.InstanceConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchPredictionJob.InstanceConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<BatchPredictionJob.InstanceConfig> parser()
Returns
Type Description
Parser<InstanceConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public BatchPredictionJob.InstanceConfig getDefaultInstanceForType()
Returns
Type Description
BatchPredictionJob.InstanceConfig

getExcludedFields(int index)

public 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 is not specified.

When excluded_fields is populated, included_fields must be empty.

The input must be JSONL with objects at each line, BigQuery or TfRecord.

repeated string excluded_fields = 4;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The excludedFields at the given index.

getExcludedFieldsBytes(int index)

public 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 is not specified.

When excluded_fields is populated, included_fields must be empty.

The input must be JSONL with objects at each line, BigQuery or TfRecord.

repeated string excluded_fields = 4;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the excludedFields at the given index.

getExcludedFieldsCount()

public 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 is not specified.

When excluded_fields is populated, included_fields must be empty.

The input must be JSONL with objects at each line, BigQuery or TfRecord.

repeated string excluded_fields = 4;

Returns
Type Description
int

The count of excludedFields.

getExcludedFieldsList()

public 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 is not specified.

When excluded_fields is populated, included_fields must be empty.

The input must be JSONL with objects at each line, BigQuery or TfRecord.

repeated string excluded_fields = 4;

Returns
Type Description
ProtocolStringList

A list containing the excludedFields.

getIncludedFields(int index)

public String getIncludedFields(int index)

Fields that will be included in the prediction instance that is sent to the Model.

If 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 must be empty.

The input must be JSONL with objects at each line, BigQuery or TfRecord.

repeated string included_fields = 3;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The includedFields at the given index.

getIncludedFieldsBytes(int index)

public ByteString getIncludedFieldsBytes(int index)

Fields that will be included in the prediction instance that is sent to the Model.

If 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 must be empty.

The input must be JSONL with objects at each line, BigQuery or TfRecord.

repeated string included_fields = 3;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the includedFields at the given index.

getIncludedFieldsCount()

public int getIncludedFieldsCount()

Fields that will be included in the prediction instance that is sent to the Model.

If 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 must be empty.

The input must be JSONL with objects at each line, BigQuery or TfRecord.

repeated string included_fields = 3;

Returns
Type Description
int

The count of includedFields.

getIncludedFieldsList()

public ProtocolStringList getIncludedFieldsList()

Fields that will be included in the prediction instance that is sent to the Model.

If 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 must be empty.

The input must be JSONL with objects at each line, BigQuery or TfRecord.

repeated string included_fields = 3;

Returns
Type Description
ProtocolStringList

A list containing the includedFields.

getInstanceType()

public String getInstanceType()

The format of the instance that the Model accepts. Vertex AI will convert compatible batch prediction input instance formats 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 is populated. included_fields must be populated for specifying field orders.
    • For jsonl, if each line of the JSONL input is an object, 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 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;

Returns
Type Description
String

The instanceType.

getInstanceTypeBytes()

public ByteString getInstanceTypeBytes()

The format of the instance that the Model accepts. Vertex AI will convert compatible batch prediction input instance formats 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 is populated. included_fields must be populated for specifying field orders.
    • For jsonl, if each line of the JSONL input is an object, 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 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;

Returns
Type Description
ByteString

The bytes for instanceType.

getKeyField()

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

Returns
Type Description
String

The keyField.

getKeyFieldBytes()

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

Returns
Type Description
ByteString

The bytes for keyField.

getParserForType()

public Parser<BatchPredictionJob.InstanceConfig> getParserForType()
Returns
Type Description
Parser<InstanceConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public BatchPredictionJob.InstanceConfig.Builder newBuilderForType()
Returns
Type Description
BatchPredictionJob.InstanceConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BatchPredictionJob.InstanceConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BatchPredictionJob.InstanceConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public BatchPredictionJob.InstanceConfig.Builder toBuilder()
Returns
Type Description
BatchPredictionJob.InstanceConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException