Package com.google.cloud.aiplatform.v1
Class BatchPredictionJob.InstanceConfig.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessageV3.Builder<BatchPredictionJob.InstanceConfig.Builder>
-
- com.google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig.Builder
-
- All Implemented Interfaces:
BatchPredictionJob.InstanceConfigOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- BatchPredictionJob.InstanceConfig
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 typegoogle.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description BatchPredictionJob.InstanceConfig.BuilderaddAllExcludedFields(Iterable<String> values)Fields that will be excluded in the prediction instance that is sent to the Model.BatchPredictionJob.InstanceConfig.BuilderaddAllIncludedFields(Iterable<String> values)Fields that will be included in the prediction instance that is sent to the Model.BatchPredictionJob.InstanceConfig.BuilderaddExcludedFields(String value)Fields that will be excluded in the prediction instance that is sent to the Model.BatchPredictionJob.InstanceConfig.BuilderaddExcludedFieldsBytes(com.google.protobuf.ByteString value)Fields that will be excluded in the prediction instance that is sent to the Model.BatchPredictionJob.InstanceConfig.BuilderaddIncludedFields(String value)Fields that will be included in the prediction instance that is sent to the Model.BatchPredictionJob.InstanceConfig.BuilderaddIncludedFieldsBytes(com.google.protobuf.ByteString value)Fields that will be included in the prediction instance that is sent to the Model.BatchPredictionJob.InstanceConfig.BuilderaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)BatchPredictionJob.InstanceConfigbuild()BatchPredictionJob.InstanceConfigbuildPartial()BatchPredictionJob.InstanceConfig.Builderclear()BatchPredictionJob.InstanceConfig.BuilderclearExcludedFields()Fields that will be excluded in the prediction instance that is sent to the Model.BatchPredictionJob.InstanceConfig.BuilderclearField(com.google.protobuf.Descriptors.FieldDescriptor field)BatchPredictionJob.InstanceConfig.BuilderclearIncludedFields()Fields that will be included in the prediction instance that is sent to the Model.BatchPredictionJob.InstanceConfig.BuilderclearInstanceType()The format of the instance that the Model accepts.BatchPredictionJob.InstanceConfig.BuilderclearKeyField()The name of the field that is considered as a key.BatchPredictionJob.InstanceConfig.BuilderclearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)BatchPredictionJob.InstanceConfig.Builderclone()BatchPredictionJob.InstanceConfiggetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()com.google.protobuf.Descriptors.DescriptorgetDescriptorForType()StringgetExcludedFields(int index)Fields that will be excluded in the prediction instance that is sent to the Model.com.google.protobuf.ByteStringgetExcludedFieldsBytes(int index)Fields that will be excluded in the prediction instance that is sent to the Model.intgetExcludedFieldsCount()Fields that will be excluded in the prediction instance that is sent to the Model.com.google.protobuf.ProtocolStringListgetExcludedFieldsList()Fields that will be excluded in the prediction instance that is sent to the Model.StringgetIncludedFields(int index)Fields that will be included in the prediction instance that is sent to the Model.com.google.protobuf.ByteStringgetIncludedFieldsBytes(int index)Fields that will be included in the prediction instance that is sent to the Model.intgetIncludedFieldsCount()Fields that will be included in the prediction instance that is sent to the Model.com.google.protobuf.ProtocolStringListgetIncludedFieldsList()Fields that will be included in the prediction instance that is sent to the Model.StringgetInstanceType()The format of the instance that the Model accepts.com.google.protobuf.ByteStringgetInstanceTypeBytes()The format of the instance that the Model accepts.StringgetKeyField()The name of the field that is considered as a key.com.google.protobuf.ByteStringgetKeyFieldBytes()The name of the field that is considered as a key.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()BatchPredictionJob.InstanceConfig.BuildermergeFrom(BatchPredictionJob.InstanceConfig other)BatchPredictionJob.InstanceConfig.BuildermergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)BatchPredictionJob.InstanceConfig.BuildermergeFrom(com.google.protobuf.Message other)BatchPredictionJob.InstanceConfig.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)BatchPredictionJob.InstanceConfig.BuildersetExcludedFields(int index, String value)Fields that will be excluded in the prediction instance that is sent to the Model.BatchPredictionJob.InstanceConfig.BuildersetField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)BatchPredictionJob.InstanceConfig.BuildersetIncludedFields(int index, String value)Fields that will be included in the prediction instance that is sent to the Model.BatchPredictionJob.InstanceConfig.BuildersetInstanceType(String value)The format of the instance that the Model accepts.BatchPredictionJob.InstanceConfig.BuildersetInstanceTypeBytes(com.google.protobuf.ByteString value)The format of the instance that the Model accepts.BatchPredictionJob.InstanceConfig.BuildersetKeyField(String value)The name of the field that is considered as a key.BatchPredictionJob.InstanceConfig.BuildersetKeyFieldBytes(com.google.protobuf.ByteString value)The name of the field that is considered as a key.BatchPredictionJob.InstanceConfig.BuildersetRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)BatchPredictionJob.InstanceConfig.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<BatchPredictionJob.InstanceConfig.Builder>
-
clear
public BatchPredictionJob.InstanceConfig.Builder clear()
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<BatchPredictionJob.InstanceConfig.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<BatchPredictionJob.InstanceConfig.Builder>
-
getDefaultInstanceForType
public BatchPredictionJob.InstanceConfig getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
public BatchPredictionJob.InstanceConfig build()
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public BatchPredictionJob.InstanceConfig buildPartial()
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
public BatchPredictionJob.InstanceConfig.Builder clone()
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<BatchPredictionJob.InstanceConfig.Builder>
-
setField
public BatchPredictionJob.InstanceConfig.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<BatchPredictionJob.InstanceConfig.Builder>
-
clearField
public BatchPredictionJob.InstanceConfig.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<BatchPredictionJob.InstanceConfig.Builder>
-
clearOneof
public BatchPredictionJob.InstanceConfig.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<BatchPredictionJob.InstanceConfig.Builder>
-
setRepeatedField
public BatchPredictionJob.InstanceConfig.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
- Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<BatchPredictionJob.InstanceConfig.Builder>
-
addRepeatedField
public BatchPredictionJob.InstanceConfig.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<BatchPredictionJob.InstanceConfig.Builder>
-
mergeFrom
public BatchPredictionJob.InstanceConfig.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<BatchPredictionJob.InstanceConfig.Builder>
-
mergeFrom
public BatchPredictionJob.InstanceConfig.Builder mergeFrom(BatchPredictionJob.InstanceConfig other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<BatchPredictionJob.InstanceConfig.Builder>
-
mergeFrom
public BatchPredictionJob.InstanceConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<BatchPredictionJob.InstanceConfig.Builder>- Throws:
IOException
-
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:
getInstanceTypein interfaceBatchPredictionJob.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:
getInstanceTypeBytesin interfaceBatchPredictionJob.InstanceConfigOrBuilder- Returns:
- The bytes for instanceType.
-
setInstanceType
public 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;- Parameters:
value- The instanceType to set.- Returns:
- This builder for chaining.
-
clearInstanceType
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;- Returns:
- This builder for chaining.
-
setInstanceTypeBytes
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;- Parameters:
value- The bytes for instanceType to set.- Returns:
- This builder for chaining.
-
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:
getKeyFieldin interfaceBatchPredictionJob.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:
getKeyFieldBytesin interfaceBatchPredictionJob.InstanceConfigOrBuilder- Returns:
- The bytes for keyField.
-
setKeyField
public 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;- Parameters:
value- The keyField to set.- Returns:
- This builder for chaining.
-
clearKeyField
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;- Returns:
- This builder for chaining.
-
setKeyFieldBytes
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;- Parameters:
value- The bytes for keyField to set.- Returns:
- This builder for chaining.
-
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, CSV, BigQuery or TfRecord.
repeated string included_fields = 3;- Specified by:
getIncludedFieldsListin interfaceBatchPredictionJob.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, CSV, BigQuery or TfRecord.
repeated string included_fields = 3;- Specified by:
getIncludedFieldsCountin interfaceBatchPredictionJob.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, CSV, BigQuery or TfRecord.
repeated string included_fields = 3;- Specified by:
getIncludedFieldsin interfaceBatchPredictionJob.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, CSV, BigQuery or TfRecord.
repeated string included_fields = 3;- Specified by:
getIncludedFieldsBytesin interfaceBatchPredictionJob.InstanceConfigOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the includedFields at the given index.
-
setIncludedFields
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, CSV, BigQuery or TfRecord.
repeated string included_fields = 3;- Parameters:
index- The index to set the value at.value- The includedFields to set.- Returns:
- This builder for chaining.
-
addIncludedFields
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, CSV, BigQuery or TfRecord.
repeated string included_fields = 3;- Parameters:
value- The includedFields to add.- Returns:
- This builder for chaining.
-
addAllIncludedFields
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, CSV, BigQuery or TfRecord.
repeated string included_fields = 3;- Parameters:
values- The includedFields to add.- Returns:
- This builder for chaining.
-
clearIncludedFields
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, CSV, BigQuery or TfRecord.
repeated string included_fields = 3;- Returns:
- This builder for chaining.
-
addIncludedFieldsBytes
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, CSV, BigQuery or TfRecord.
repeated string included_fields = 3;- Parameters:
value- The bytes of the includedFields to add.- Returns:
- This builder for chaining.
-
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, CSV, BigQuery or TfRecord.
repeated string excluded_fields = 4;- Specified by:
getExcludedFieldsListin interfaceBatchPredictionJob.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, CSV, BigQuery or TfRecord.
repeated string excluded_fields = 4;- Specified by:
getExcludedFieldsCountin interfaceBatchPredictionJob.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, CSV, BigQuery or TfRecord.
repeated string excluded_fields = 4;- Specified by:
getExcludedFieldsin interfaceBatchPredictionJob.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, CSV, BigQuery or TfRecord.
repeated string excluded_fields = 4;- Specified by:
getExcludedFieldsBytesin interfaceBatchPredictionJob.InstanceConfigOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the excludedFields at the given index.
-
setExcludedFields
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, CSV, BigQuery or TfRecord.
repeated string excluded_fields = 4;- Parameters:
index- The index to set the value at.value- The excludedFields to set.- Returns:
- This builder for chaining.
-
addExcludedFields
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, CSV, BigQuery or TfRecord.
repeated string excluded_fields = 4;- Parameters:
value- The excludedFields to add.- Returns:
- This builder for chaining.
-
addAllExcludedFields
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, CSV, BigQuery or TfRecord.
repeated string excluded_fields = 4;- Parameters:
values- The excludedFields to add.- Returns:
- This builder for chaining.
-
clearExcludedFields
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, CSV, BigQuery or TfRecord.
repeated string excluded_fields = 4;- Returns:
- This builder for chaining.
-
addExcludedFieldsBytes
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, CSV, BigQuery or TfRecord.
repeated string excluded_fields = 4;- Parameters:
value- The bytes of the excludedFields to add.- Returns:
- This builder for chaining.
-
setUnknownFields
public final BatchPredictionJob.InstanceConfig.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<BatchPredictionJob.InstanceConfig.Builder>
-
mergeUnknownFields
public final BatchPredictionJob.InstanceConfig.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<BatchPredictionJob.InstanceConfig.Builder>
-
-