Class BatchPredictionJob.InstanceConfig (3.84.0)

Version latest

• 3.84.0 (latest)
• 3.83.0
• 3.82.0
• 3.81.0
• 3.79.0
• 3.77.0
• 3.76.0
• 3.75.0
• 3.74.0
• 3.73.0
• 3.71.0
• 3.69.0
• 3.68.0
• 3.65.0
• 3.64.0
• 3.63.0
• 3.61.0
• 3.60.0
• 3.59.0
• 3.58.0
• 3.57.0
• 3.56.0
• 3.55.0
• 3.54.0
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

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

Implements

BatchPredictionJob.InstanceConfigOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

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

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

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

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

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

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

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

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

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

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

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

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

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

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

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

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

AbstractMessage.equals(Object other)

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

GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public BatchPredictionJob.InstanceConfig.Builder newBuilderForType()

Returns
Type	Description
BatchPredictionJob.InstanceConfig.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected BatchPredictionJob.InstanceConfig.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
BatchPredictionJob.InstanceConfig.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

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

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException