Package com.google.cloud.aiplatform.v1

Class BatchPredictionJob.InstanceConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig
All Implemented Interfaces:
BatchPredictionJob.InstanceConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
BatchPredictionJob
public static final class BatchPredictionJob.InstanceConfig extends com.google.protobuf.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
See Also:

  • Field Details

    • INSTANCE_TYPE_FIELD_NUMBER

      public static final int INSTANCE_TYPE_FIELD_NUMBER
      See Also:

    • KEY_FIELD_FIELD_NUMBER

      public static final int KEY_FIELD_FIELD_NUMBER
      See Also:

    • INCLUDED_FIELDS_FIELD_NUMBER

      public static final int INCLUDED_FIELDS_FIELD_NUMBER
      See Also:

    • EXCLUDED_FIELDS_FIELD_NUMBER

      public static final int EXCLUDED_FIELDS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getInstanceType

      public 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;
      Specified by:
      getInstanceType in interface BatchPredictionJob.InstanceConfigOrBuilder
      Returns:
      The instanceType.

    • getInstanceTypeBytes

      public 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;
      Specified by:
      getInstanceTypeBytes in interface BatchPredictionJob.InstanceConfigOrBuilder
      Returns:
      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][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;
      Specified by:
      getKeyField in interface BatchPredictionJob.InstanceConfigOrBuilder
      Returns:
      The keyField.

    • getKeyFieldBytes

      public 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;
      Specified by:
      getKeyFieldBytes in interface BatchPredictionJob.InstanceConfigOrBuilder
      Returns:
      The bytes for keyField.

    • getIncludedFieldsList

      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;
      Specified by:
      getIncludedFieldsList in interface BatchPredictionJob.InstanceConfigOrBuilder
      Returns:
      A list containing the includedFields.

    • getIncludedFieldsCount

      public 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;
      Specified by:
      getIncludedFieldsCount in interface BatchPredictionJob.InstanceConfigOrBuilder
      Returns:
      The count of includedFields.

    • getIncludedFields

      public 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;
      Specified by:
      getIncludedFields in interface BatchPredictionJob.InstanceConfigOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The includedFields at the given index.

    • getIncludedFieldsBytes

      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;
      Specified by:
      getIncludedFieldsBytes in interface BatchPredictionJob.InstanceConfigOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the includedFields at the given index.

    • getExcludedFieldsList

      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;
      Specified by:
      getExcludedFieldsList in interface BatchPredictionJob.InstanceConfigOrBuilder
      Returns:
      A list containing the excludedFields.

    • 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][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;
      Specified by:
      getExcludedFieldsCount in interface BatchPredictionJob.InstanceConfigOrBuilder
      Returns:
      The count of excludedFields.

    • getExcludedFields

      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][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;
      Specified by:
      getExcludedFields in interface BatchPredictionJob.InstanceConfigOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The excludedFields at the given index.

    • getExcludedFieldsBytes

      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;
      Specified by:
      getExcludedFieldsBytes in interface BatchPredictionJob.InstanceConfigOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the excludedFields at the given index.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static BatchPredictionJob.InstanceConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BatchPredictionJob.InstanceConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BatchPredictionJob.InstanceConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BatchPredictionJob.InstanceConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BatchPredictionJob.InstanceConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BatchPredictionJob.InstanceConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BatchPredictionJob.InstanceConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BatchPredictionJob.InstanceConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static BatchPredictionJob.InstanceConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static BatchPredictionJob.InstanceConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BatchPredictionJob.InstanceConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BatchPredictionJob.InstanceConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public BatchPredictionJob.InstanceConfig.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static BatchPredictionJob.InstanceConfig.Builder newBuilder()

    • newBuilder

      public static BatchPredictionJob.InstanceConfig.Builder newBuilder(BatchPredictionJob.InstanceConfig prototype)

    • toBuilder

      public BatchPredictionJob.InstanceConfig.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected BatchPredictionJob.InstanceConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static BatchPredictionJob.InstanceConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<BatchPredictionJob.InstanceConfig> parser()

    • getParserForType

      public com.google.protobuf.Parser<BatchPredictionJob.InstanceConfig> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public BatchPredictionJob.InstanceConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder