Class BatchPredictionJob.Builder (3.47.0) 

public static final class BatchPredictionJob.Builder extends GeneratedMessageV3.Builder<BatchPredictionJob.Builder> implements BatchPredictionJobOrBuilder

A job that uses a Model to produce predictions on multiple input instances. If predictions for significant portion of the instances fail, the job may finish without attempting predictions for all remaining instances.

Protobuf type google.cloud.aiplatform.v1.BatchPredictionJob

Inheritance

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

Static Methods

getDescriptor()

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

Methods

addAllPartialFailures(Iterable<? extends Status> values)

public BatchPredictionJob.Builder addAllPartialFailures(Iterable<? extends Status> values)

Output only. Partial failures encountered. For example, single files that can't be read. This field never exceeds 20 entries. Status details fields contain standard Google Cloud error details.

repeated .google.rpc.Status partial_failures = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<? extends com.google.rpc.Status>
Returns
Type Description
BatchPredictionJob.Builder

addPartialFailures(Status value)

public BatchPredictionJob.Builder addPartialFailures(Status value)

Output only. Partial failures encountered. For example, single files that can't be read. This field never exceeds 20 entries. Status details fields contain standard Google Cloud error details.

repeated .google.rpc.Status partial_failures = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value com.google.rpc.Status
Returns
Type Description
BatchPredictionJob.Builder

addPartialFailures(Status.Builder builderForValue)

public BatchPredictionJob.Builder addPartialFailures(Status.Builder builderForValue)

Output only. Partial failures encountered. For example, single files that can't be read. This field never exceeds 20 entries. Status details fields contain standard Google Cloud error details.

repeated .google.rpc.Status partial_failures = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue com.google.rpc.Status.Builder
Returns
Type Description
BatchPredictionJob.Builder

addPartialFailures(int index, Status value)

public BatchPredictionJob.Builder addPartialFailures(int index, Status value)

Output only. Partial failures encountered. For example, single files that can't be read. This field never exceeds 20 entries. Status details fields contain standard Google Cloud error details.

repeated .google.rpc.Status partial_failures = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value com.google.rpc.Status
Returns
Type Description
BatchPredictionJob.Builder

addPartialFailures(int index, Status.Builder builderForValue)

public BatchPredictionJob.Builder addPartialFailures(int index, Status.Builder builderForValue)

Output only. Partial failures encountered. For example, single files that can't be read. This field never exceeds 20 entries. Status details fields contain standard Google Cloud error details.

repeated .google.rpc.Status partial_failures = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue com.google.rpc.Status.Builder
Returns
Type Description
BatchPredictionJob.Builder

addPartialFailuresBuilder()

public Status.Builder addPartialFailuresBuilder()

Output only. Partial failures encountered. For example, single files that can't be read. This field never exceeds 20 entries. Status details fields contain standard Google Cloud error details.

repeated .google.rpc.Status partial_failures = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.rpc.Status.Builder

addPartialFailuresBuilder(int index)

public Status.Builder addPartialFailuresBuilder(int index)

Output only. Partial failures encountered. For example, single files that can't be read. This field never exceeds 20 entries. Status details fields contain standard Google Cloud error details.

repeated .google.rpc.Status partial_failures = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
com.google.rpc.Status.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BatchPredictionJob.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BatchPredictionJob.Builder
Overrides

build()

public BatchPredictionJob build()
Returns
Type Description
BatchPredictionJob

buildPartial()

public BatchPredictionJob buildPartial()
Returns
Type Description
BatchPredictionJob

clear()

public BatchPredictionJob.Builder clear()
Returns
Type Description
BatchPredictionJob.Builder
Overrides

clearCompletionStats()

public BatchPredictionJob.Builder clearCompletionStats()

Output only. Statistics on completed and failed prediction instances.

.google.cloud.aiplatform.v1.CompletionStats completion_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BatchPredictionJob.Builder

clearCreateTime()

public BatchPredictionJob.Builder clearCreateTime()

Output only. Time when the BatchPredictionJob was created.

.google.protobuf.Timestamp create_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BatchPredictionJob.Builder

clearDedicatedResources()

public BatchPredictionJob.Builder clearDedicatedResources()

The config of resources used by the Model during the batch prediction. If the Model supports DEDICATED_RESOURCES this config may be provided (and the job will use these resources), if the Model doesn't support AUTOMATIC_RESOURCES, this config must be provided.

.google.cloud.aiplatform.v1.BatchDedicatedResources dedicated_resources = 7;

Returns
Type Description
BatchPredictionJob.Builder

clearDisableContainerLogging()

public BatchPredictionJob.Builder clearDisableContainerLogging()

For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send stderr and stdout streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to Cloud Logging pricing.

User can disable container logging by setting this flag to true.

bool disable_container_logging = 34;

Returns
Type Description
BatchPredictionJob.Builder

This builder for chaining.

clearDisplayName()

public BatchPredictionJob.Builder clearDisplayName()

Required. The user-defined name of this BatchPredictionJob.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BatchPredictionJob.Builder

This builder for chaining.

clearEncryptionSpec()

public BatchPredictionJob.Builder clearEncryptionSpec()

Customer-managed encryption key options for a BatchPredictionJob. If this is set, then all resources created by the BatchPredictionJob will be encrypted with the provided encryption key.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 24;

Returns
Type Description
BatchPredictionJob.Builder

clearEndTime()

public BatchPredictionJob.Builder clearEndTime()

Output only. Time when the BatchPredictionJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.

.google.protobuf.Timestamp end_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BatchPredictionJob.Builder

clearError()

public BatchPredictionJob.Builder clearError()

Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

.google.rpc.Status error = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BatchPredictionJob.Builder

clearExplanationSpec()

public BatchPredictionJob.Builder clearExplanationSpec()

Explanation configuration for this BatchPredictionJob. Can be specified only if generate_explanation is set to true.

This value overrides the value of Model.explanation_spec. All fields of explanation_spec are optional in the request. If a field of the explanation_spec object is not populated, the corresponding field of the Model.explanation_spec object is inherited.

.google.cloud.aiplatform.v1.ExplanationSpec explanation_spec = 25;

Returns
Type Description
BatchPredictionJob.Builder

clearField(Descriptors.FieldDescriptor field)

public BatchPredictionJob.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
BatchPredictionJob.Builder
Overrides

clearGenerateExplanation()

public BatchPredictionJob.Builder clearGenerateExplanation()

Generate explanation with the batch prediction results.

When set to true, the batch prediction output changes based on the predictions_format field of the BatchPredictionJob.output_config object:

  • bigquery: output includes a column named explanation. The value is a struct that conforms to the Explanation object.
  • jsonl: The JSON objects on each line include an additional entry keyed explanation. The value of the entry is a JSON object that conforms to the Explanation object.

  • csv: Generating explanations for CSV format is not supported.

    If this field is set to true, either the Model.explanation_spec or explanation_spec must be populated.

bool generate_explanation = 23;

Returns
Type Description
BatchPredictionJob.Builder

This builder for chaining.

clearInputConfig()

public BatchPredictionJob.Builder clearInputConfig()

Required. Input configuration of the instances on which predictions are performed. The schema of any single instance may be specified via the Model's PredictSchemata's instance_schema_uri.

.google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig input_config = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BatchPredictionJob.Builder

clearInstanceConfig()

public BatchPredictionJob.Builder clearInstanceConfig()

Configuration for how to convert batch prediction input instances to the prediction instances that are sent to the Model.

.google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig instance_config = 27;

Returns
Type Description
BatchPredictionJob.Builder

clearLabels()

public BatchPredictionJob.Builder clearLabels()
Returns
Type Description
BatchPredictionJob.Builder

clearManualBatchTuningParameters()

public BatchPredictionJob.Builder clearManualBatchTuningParameters()

Immutable. Parameters configuring the batch behavior. Currently only applicable when dedicated_resources are used (in other cases Vertex AI does the tuning itself).

.google.cloud.aiplatform.v1.ManualBatchTuningParameters manual_batch_tuning_parameters = 8 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
BatchPredictionJob.Builder

clearModel()

public BatchPredictionJob.Builder clearModel()

The name of the Model resource that produces the predictions via this job, must share the same ancestor Location. Starting this job has no impact on any existing deployments of the Model and their resources. Exactly one of model and unmanaged_container_model must be set.

The model resource name may contain version id or version alias to specify the version. Example: projects/{project}/locations/{location}/models/{model}@2 or projects/{project}/locations/{location}/models/{model}@golden if no version is specified, the default version will be deployed.

The model resource could also be a publisher model. Example: publishers/{publisher}/models/{model} or projects/{project}/locations/{location}/publishers/{publisher}/models/{model}

string model = 3 [(.google.api.resource_reference) = { ... }

Returns
Type Description
BatchPredictionJob.Builder

This builder for chaining.

clearModelParameters()

public BatchPredictionJob.Builder clearModelParameters()

The parameters that govern the predictions. The schema of the parameters may be specified via the Model's PredictSchemata's parameters_schema_uri.

.google.protobuf.Value model_parameters = 5;

Returns
Type Description
BatchPredictionJob.Builder

clearModelVersionId()

public BatchPredictionJob.Builder clearModelVersionId()

Output only. The version ID of the Model that produces the predictions via this job.

string model_version_id = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BatchPredictionJob.Builder

This builder for chaining.

clearName()

public BatchPredictionJob.Builder clearName()

Output only. Resource name of the BatchPredictionJob.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BatchPredictionJob.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public BatchPredictionJob.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
BatchPredictionJob.Builder
Overrides

clearOutputConfig()

public BatchPredictionJob.Builder clearOutputConfig()

Required. The Configuration specifying where output predictions should be written. The schema of any single prediction may be specified as a concatenation of Model's PredictSchemata's instance_schema_uri and prediction_schema_uri.

.google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BatchPredictionJob.Builder

clearOutputInfo()

public BatchPredictionJob.Builder clearOutputInfo()

Output only. Information further describing the output of this job.

.google.cloud.aiplatform.v1.BatchPredictionJob.OutputInfo output_info = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BatchPredictionJob.Builder

clearPartialFailures()

public BatchPredictionJob.Builder clearPartialFailures()

Output only. Partial failures encountered. For example, single files that can't be read. This field never exceeds 20 entries. Status details fields contain standard Google Cloud error details.

repeated .google.rpc.Status partial_failures = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BatchPredictionJob.Builder

clearResourcesConsumed()

public BatchPredictionJob.Builder clearResourcesConsumed()

Output only. Information about resources that had been consumed by this job. Provided in real time at best effort basis, as well as a final value once the job completes.

Note: This field currently may be not populated for batch predictions that use AutoML Models.

.google.cloud.aiplatform.v1.ResourcesConsumed resources_consumed = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BatchPredictionJob.Builder

clearServiceAccount()

public BatchPredictionJob.Builder clearServiceAccount()

The service account that the DeployedModel's container runs as. If not specified, a system generated one will be used, which has minimal permissions and the custom container, if used, may not have enough permission to access other Google Cloud resources.

Users deploying the Model must have the iam.serviceAccounts.actAs permission on this service account.

string service_account = 29;

Returns
Type Description
BatchPredictionJob.Builder

This builder for chaining.

clearStartTime()

public BatchPredictionJob.Builder clearStartTime()

Output only. Time when the BatchPredictionJob for the first time entered the JOB_STATE_RUNNING state.

.google.protobuf.Timestamp start_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BatchPredictionJob.Builder

clearState()

public BatchPredictionJob.Builder clearState()

Output only. The detailed state of the job.

.google.cloud.aiplatform.v1.JobState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BatchPredictionJob.Builder

This builder for chaining.

clearUnmanagedContainerModel()

public BatchPredictionJob.Builder clearUnmanagedContainerModel()

Contains model information necessary to perform batch prediction without requiring uploading to model registry. Exactly one of model and unmanaged_container_model must be set.

.google.cloud.aiplatform.v1.UnmanagedContainerModel unmanaged_container_model = 28;

Returns
Type Description
BatchPredictionJob.Builder

clearUpdateTime()

public BatchPredictionJob.Builder clearUpdateTime()

Output only. Time when the BatchPredictionJob was most recently updated.

.google.protobuf.Timestamp update_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BatchPredictionJob.Builder

clone()

public BatchPredictionJob.Builder clone()
Returns
Type Description
BatchPredictionJob.Builder
Overrides

containsLabels(String key)

public boolean containsLabels(String key)

The labels with user-defined metadata to organize BatchPredictionJobs.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

map<string, string> labels = 19;

Parameter
Name Description
key String
Returns
Type Description
boolean

getCompletionStats()

public CompletionStats getCompletionStats()

Output only. Statistics on completed and failed prediction instances.

.google.cloud.aiplatform.v1.CompletionStats completion_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CompletionStats

The completionStats.

getCompletionStatsBuilder()

public CompletionStats.Builder getCompletionStatsBuilder()

Output only. Statistics on completed and failed prediction instances.

.google.cloud.aiplatform.v1.CompletionStats completion_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CompletionStats.Builder

getCompletionStatsOrBuilder()

public CompletionStatsOrBuilder getCompletionStatsOrBuilder()

Output only. Statistics on completed and failed prediction instances.

.google.cloud.aiplatform.v1.CompletionStats completion_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CompletionStatsOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. Time when the BatchPredictionJob was created.

.google.protobuf.Timestamp create_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Time when the BatchPredictionJob was created.

.google.protobuf.Timestamp create_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time when the BatchPredictionJob was created.

.google.protobuf.Timestamp create_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDedicatedResources()

public BatchDedicatedResources getDedicatedResources()

The config of resources used by the Model during the batch prediction. If the Model supports DEDICATED_RESOURCES this config may be provided (and the job will use these resources), if the Model doesn't support AUTOMATIC_RESOURCES, this config must be provided.

.google.cloud.aiplatform.v1.BatchDedicatedResources dedicated_resources = 7;

Returns
Type Description
BatchDedicatedResources

The dedicatedResources.

getDedicatedResourcesBuilder()

public BatchDedicatedResources.Builder getDedicatedResourcesBuilder()

The config of resources used by the Model during the batch prediction. If the Model supports DEDICATED_RESOURCES this config may be provided (and the job will use these resources), if the Model doesn't support AUTOMATIC_RESOURCES, this config must be provided.

.google.cloud.aiplatform.v1.BatchDedicatedResources dedicated_resources = 7;

Returns
Type Description
BatchDedicatedResources.Builder

getDedicatedResourcesOrBuilder()

public BatchDedicatedResourcesOrBuilder getDedicatedResourcesOrBuilder()

The config of resources used by the Model during the batch prediction. If the Model supports DEDICATED_RESOURCES this config may be provided (and the job will use these resources), if the Model doesn't support AUTOMATIC_RESOURCES, this config must be provided.

.google.cloud.aiplatform.v1.BatchDedicatedResources dedicated_resources = 7;

Returns
Type Description
BatchDedicatedResourcesOrBuilder

getDefaultInstanceForType()

public BatchPredictionJob getDefaultInstanceForType()
Returns
Type Description
BatchPredictionJob

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisableContainerLogging()

public boolean getDisableContainerLogging()

For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send stderr and stdout streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to Cloud Logging pricing.

User can disable container logging by setting this flag to true.

bool disable_container_logging = 34;

Returns
Type Description
boolean

The disableContainerLogging.

getDisplayName()

public String getDisplayName()

Required. The user-defined name of this BatchPredictionJob.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The user-defined name of this BatchPredictionJob.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getEncryptionSpec()

public EncryptionSpec getEncryptionSpec()

Customer-managed encryption key options for a BatchPredictionJob. If this is set, then all resources created by the BatchPredictionJob will be encrypted with the provided encryption key.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 24;

Returns
Type Description
EncryptionSpec

The encryptionSpec.

getEncryptionSpecBuilder()

public EncryptionSpec.Builder getEncryptionSpecBuilder()

Customer-managed encryption key options for a BatchPredictionJob. If this is set, then all resources created by the BatchPredictionJob will be encrypted with the provided encryption key.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 24;

Returns
Type Description
EncryptionSpec.Builder

getEncryptionSpecOrBuilder()

public EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()

Customer-managed encryption key options for a BatchPredictionJob. If this is set, then all resources created by the BatchPredictionJob will be encrypted with the provided encryption key.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 24;

Returns
Type Description
EncryptionSpecOrBuilder

getEndTime()

public Timestamp getEndTime()

Output only. Time when the BatchPredictionJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.

.google.protobuf.Timestamp end_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The endTime.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

Output only. Time when the BatchPredictionJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.

.google.protobuf.Timestamp end_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

Output only. Time when the BatchPredictionJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.

.google.protobuf.Timestamp end_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getError()

public Status getError()

Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

.google.rpc.Status error = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.rpc.Status

The error.

getErrorBuilder()

public Status.Builder getErrorBuilder()

Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

.google.rpc.Status error = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.rpc.Status.Builder

getErrorOrBuilder()

public StatusOrBuilder getErrorOrBuilder()

Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

.google.rpc.Status error = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.rpc.StatusOrBuilder

getExplanationSpec()

public ExplanationSpec getExplanationSpec()

Explanation configuration for this BatchPredictionJob. Can be specified only if generate_explanation is set to true.

This value overrides the value of Model.explanation_spec. All fields of explanation_spec are optional in the request. If a field of the explanation_spec object is not populated, the corresponding field of the Model.explanation_spec object is inherited.

.google.cloud.aiplatform.v1.ExplanationSpec explanation_spec = 25;

Returns
Type Description
ExplanationSpec

The explanationSpec.

getExplanationSpecBuilder()

public ExplanationSpec.Builder getExplanationSpecBuilder()

Explanation configuration for this BatchPredictionJob. Can be specified only if generate_explanation is set to true.

This value overrides the value of Model.explanation_spec. All fields of explanation_spec are optional in the request. If a field of the explanation_spec object is not populated, the corresponding field of the Model.explanation_spec object is inherited.

.google.cloud.aiplatform.v1.ExplanationSpec explanation_spec = 25;

Returns
Type Description
ExplanationSpec.Builder

getExplanationSpecOrBuilder()

public ExplanationSpecOrBuilder getExplanationSpecOrBuilder()

Explanation configuration for this BatchPredictionJob. Can be specified only if generate_explanation is set to true.

This value overrides the value of Model.explanation_spec. All fields of explanation_spec are optional in the request. If a field of the explanation_spec object is not populated, the corresponding field of the Model.explanation_spec object is inherited.

.google.cloud.aiplatform.v1.ExplanationSpec explanation_spec = 25;

Returns
Type Description
ExplanationSpecOrBuilder

getGenerateExplanation()

public boolean getGenerateExplanation()

Generate explanation with the batch prediction results.

When set to true, the batch prediction output changes based on the predictions_format field of the BatchPredictionJob.output_config object:

  • bigquery: output includes a column named explanation. The value is a struct that conforms to the Explanation object.
  • jsonl: The JSON objects on each line include an additional entry keyed explanation. The value of the entry is a JSON object that conforms to the Explanation object.

  • csv: Generating explanations for CSV format is not supported.

    If this field is set to true, either the Model.explanation_spec or explanation_spec must be populated.

bool generate_explanation = 23;

Returns
Type Description
boolean

The generateExplanation.

getInputConfig()

public BatchPredictionJob.InputConfig getInputConfig()

Required. Input configuration of the instances on which predictions are performed. The schema of any single instance may be specified via the Model's PredictSchemata's instance_schema_uri.

.google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig input_config = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BatchPredictionJob.InputConfig

The inputConfig.

getInputConfigBuilder()

public BatchPredictionJob.InputConfig.Builder getInputConfigBuilder()

Required. Input configuration of the instances on which predictions are performed. The schema of any single instance may be specified via the Model's PredictSchemata's instance_schema_uri.

.google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig input_config = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BatchPredictionJob.InputConfig.Builder

getInputConfigOrBuilder()

public BatchPredictionJob.InputConfigOrBuilder getInputConfigOrBuilder()

Required. Input configuration of the instances on which predictions are performed. The schema of any single instance may be specified via the Model's PredictSchemata's instance_schema_uri.

.google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig input_config = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BatchPredictionJob.InputConfigOrBuilder

getInstanceConfig()

public BatchPredictionJob.InstanceConfig getInstanceConfig()

Configuration for how to convert batch prediction input instances to the prediction instances that are sent to the Model.

.google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig instance_config = 27;

Returns
Type Description
BatchPredictionJob.InstanceConfig

The instanceConfig.

getInstanceConfigBuilder()

public BatchPredictionJob.InstanceConfig.Builder getInstanceConfigBuilder()

Configuration for how to convert batch prediction input instances to the prediction instances that are sent to the Model.

.google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig instance_config = 27;

Returns
Type Description
BatchPredictionJob.InstanceConfig.Builder

getInstanceConfigOrBuilder()

public BatchPredictionJob.InstanceConfigOrBuilder getInstanceConfigOrBuilder()

Configuration for how to convert batch prediction input instances to the prediction instances that are sent to the Model.

.google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig instance_config = 27;

Returns
Type Description
BatchPredictionJob.InstanceConfigOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

The labels with user-defined metadata to organize BatchPredictionJobs.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

map<string, string> labels = 19;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

The labels with user-defined metadata to organize BatchPredictionJobs.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

map<string, string> labels = 19;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

The labels with user-defined metadata to organize BatchPredictionJobs.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

map<string, string> labels = 19;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

The labels with user-defined metadata to organize BatchPredictionJobs.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

map<string, string> labels = 19;

Parameter
Name Description
key String
Returns
Type Description
String

getManualBatchTuningParameters()

public ManualBatchTuningParameters getManualBatchTuningParameters()

Immutable. Parameters configuring the batch behavior. Currently only applicable when dedicated_resources are used (in other cases Vertex AI does the tuning itself).

.google.cloud.aiplatform.v1.ManualBatchTuningParameters manual_batch_tuning_parameters = 8 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ManualBatchTuningParameters

The manualBatchTuningParameters.

getManualBatchTuningParametersBuilder()

public ManualBatchTuningParameters.Builder getManualBatchTuningParametersBuilder()

Immutable. Parameters configuring the batch behavior. Currently only applicable when dedicated_resources are used (in other cases Vertex AI does the tuning itself).

.google.cloud.aiplatform.v1.ManualBatchTuningParameters manual_batch_tuning_parameters = 8 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ManualBatchTuningParameters.Builder

getManualBatchTuningParametersOrBuilder()

public ManualBatchTuningParametersOrBuilder getManualBatchTuningParametersOrBuilder()

Immutable. Parameters configuring the batch behavior. Currently only applicable when dedicated_resources are used (in other cases Vertex AI does the tuning itself).

.google.cloud.aiplatform.v1.ManualBatchTuningParameters manual_batch_tuning_parameters = 8 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ManualBatchTuningParametersOrBuilder

getModel()

public String getModel()

The name of the Model resource that produces the predictions via this job, must share the same ancestor Location. Starting this job has no impact on any existing deployments of the Model and their resources. Exactly one of model and unmanaged_container_model must be set.

The model resource name may contain version id or version alias to specify the version. Example: projects/{project}/locations/{location}/models/{model}@2 or projects/{project}/locations/{location}/models/{model}@golden if no version is specified, the default version will be deployed.

The model resource could also be a publisher model. Example: publishers/{publisher}/models/{model} or projects/{project}/locations/{location}/publishers/{publisher}/models/{model}

string model = 3 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The model.

getModelBytes()

public ByteString getModelBytes()

The name of the Model resource that produces the predictions via this job, must share the same ancestor Location. Starting this job has no impact on any existing deployments of the Model and their resources. Exactly one of model and unmanaged_container_model must be set.

The model resource name may contain version id or version alias to specify the version. Example: projects/{project}/locations/{location}/models/{model}@2 or projects/{project}/locations/{location}/models/{model}@golden if no version is specified, the default version will be deployed.

The model resource could also be a publisher model. Example: publishers/{publisher}/models/{model} or projects/{project}/locations/{location}/publishers/{publisher}/models/{model}

string model = 3 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for model.

getModelParameters()

public Value getModelParameters()

The parameters that govern the predictions. The schema of the parameters may be specified via the Model's PredictSchemata's parameters_schema_uri.

.google.protobuf.Value model_parameters = 5;

Returns
Type Description
Value

The modelParameters.

getModelParametersBuilder()

public Value.Builder getModelParametersBuilder()

The parameters that govern the predictions. The schema of the parameters may be specified via the Model's PredictSchemata's parameters_schema_uri.

.google.protobuf.Value model_parameters = 5;

Returns
Type Description
Builder

getModelParametersOrBuilder()

public ValueOrBuilder getModelParametersOrBuilder()

The parameters that govern the predictions. The schema of the parameters may be specified via the Model's PredictSchemata's parameters_schema_uri.

.google.protobuf.Value model_parameters = 5;

Returns
Type Description
ValueOrBuilder

getModelVersionId()

public String getModelVersionId()

Output only. The version ID of the Model that produces the predictions via this job.

string model_version_id = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The modelVersionId.

getModelVersionIdBytes()

public ByteString getModelVersionIdBytes()

Output only. The version ID of the Model that produces the predictions via this job.

string model_version_id = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for modelVersionId.

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String getName()

Output only. Resource name of the BatchPredictionJob.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Resource name of the BatchPredictionJob.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getOutputConfig()

public BatchPredictionJob.OutputConfig getOutputConfig()

Required. The Configuration specifying where output predictions should be written. The schema of any single prediction may be specified as a concatenation of Model's PredictSchemata's instance_schema_uri and prediction_schema_uri.

.google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BatchPredictionJob.OutputConfig

The outputConfig.

getOutputConfigBuilder()

public BatchPredictionJob.OutputConfig.Builder getOutputConfigBuilder()

Required. The Configuration specifying where output predictions should be written. The schema of any single prediction may be specified as a concatenation of Model's PredictSchemata's instance_schema_uri and prediction_schema_uri.

.google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BatchPredictionJob.OutputConfig.Builder

getOutputConfigOrBuilder()

public BatchPredictionJob.OutputConfigOrBuilder getOutputConfigOrBuilder()

Required. The Configuration specifying where output predictions should be written. The schema of any single prediction may be specified as a concatenation of Model's PredictSchemata's instance_schema_uri and prediction_schema_uri.

.google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BatchPredictionJob.OutputConfigOrBuilder

getOutputInfo()

public BatchPredictionJob.OutputInfo getOutputInfo()

Output only. Information further describing the output of this job.

.google.cloud.aiplatform.v1.BatchPredictionJob.OutputInfo output_info = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BatchPredictionJob.OutputInfo

The outputInfo.

getOutputInfoBuilder()

public BatchPredictionJob.OutputInfo.Builder getOutputInfoBuilder()

Output only. Information further describing the output of this job.

.google.cloud.aiplatform.v1.BatchPredictionJob.OutputInfo output_info = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BatchPredictionJob.OutputInfo.Builder

getOutputInfoOrBuilder()

public BatchPredictionJob.OutputInfoOrBuilder getOutputInfoOrBuilder()

Output only. Information further describing the output of this job.

.google.cloud.aiplatform.v1.BatchPredictionJob.OutputInfo output_info = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BatchPredictionJob.OutputInfoOrBuilder

getPartialFailures(int index)

public Status getPartialFailures(int index)

Output only. Partial failures encountered. For example, single files that can't be read. This field never exceeds 20 entries. Status details fields contain standard Google Cloud error details.

repeated .google.rpc.Status partial_failures = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
com.google.rpc.Status

getPartialFailuresBuilder(int index)

public Status.Builder getPartialFailuresBuilder(int index)

Output only. Partial failures encountered. For example, single files that can't be read. This field never exceeds 20 entries. Status details fields contain standard Google Cloud error details.

repeated .google.rpc.Status partial_failures = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
com.google.rpc.Status.Builder

getPartialFailuresBuilderList()

public List<Status.Builder> getPartialFailuresBuilderList()

Output only. Partial failures encountered. For example, single files that can't be read. This field never exceeds 20 entries. Status details fields contain standard Google Cloud error details.

repeated .google.rpc.Status partial_failures = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<com.google.rpc.Status.Builder>

getPartialFailuresCount()

public int getPartialFailuresCount()

Output only. Partial failures encountered. For example, single files that can't be read. This field never exceeds 20 entries. Status details fields contain standard Google Cloud error details.

repeated .google.rpc.Status partial_failures = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getPartialFailuresList()

public List<Status> getPartialFailuresList()

Output only. Partial failures encountered. For example, single files that can't be read. This field never exceeds 20 entries. Status details fields contain standard Google Cloud error details.

repeated .google.rpc.Status partial_failures = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<com.google.rpc.Status>

getPartialFailuresOrBuilder(int index)

public StatusOrBuilder getPartialFailuresOrBuilder(int index)

Output only. Partial failures encountered. For example, single files that can't be read. This field never exceeds 20 entries. Status details fields contain standard Google Cloud error details.

repeated .google.rpc.Status partial_failures = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
com.google.rpc.StatusOrBuilder

getPartialFailuresOrBuilderList()

public List<? extends StatusOrBuilder> getPartialFailuresOrBuilderList()

Output only. Partial failures encountered. For example, single files that can't be read. This field never exceeds 20 entries. Status details fields contain standard Google Cloud error details.

repeated .google.rpc.Status partial_failures = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.rpc.StatusOrBuilder>

getResourcesConsumed()

public ResourcesConsumed getResourcesConsumed()

Output only. Information about resources that had been consumed by this job. Provided in real time at best effort basis, as well as a final value once the job completes.

Note: This field currently may be not populated for batch predictions that use AutoML Models.

.google.cloud.aiplatform.v1.ResourcesConsumed resources_consumed = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ResourcesConsumed

The resourcesConsumed.

getResourcesConsumedBuilder()

public ResourcesConsumed.Builder getResourcesConsumedBuilder()

Output only. Information about resources that had been consumed by this job. Provided in real time at best effort basis, as well as a final value once the job completes.

Note: This field currently may be not populated for batch predictions that use AutoML Models.

.google.cloud.aiplatform.v1.ResourcesConsumed resources_consumed = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ResourcesConsumed.Builder

getResourcesConsumedOrBuilder()

public ResourcesConsumedOrBuilder getResourcesConsumedOrBuilder()

Output only. Information about resources that had been consumed by this job. Provided in real time at best effort basis, as well as a final value once the job completes.

Note: This field currently may be not populated for batch predictions that use AutoML Models.

.google.cloud.aiplatform.v1.ResourcesConsumed resources_consumed = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ResourcesConsumedOrBuilder

getServiceAccount()

public String getServiceAccount()

The service account that the DeployedModel's container runs as. If not specified, a system generated one will be used, which has minimal permissions and the custom container, if used, may not have enough permission to access other Google Cloud resources.

Users deploying the Model must have the iam.serviceAccounts.actAs permission on this service account.

string service_account = 29;

Returns
Type Description
String

The serviceAccount.

getServiceAccountBytes()

public ByteString getServiceAccountBytes()

The service account that the DeployedModel's container runs as. If not specified, a system generated one will be used, which has minimal permissions and the custom container, if used, may not have enough permission to access other Google Cloud resources.

Users deploying the Model must have the iam.serviceAccounts.actAs permission on this service account.

string service_account = 29;

Returns
Type Description
ByteString

The bytes for serviceAccount.

getStartTime()

public Timestamp getStartTime()

Output only. Time when the BatchPredictionJob for the first time entered the JOB_STATE_RUNNING state.

.google.protobuf.Timestamp start_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The startTime.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

Output only. Time when the BatchPredictionJob for the first time entered the JOB_STATE_RUNNING state.

.google.protobuf.Timestamp start_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Output only. Time when the BatchPredictionJob for the first time entered the JOB_STATE_RUNNING state.

.google.protobuf.Timestamp start_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getState()

public JobState getState()

Output only. The detailed state of the job.

.google.cloud.aiplatform.v1.JobState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
JobState

The state.

getStateValue()

public int getStateValue()

Output only. The detailed state of the job.

.google.cloud.aiplatform.v1.JobState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getUnmanagedContainerModel()

public UnmanagedContainerModel getUnmanagedContainerModel()

Contains model information necessary to perform batch prediction without requiring uploading to model registry. Exactly one of model and unmanaged_container_model must be set.

.google.cloud.aiplatform.v1.UnmanagedContainerModel unmanaged_container_model = 28;

Returns
Type Description
UnmanagedContainerModel

The unmanagedContainerModel.

getUnmanagedContainerModelBuilder()

public UnmanagedContainerModel.Builder getUnmanagedContainerModelBuilder()

Contains model information necessary to perform batch prediction without requiring uploading to model registry. Exactly one of model and unmanaged_container_model must be set.

.google.cloud.aiplatform.v1.UnmanagedContainerModel unmanaged_container_model = 28;

Returns
Type Description
UnmanagedContainerModel.Builder

getUnmanagedContainerModelOrBuilder()

public UnmanagedContainerModelOrBuilder getUnmanagedContainerModelOrBuilder()

Contains model information necessary to perform batch prediction without requiring uploading to model registry. Exactly one of model and unmanaged_container_model must be set.

.google.cloud.aiplatform.v1.UnmanagedContainerModel unmanaged_container_model = 28;

Returns
Type Description
UnmanagedContainerModelOrBuilder

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Time when the BatchPredictionJob was most recently updated.

.google.protobuf.Timestamp update_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Time when the BatchPredictionJob was most recently updated.

.google.protobuf.Timestamp update_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Time when the BatchPredictionJob was most recently updated.

.google.protobuf.Timestamp update_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCompletionStats()

public boolean hasCompletionStats()

Output only. Statistics on completed and failed prediction instances.

.google.cloud.aiplatform.v1.CompletionStats completion_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the completionStats field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. Time when the BatchPredictionJob was created.

.google.protobuf.Timestamp create_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasDedicatedResources()

public boolean hasDedicatedResources()

The config of resources used by the Model during the batch prediction. If the Model supports DEDICATED_RESOURCES this config may be provided (and the job will use these resources), if the Model doesn't support AUTOMATIC_RESOURCES, this config must be provided.

.google.cloud.aiplatform.v1.BatchDedicatedResources dedicated_resources = 7;

Returns
Type Description
boolean

Whether the dedicatedResources field is set.

hasEncryptionSpec()

public boolean hasEncryptionSpec()

Customer-managed encryption key options for a BatchPredictionJob. If this is set, then all resources created by the BatchPredictionJob will be encrypted with the provided encryption key.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 24;

Returns
Type Description
boolean

Whether the encryptionSpec field is set.

hasEndTime()

public boolean hasEndTime()

Output only. Time when the BatchPredictionJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.

.google.protobuf.Timestamp end_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the endTime field is set.

hasError()

public boolean hasError()

Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

.google.rpc.Status error = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the error field is set.

hasExplanationSpec()

public boolean hasExplanationSpec()

Explanation configuration for this BatchPredictionJob. Can be specified only if generate_explanation is set to true.

This value overrides the value of Model.explanation_spec. All fields of explanation_spec are optional in the request. If a field of the explanation_spec object is not populated, the corresponding field of the Model.explanation_spec object is inherited.

.google.cloud.aiplatform.v1.ExplanationSpec explanation_spec = 25;

Returns
Type Description
boolean

Whether the explanationSpec field is set.

hasInputConfig()

public boolean hasInputConfig()

Required. Input configuration of the instances on which predictions are performed. The schema of any single instance may be specified via the Model's PredictSchemata's instance_schema_uri.

.google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig input_config = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the inputConfig field is set.

hasInstanceConfig()

public boolean hasInstanceConfig()

Configuration for how to convert batch prediction input instances to the prediction instances that are sent to the Model.

.google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig instance_config = 27;

Returns
Type Description
boolean

Whether the instanceConfig field is set.

hasManualBatchTuningParameters()

public boolean hasManualBatchTuningParameters()

Immutable. Parameters configuring the batch behavior. Currently only applicable when dedicated_resources are used (in other cases Vertex AI does the tuning itself).

.google.cloud.aiplatform.v1.ManualBatchTuningParameters manual_batch_tuning_parameters = 8 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the manualBatchTuningParameters field is set.

hasModelParameters()

public boolean hasModelParameters()

The parameters that govern the predictions. The schema of the parameters may be specified via the Model's PredictSchemata's parameters_schema_uri.

.google.protobuf.Value model_parameters = 5;

Returns
Type Description
boolean

Whether the modelParameters field is set.

hasOutputConfig()

public boolean hasOutputConfig()

Required. The Configuration specifying where output predictions should be written. The schema of any single prediction may be specified as a concatenation of Model's PredictSchemata's instance_schema_uri and prediction_schema_uri.

.google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the outputConfig field is set.

hasOutputInfo()

public boolean hasOutputInfo()

Output only. Information further describing the output of this job.

.google.cloud.aiplatform.v1.BatchPredictionJob.OutputInfo output_info = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the outputInfo field is set.

hasResourcesConsumed()

public boolean hasResourcesConsumed()

Output only. Information about resources that had been consumed by this job. Provided in real time at best effort basis, as well as a final value once the job completes.

Note: This field currently may be not populated for batch predictions that use AutoML Models.

.google.cloud.aiplatform.v1.ResourcesConsumed resources_consumed = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the resourcesConsumed field is set.

hasStartTime()

public boolean hasStartTime()

Output only. Time when the BatchPredictionJob for the first time entered the JOB_STATE_RUNNING state.

.google.protobuf.Timestamp start_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the startTime field is set.

hasUnmanagedContainerModel()

public boolean hasUnmanagedContainerModel()

Contains model information necessary to perform batch prediction without requiring uploading to model registry. Exactly one of model and unmanaged_container_model must be set.

.google.cloud.aiplatform.v1.UnmanagedContainerModel unmanaged_container_model = 28;

Returns
Type Description
boolean

Whether the unmanagedContainerModel field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Time when the BatchPredictionJob was most recently updated.

.google.protobuf.Timestamp update_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCompletionStats(CompletionStats value)

public BatchPredictionJob.Builder mergeCompletionStats(CompletionStats value)

Output only. Statistics on completed and failed prediction instances.

.google.cloud.aiplatform.v1.CompletionStats completion_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value CompletionStats
Returns
Type Description
BatchPredictionJob.Builder

mergeCreateTime(Timestamp value)

public BatchPredictionJob.Builder mergeCreateTime(Timestamp value)

Output only. Time when the BatchPredictionJob was created.

.google.protobuf.Timestamp create_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
BatchPredictionJob.Builder

mergeDedicatedResources(BatchDedicatedResources value)

public BatchPredictionJob.Builder mergeDedicatedResources(BatchDedicatedResources value)

The config of resources used by the Model during the batch prediction. If the Model supports DEDICATED_RESOURCES this config may be provided (and the job will use these resources), if the Model doesn't support AUTOMATIC_RESOURCES, this config must be provided.

.google.cloud.aiplatform.v1.BatchDedicatedResources dedicated_resources = 7;

Parameter
Name Description
value BatchDedicatedResources
Returns
Type Description
BatchPredictionJob.Builder

mergeEncryptionSpec(EncryptionSpec value)

public BatchPredictionJob.Builder mergeEncryptionSpec(EncryptionSpec value)

Customer-managed encryption key options for a BatchPredictionJob. If this is set, then all resources created by the BatchPredictionJob will be encrypted with the provided encryption key.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 24;

Parameter
Name Description
value EncryptionSpec
Returns
Type Description
BatchPredictionJob.Builder

mergeEndTime(Timestamp value)

public BatchPredictionJob.Builder mergeEndTime(Timestamp value)

Output only. Time when the BatchPredictionJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.

.google.protobuf.Timestamp end_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
BatchPredictionJob.Builder

mergeError(Status value)

public BatchPredictionJob.Builder mergeError(Status value)

Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

.google.rpc.Status error = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value com.google.rpc.Status
Returns
Type Description
BatchPredictionJob.Builder

mergeExplanationSpec(ExplanationSpec value)

public BatchPredictionJob.Builder mergeExplanationSpec(ExplanationSpec value)

Explanation configuration for this BatchPredictionJob. Can be specified only if generate_explanation is set to true.

This value overrides the value of Model.explanation_spec. All fields of explanation_spec are optional in the request. If a field of the explanation_spec object is not populated, the corresponding field of the Model.explanation_spec object is inherited.

.google.cloud.aiplatform.v1.ExplanationSpec explanation_spec = 25;

Parameter
Name Description
value ExplanationSpec
Returns
Type Description
BatchPredictionJob.Builder

mergeFrom(BatchPredictionJob other)

public BatchPredictionJob.Builder mergeFrom(BatchPredictionJob other)
Parameter
Name Description
other BatchPredictionJob
Returns
Type Description
BatchPredictionJob.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BatchPredictionJob.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchPredictionJob.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public BatchPredictionJob.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
BatchPredictionJob.Builder
Overrides

mergeInputConfig(BatchPredictionJob.InputConfig value)

public BatchPredictionJob.Builder mergeInputConfig(BatchPredictionJob.InputConfig value)

Required. Input configuration of the instances on which predictions are performed. The schema of any single instance may be specified via the Model's PredictSchemata's instance_schema_uri.

.google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig input_config = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value BatchPredictionJob.InputConfig
Returns
Type Description
BatchPredictionJob.Builder

mergeInstanceConfig(BatchPredictionJob.InstanceConfig value)

public BatchPredictionJob.Builder mergeInstanceConfig(BatchPredictionJob.InstanceConfig value)

Configuration for how to convert batch prediction input instances to the prediction instances that are sent to the Model.

.google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig instance_config = 27;

Parameter
Name Description
value BatchPredictionJob.InstanceConfig
Returns
Type Description
BatchPredictionJob.Builder

mergeManualBatchTuningParameters(ManualBatchTuningParameters value)

public BatchPredictionJob.Builder mergeManualBatchTuningParameters(ManualBatchTuningParameters value)

Immutable. Parameters configuring the batch behavior. Currently only applicable when dedicated_resources are used (in other cases Vertex AI does the tuning itself).

.google.cloud.aiplatform.v1.ManualBatchTuningParameters manual_batch_tuning_parameters = 8 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value ManualBatchTuningParameters
Returns
Type Description
BatchPredictionJob.Builder

mergeModelParameters(Value value)

public BatchPredictionJob.Builder mergeModelParameters(Value value)

The parameters that govern the predictions. The schema of the parameters may be specified via the Model's PredictSchemata's parameters_schema_uri.

.google.protobuf.Value model_parameters = 5;

Parameter
Name Description
value Value
Returns
Type Description
BatchPredictionJob.Builder

mergeOutputConfig(BatchPredictionJob.OutputConfig value)

public BatchPredictionJob.Builder mergeOutputConfig(BatchPredictionJob.OutputConfig value)

Required. The Configuration specifying where output predictions should be written. The schema of any single prediction may be specified as a concatenation of Model's PredictSchemata's instance_schema_uri and prediction_schema_uri.

.google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value BatchPredictionJob.OutputConfig
Returns
Type Description
BatchPredictionJob.Builder

mergeOutputInfo(BatchPredictionJob.OutputInfo value)

public BatchPredictionJob.Builder mergeOutputInfo(BatchPredictionJob.OutputInfo value)

Output only. Information further describing the output of this job.

.google.cloud.aiplatform.v1.BatchPredictionJob.OutputInfo output_info = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value BatchPredictionJob.OutputInfo
Returns
Type Description
BatchPredictionJob.Builder

mergeResourcesConsumed(ResourcesConsumed value)

public BatchPredictionJob.Builder mergeResourcesConsumed(ResourcesConsumed value)

Output only. Information about resources that had been consumed by this job. Provided in real time at best effort basis, as well as a final value once the job completes.

Note: This field currently may be not populated for batch predictions that use AutoML Models.

.google.cloud.aiplatform.v1.ResourcesConsumed resources_consumed = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ResourcesConsumed
Returns
Type Description
BatchPredictionJob.Builder

mergeStartTime(Timestamp value)

public BatchPredictionJob.Builder mergeStartTime(Timestamp value)

Output only. Time when the BatchPredictionJob for the first time entered the JOB_STATE_RUNNING state.

.google.protobuf.Timestamp start_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
BatchPredictionJob.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BatchPredictionJob.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BatchPredictionJob.Builder
Overrides

mergeUnmanagedContainerModel(UnmanagedContainerModel value)

public BatchPredictionJob.Builder mergeUnmanagedContainerModel(UnmanagedContainerModel value)

Contains model information necessary to perform batch prediction without requiring uploading to model registry. Exactly one of model and unmanaged_container_model must be set.

.google.cloud.aiplatform.v1.UnmanagedContainerModel unmanaged_container_model = 28;

Parameter
Name Description
value UnmanagedContainerModel
Returns
Type Description
BatchPredictionJob.Builder

mergeUpdateTime(Timestamp value)

public BatchPredictionJob.Builder mergeUpdateTime(Timestamp value)

Output only. Time when the BatchPredictionJob was most recently updated.

.google.protobuf.Timestamp update_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
BatchPredictionJob.Builder

putAllLabels(Map<String,String> values)

public BatchPredictionJob.Builder putAllLabels(Map<String,String> values)

The labels with user-defined metadata to organize BatchPredictionJobs.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

map<string, string> labels = 19;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
BatchPredictionJob.Builder

putLabels(String key, String value)

public BatchPredictionJob.Builder putLabels(String key, String value)

The labels with user-defined metadata to organize BatchPredictionJobs.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

map<string, string> labels = 19;

Parameters
Name Description
key String
value String
Returns
Type Description
BatchPredictionJob.Builder

removeLabels(String key)

public BatchPredictionJob.Builder removeLabels(String key)

The labels with user-defined metadata to organize BatchPredictionJobs.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

map<string, string> labels = 19;

Parameter
Name Description
key String
Returns
Type Description
BatchPredictionJob.Builder

removePartialFailures(int index)

public BatchPredictionJob.Builder removePartialFailures(int index)

Output only. Partial failures encountered. For example, single files that can't be read. This field never exceeds 20 entries. Status details fields contain standard Google Cloud error details.

repeated .google.rpc.Status partial_failures = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
BatchPredictionJob.Builder

setCompletionStats(CompletionStats value)

public BatchPredictionJob.Builder setCompletionStats(CompletionStats value)

Output only. Statistics on completed and failed prediction instances.

.google.cloud.aiplatform.v1.CompletionStats completion_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value CompletionStats
Returns
Type Description
BatchPredictionJob.Builder

setCompletionStats(CompletionStats.Builder builderForValue)

public BatchPredictionJob.Builder setCompletionStats(CompletionStats.Builder builderForValue)

Output only. Statistics on completed and failed prediction instances.

.google.cloud.aiplatform.v1.CompletionStats completion_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue CompletionStats.Builder
Returns
Type Description
BatchPredictionJob.Builder

setCreateTime(Timestamp value)

public BatchPredictionJob.Builder setCreateTime(Timestamp value)

Output only. Time when the BatchPredictionJob was created.

.google.protobuf.Timestamp create_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
BatchPredictionJob.Builder

setCreateTime(Timestamp.Builder builderForValue)

public BatchPredictionJob.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Time when the BatchPredictionJob was created.

.google.protobuf.Timestamp create_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
BatchPredictionJob.Builder

setDedicatedResources(BatchDedicatedResources value)

public BatchPredictionJob.Builder setDedicatedResources(BatchDedicatedResources value)

The config of resources used by the Model during the batch prediction. If the Model supports DEDICATED_RESOURCES this config may be provided (and the job will use these resources), if the Model doesn't support AUTOMATIC_RESOURCES, this config must be provided.

.google.cloud.aiplatform.v1.BatchDedicatedResources dedicated_resources = 7;

Parameter
Name Description
value BatchDedicatedResources
Returns
Type Description
BatchPredictionJob.Builder

setDedicatedResources(BatchDedicatedResources.Builder builderForValue)

public BatchPredictionJob.Builder setDedicatedResources(BatchDedicatedResources.Builder builderForValue)

The config of resources used by the Model during the batch prediction. If the Model supports DEDICATED_RESOURCES this config may be provided (and the job will use these resources), if the Model doesn't support AUTOMATIC_RESOURCES, this config must be provided.

.google.cloud.aiplatform.v1.BatchDedicatedResources dedicated_resources = 7;

Parameter
Name Description
builderForValue BatchDedicatedResources.Builder
Returns
Type Description
BatchPredictionJob.Builder

setDisableContainerLogging(boolean value)

public BatchPredictionJob.Builder setDisableContainerLogging(boolean value)

For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send stderr and stdout streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to Cloud Logging pricing.

User can disable container logging by setting this flag to true.

bool disable_container_logging = 34;

Parameter
Name Description
value boolean

The disableContainerLogging to set.
Returns
Type Description
BatchPredictionJob.Builder

This builder for chaining.

setDisplayName(String value)

public BatchPredictionJob.Builder setDisplayName(String value)

Required. The user-defined name of this BatchPredictionJob.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
BatchPredictionJob.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public BatchPredictionJob.Builder setDisplayNameBytes(ByteString value)

Required. The user-defined name of this BatchPredictionJob.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
BatchPredictionJob.Builder

This builder for chaining.

setEncryptionSpec(EncryptionSpec value)

public BatchPredictionJob.Builder setEncryptionSpec(EncryptionSpec value)

Customer-managed encryption key options for a BatchPredictionJob. If this is set, then all resources created by the BatchPredictionJob will be encrypted with the provided encryption key.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 24;

Parameter
Name Description
value EncryptionSpec
Returns
Type Description
BatchPredictionJob.Builder

setEncryptionSpec(EncryptionSpec.Builder builderForValue)

public BatchPredictionJob.Builder setEncryptionSpec(EncryptionSpec.Builder builderForValue)

Customer-managed encryption key options for a BatchPredictionJob. If this is set, then all resources created by the BatchPredictionJob will be encrypted with the provided encryption key.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 24;

Parameter
Name Description
builderForValue EncryptionSpec.Builder
Returns
Type Description
BatchPredictionJob.Builder

setEndTime(Timestamp value)

public BatchPredictionJob.Builder setEndTime(Timestamp value)

Output only. Time when the BatchPredictionJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.

.google.protobuf.Timestamp end_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
BatchPredictionJob.Builder

setEndTime(Timestamp.Builder builderForValue)

public BatchPredictionJob.Builder setEndTime(Timestamp.Builder builderForValue)

Output only. Time when the BatchPredictionJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.

.google.protobuf.Timestamp end_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
BatchPredictionJob.Builder

setError(Status value)

public BatchPredictionJob.Builder setError(Status value)

Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

.google.rpc.Status error = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value com.google.rpc.Status
Returns
Type Description
BatchPredictionJob.Builder

setError(Status.Builder builderForValue)

public BatchPredictionJob.Builder setError(Status.Builder builderForValue)

Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

.google.rpc.Status error = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue com.google.rpc.Status.Builder
Returns
Type Description
BatchPredictionJob.Builder

setExplanationSpec(ExplanationSpec value)

public BatchPredictionJob.Builder setExplanationSpec(ExplanationSpec value)

Explanation configuration for this BatchPredictionJob. Can be specified only if generate_explanation is set to true.

This value overrides the value of Model.explanation_spec. All fields of explanation_spec are optional in the request. If a field of the explanation_spec object is not populated, the corresponding field of the Model.explanation_spec object is inherited.

.google.cloud.aiplatform.v1.ExplanationSpec explanation_spec = 25;

Parameter
Name Description
value ExplanationSpec
Returns
Type Description
BatchPredictionJob.Builder

setExplanationSpec(ExplanationSpec.Builder builderForValue)

public BatchPredictionJob.Builder setExplanationSpec(ExplanationSpec.Builder builderForValue)

Explanation configuration for this BatchPredictionJob. Can be specified only if generate_explanation is set to true.

This value overrides the value of Model.explanation_spec. All fields of explanation_spec are optional in the request. If a field of the explanation_spec object is not populated, the corresponding field of the Model.explanation_spec object is inherited.

.google.cloud.aiplatform.v1.ExplanationSpec explanation_spec = 25;

Parameter
Name Description
builderForValue ExplanationSpec.Builder
Returns
Type Description
BatchPredictionJob.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public BatchPredictionJob.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BatchPredictionJob.Builder
Overrides

setGenerateExplanation(boolean value)

public BatchPredictionJob.Builder setGenerateExplanation(boolean value)

Generate explanation with the batch prediction results.

When set to true, the batch prediction output changes based on the predictions_format field of the BatchPredictionJob.output_config object:

  • bigquery: output includes a column named explanation. The value is a struct that conforms to the Explanation object.
  • jsonl: The JSON objects on each line include an additional entry keyed explanation. The value of the entry is a JSON object that conforms to the Explanation object.

  • csv: Generating explanations for CSV format is not supported.

    If this field is set to true, either the Model.explanation_spec or explanation_spec must be populated.

bool generate_explanation = 23;

Parameter
Name Description
value boolean

The generateExplanation to set.
Returns
Type Description
BatchPredictionJob.Builder

This builder for chaining.

setInputConfig(BatchPredictionJob.InputConfig value)

public BatchPredictionJob.Builder setInputConfig(BatchPredictionJob.InputConfig value)

Required. Input configuration of the instances on which predictions are performed. The schema of any single instance may be specified via the Model's PredictSchemata's instance_schema_uri.

.google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig input_config = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value BatchPredictionJob.InputConfig
Returns
Type Description
BatchPredictionJob.Builder

setInputConfig(BatchPredictionJob.InputConfig.Builder builderForValue)

public BatchPredictionJob.Builder setInputConfig(BatchPredictionJob.InputConfig.Builder builderForValue)

Required. Input configuration of the instances on which predictions are performed. The schema of any single instance may be specified via the Model's PredictSchemata's instance_schema_uri.

.google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig input_config = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue BatchPredictionJob.InputConfig.Builder
Returns
Type Description
BatchPredictionJob.Builder

setInstanceConfig(BatchPredictionJob.InstanceConfig value)

public BatchPredictionJob.Builder setInstanceConfig(BatchPredictionJob.InstanceConfig value)

Configuration for how to convert batch prediction input instances to the prediction instances that are sent to the Model.

.google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig instance_config = 27;

Parameter
Name Description
value BatchPredictionJob.InstanceConfig
Returns
Type Description
BatchPredictionJob.Builder

setInstanceConfig(BatchPredictionJob.InstanceConfig.Builder builderForValue)

public BatchPredictionJob.Builder setInstanceConfig(BatchPredictionJob.InstanceConfig.Builder builderForValue)

Configuration for how to convert batch prediction input instances to the prediction instances that are sent to the Model.

.google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig instance_config = 27;

Parameter
Name Description
builderForValue BatchPredictionJob.InstanceConfig.Builder
Returns
Type Description
BatchPredictionJob.Builder

setManualBatchTuningParameters(ManualBatchTuningParameters value)

public BatchPredictionJob.Builder setManualBatchTuningParameters(ManualBatchTuningParameters value)

Immutable. Parameters configuring the batch behavior. Currently only applicable when dedicated_resources are used (in other cases Vertex AI does the tuning itself).

.google.cloud.aiplatform.v1.ManualBatchTuningParameters manual_batch_tuning_parameters = 8 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value ManualBatchTuningParameters
Returns
Type Description
BatchPredictionJob.Builder

setManualBatchTuningParameters(ManualBatchTuningParameters.Builder builderForValue)

public BatchPredictionJob.Builder setManualBatchTuningParameters(ManualBatchTuningParameters.Builder builderForValue)

Immutable. Parameters configuring the batch behavior. Currently only applicable when dedicated_resources are used (in other cases Vertex AI does the tuning itself).

.google.cloud.aiplatform.v1.ManualBatchTuningParameters manual_batch_tuning_parameters = 8 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
builderForValue ManualBatchTuningParameters.Builder
Returns
Type Description
BatchPredictionJob.Builder

setModel(String value)

public BatchPredictionJob.Builder setModel(String value)

The name of the Model resource that produces the predictions via this job, must share the same ancestor Location. Starting this job has no impact on any existing deployments of the Model and their resources. Exactly one of model and unmanaged_container_model must be set.

The model resource name may contain version id or version alias to specify the version. Example: projects/{project}/locations/{location}/models/{model}@2 or projects/{project}/locations/{location}/models/{model}@golden if no version is specified, the default version will be deployed.

The model resource could also be a publisher model. Example: publishers/{publisher}/models/{model} or projects/{project}/locations/{location}/publishers/{publisher}/models/{model}

string model = 3 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The model to set.
Returns
Type Description
BatchPredictionJob.Builder

This builder for chaining.

setModelBytes(ByteString value)

public BatchPredictionJob.Builder setModelBytes(ByteString value)

The name of the Model resource that produces the predictions via this job, must share the same ancestor Location. Starting this job has no impact on any existing deployments of the Model and their resources. Exactly one of model and unmanaged_container_model must be set.

The model resource name may contain version id or version alias to specify the version. Example: projects/{project}/locations/{location}/models/{model}@2 or projects/{project}/locations/{location}/models/{model}@golden if no version is specified, the default version will be deployed.

The model resource could also be a publisher model. Example: publishers/{publisher}/models/{model} or projects/{project}/locations/{location}/publishers/{publisher}/models/{model}

string model = 3 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for model to set.
Returns
Type Description
BatchPredictionJob.Builder

This builder for chaining.

setModelParameters(Value value)

public BatchPredictionJob.Builder setModelParameters(Value value)

The parameters that govern the predictions. The schema of the parameters may be specified via the Model's PredictSchemata's parameters_schema_uri.

.google.protobuf.Value model_parameters = 5;

Parameter
Name Description
value Value
Returns
Type Description
BatchPredictionJob.Builder

setModelParameters(Value.Builder builderForValue)

public BatchPredictionJob.Builder setModelParameters(Value.Builder builderForValue)

The parameters that govern the predictions. The schema of the parameters may be specified via the Model's PredictSchemata's parameters_schema_uri.

.google.protobuf.Value model_parameters = 5;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
BatchPredictionJob.Builder

setModelVersionId(String value)

public BatchPredictionJob.Builder setModelVersionId(String value)

Output only. The version ID of the Model that produces the predictions via this job.

string model_version_id = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The modelVersionId to set.
Returns
Type Description
BatchPredictionJob.Builder

This builder for chaining.

setModelVersionIdBytes(ByteString value)

public BatchPredictionJob.Builder setModelVersionIdBytes(ByteString value)

Output only. The version ID of the Model that produces the predictions via this job.

string model_version_id = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for modelVersionId to set.
Returns
Type Description
BatchPredictionJob.Builder

This builder for chaining.

setName(String value)

public BatchPredictionJob.Builder setName(String value)

Output only. Resource name of the BatchPredictionJob.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The name to set.
Returns
Type Description
BatchPredictionJob.Builder

This builder for chaining.

setNameBytes(ByteString value)

public BatchPredictionJob.Builder setNameBytes(ByteString value)

Output only. Resource name of the BatchPredictionJob.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
BatchPredictionJob.Builder

This builder for chaining.

setOutputConfig(BatchPredictionJob.OutputConfig value)

public BatchPredictionJob.Builder setOutputConfig(BatchPredictionJob.OutputConfig value)

Required. The Configuration specifying where output predictions should be written. The schema of any single prediction may be specified as a concatenation of Model's PredictSchemata's instance_schema_uri and prediction_schema_uri.

.google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value BatchPredictionJob.OutputConfig
Returns
Type Description
BatchPredictionJob.Builder

setOutputConfig(BatchPredictionJob.OutputConfig.Builder builderForValue)

public BatchPredictionJob.Builder setOutputConfig(BatchPredictionJob.OutputConfig.Builder builderForValue)

Required. The Configuration specifying where output predictions should be written. The schema of any single prediction may be specified as a concatenation of Model's PredictSchemata's instance_schema_uri and prediction_schema_uri.

.google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue BatchPredictionJob.OutputConfig.Builder
Returns
Type Description
BatchPredictionJob.Builder

setOutputInfo(BatchPredictionJob.OutputInfo value)

public BatchPredictionJob.Builder setOutputInfo(BatchPredictionJob.OutputInfo value)

Output only. Information further describing the output of this job.

.google.cloud.aiplatform.v1.BatchPredictionJob.OutputInfo output_info = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value BatchPredictionJob.OutputInfo
Returns
Type Description
BatchPredictionJob.Builder

setOutputInfo(BatchPredictionJob.OutputInfo.Builder builderForValue)

public BatchPredictionJob.Builder setOutputInfo(BatchPredictionJob.OutputInfo.Builder builderForValue)

Output only. Information further describing the output of this job.

.google.cloud.aiplatform.v1.BatchPredictionJob.OutputInfo output_info = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue BatchPredictionJob.OutputInfo.Builder
Returns
Type Description
BatchPredictionJob.Builder

setPartialFailures(int index, Status value)

public BatchPredictionJob.Builder setPartialFailures(int index, Status value)

Output only. Partial failures encountered. For example, single files that can't be read. This field never exceeds 20 entries. Status details fields contain standard Google Cloud error details.

repeated .google.rpc.Status partial_failures = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value com.google.rpc.Status
Returns
Type Description
BatchPredictionJob.Builder

setPartialFailures(int index, Status.Builder builderForValue)

public BatchPredictionJob.Builder setPartialFailures(int index, Status.Builder builderForValue)

Output only. Partial failures encountered. For example, single files that can't be read. This field never exceeds 20 entries. Status details fields contain standard Google Cloud error details.

repeated .google.rpc.Status partial_failures = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue com.google.rpc.Status.Builder
Returns
Type Description
BatchPredictionJob.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public BatchPredictionJob.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
BatchPredictionJob.Builder
Overrides

setResourcesConsumed(ResourcesConsumed value)

public BatchPredictionJob.Builder setResourcesConsumed(ResourcesConsumed value)

Output only. Information about resources that had been consumed by this job. Provided in real time at best effort basis, as well as a final value once the job completes.

Note: This field currently may be not populated for batch predictions that use AutoML Models.

.google.cloud.aiplatform.v1.ResourcesConsumed resources_consumed = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ResourcesConsumed
Returns
Type Description
BatchPredictionJob.Builder

setResourcesConsumed(ResourcesConsumed.Builder builderForValue)

public BatchPredictionJob.Builder setResourcesConsumed(ResourcesConsumed.Builder builderForValue)

Output only. Information about resources that had been consumed by this job. Provided in real time at best effort basis, as well as a final value once the job completes.

Note: This field currently may be not populated for batch predictions that use AutoML Models.

.google.cloud.aiplatform.v1.ResourcesConsumed resources_consumed = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue ResourcesConsumed.Builder
Returns
Type Description
BatchPredictionJob.Builder

setServiceAccount(String value)

public BatchPredictionJob.Builder setServiceAccount(String value)

The service account that the DeployedModel's container runs as. If not specified, a system generated one will be used, which has minimal permissions and the custom container, if used, may not have enough permission to access other Google Cloud resources.

Users deploying the Model must have the iam.serviceAccounts.actAs permission on this service account.

string service_account = 29;

Parameter
Name Description
value String

The serviceAccount to set.
Returns
Type Description
BatchPredictionJob.Builder

This builder for chaining.

setServiceAccountBytes(ByteString value)

public BatchPredictionJob.Builder setServiceAccountBytes(ByteString value)

The service account that the DeployedModel's container runs as. If not specified, a system generated one will be used, which has minimal permissions and the custom container, if used, may not have enough permission to access other Google Cloud resources.

Users deploying the Model must have the iam.serviceAccounts.actAs permission on this service account.

string service_account = 29;

Parameter
Name Description
value ByteString

The bytes for serviceAccount to set.
Returns
Type Description
BatchPredictionJob.Builder

This builder for chaining.

setStartTime(Timestamp value)

public BatchPredictionJob.Builder setStartTime(Timestamp value)

Output only. Time when the BatchPredictionJob for the first time entered the JOB_STATE_RUNNING state.

.google.protobuf.Timestamp start_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
BatchPredictionJob.Builder

setStartTime(Timestamp.Builder builderForValue)

public BatchPredictionJob.Builder setStartTime(Timestamp.Builder builderForValue)

Output only. Time when the BatchPredictionJob for the first time entered the JOB_STATE_RUNNING state.

.google.protobuf.Timestamp start_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
BatchPredictionJob.Builder

setState(JobState value)

public BatchPredictionJob.Builder setState(JobState value)

Output only. The detailed state of the job.

.google.cloud.aiplatform.v1.JobState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value JobState

The state to set.
Returns
Type Description
BatchPredictionJob.Builder

This builder for chaining.

setStateValue(int value)

public BatchPredictionJob.Builder setStateValue(int value)

Output only. The detailed state of the job.

.google.cloud.aiplatform.v1.JobState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
BatchPredictionJob.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final BatchPredictionJob.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BatchPredictionJob.Builder
Overrides

setUnmanagedContainerModel(UnmanagedContainerModel value)

public BatchPredictionJob.Builder setUnmanagedContainerModel(UnmanagedContainerModel value)

Contains model information necessary to perform batch prediction without requiring uploading to model registry. Exactly one of model and unmanaged_container_model must be set.

.google.cloud.aiplatform.v1.UnmanagedContainerModel unmanaged_container_model = 28;

Parameter
Name Description
value UnmanagedContainerModel
Returns
Type Description
BatchPredictionJob.Builder

setUnmanagedContainerModel(UnmanagedContainerModel.Builder builderForValue)

public BatchPredictionJob.Builder setUnmanagedContainerModel(UnmanagedContainerModel.Builder builderForValue)

Contains model information necessary to perform batch prediction without requiring uploading to model registry. Exactly one of model and unmanaged_container_model must be set.

.google.cloud.aiplatform.v1.UnmanagedContainerModel unmanaged_container_model = 28;

Parameter
Name Description
builderForValue UnmanagedContainerModel.Builder
Returns
Type Description
BatchPredictionJob.Builder

setUpdateTime(Timestamp value)

public BatchPredictionJob.Builder setUpdateTime(Timestamp value)

Output only. Time when the BatchPredictionJob was most recently updated.

.google.protobuf.Timestamp update_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
BatchPredictionJob.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public BatchPredictionJob.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Time when the BatchPredictionJob was most recently updated.

.google.protobuf.Timestamp update_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
BatchPredictionJob.Builder