com.google.cloud.aiplatform.v1beta1

Interface BatchPredictionJobOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

BatchPredictionJob, BatchPredictionJob.Builder

public interface BatchPredictionJobOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) The labels with user-defined metadata to organize BatchPredictionJobs.
CompletionStats	getCompletionStats() Output only.
CompletionStatsOrBuilder	getCompletionStatsOrBuilder() Output only.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
BatchDedicatedResources	getDedicatedResources() The config of resources used by the Model during the batch prediction.
BatchDedicatedResourcesOrBuilder	getDedicatedResourcesOrBuilder() The config of resources used by the Model during the batch prediction.
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.
String	getDisplayName() Required.
com.google.protobuf.ByteString	getDisplayNameBytes() Required.
EncryptionSpec	getEncryptionSpec() Customer-managed encryption key options for a BatchPredictionJob.
EncryptionSpecOrBuilder	getEncryptionSpecOrBuilder() Customer-managed encryption key options for a BatchPredictionJob.
com.google.protobuf.Timestamp	getEndTime() Output only.
com.google.protobuf.TimestampOrBuilder	getEndTimeOrBuilder() Output only.
com.google.rpc.Status	getError() Output only.
com.google.rpc.StatusOrBuilder	getErrorOrBuilder() Output only.
ExplanationSpec	getExplanationSpec() Explanation configuration for this BatchPredictionJob.
ExplanationSpecOrBuilder	getExplanationSpecOrBuilder() Explanation configuration for this BatchPredictionJob.
boolean	getGenerateExplanation() Generate explanation with the batch prediction results.
BatchPredictionJob.InputConfig	getInputConfig() Required.
BatchPredictionJob.InputConfigOrBuilder	getInputConfigOrBuilder() Required.
BatchPredictionJob.InstanceConfig	getInstanceConfig() Configuration for how to convert batch prediction input instances to the prediction instances that are sent to the Model.
BatchPredictionJob.InstanceConfigOrBuilder	getInstanceConfigOrBuilder() Configuration for how to convert batch prediction input instances to the prediction instances that are sent to the Model.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() The labels with user-defined metadata to organize BatchPredictionJobs.
Map<String,String>	getLabelsMap() The labels with user-defined metadata to organize BatchPredictionJobs.
String	getLabelsOrDefault(String key, String defaultValue) The labels with user-defined metadata to organize BatchPredictionJobs.
String	getLabelsOrThrow(String key) The labels with user-defined metadata to organize BatchPredictionJobs.
ManualBatchTuningParameters	getManualBatchTuningParameters() Immutable.
ManualBatchTuningParametersOrBuilder	getManualBatchTuningParametersOrBuilder() Immutable.
String	getModel() The name of the Model resource that produces the predictions via this job, must share the same ancestor Location.
com.google.protobuf.ByteString	getModelBytes() The name of the Model resource that produces the predictions via this job, must share the same ancestor Location.
ModelMonitoringConfig	getModelMonitoringConfig() Model monitoring config will be used for analysis model behaviors, based on the input and output to the batch prediction job, as well as the provided training dataset.
ModelMonitoringConfigOrBuilder	getModelMonitoringConfigOrBuilder() Model monitoring config will be used for analysis model behaviors, based on the input and output to the batch prediction job, as well as the provided training dataset.
ModelMonitoringStatsAnomalies	getModelMonitoringStatsAnomalies(int index) Get batch prediction job monitoring statistics.
int	getModelMonitoringStatsAnomaliesCount() Get batch prediction job monitoring statistics.
List<ModelMonitoringStatsAnomalies>	getModelMonitoringStatsAnomaliesList() Get batch prediction job monitoring statistics.
ModelMonitoringStatsAnomaliesOrBuilder	getModelMonitoringStatsAnomaliesOrBuilder(int index) Get batch prediction job monitoring statistics.
List<? extends ModelMonitoringStatsAnomaliesOrBuilder>	getModelMonitoringStatsAnomaliesOrBuilderList() Get batch prediction job monitoring statistics.
com.google.rpc.Status	getModelMonitoringStatus() Output only.
com.google.rpc.StatusOrBuilder	getModelMonitoringStatusOrBuilder() Output only.
com.google.protobuf.Value	getModelParameters() The parameters that govern the predictions.
com.google.protobuf.ValueOrBuilder	getModelParametersOrBuilder() The parameters that govern the predictions.
String	getModelVersionId() Output only.
com.google.protobuf.ByteString	getModelVersionIdBytes() Output only.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
BatchPredictionJob.OutputConfig	getOutputConfig() Required.
BatchPredictionJob.OutputConfigOrBuilder	getOutputConfigOrBuilder() Required.
BatchPredictionJob.OutputInfo	getOutputInfo() Output only.
BatchPredictionJob.OutputInfoOrBuilder	getOutputInfoOrBuilder() Output only.
com.google.rpc.Status	getPartialFailures(int index) Output only.
int	getPartialFailuresCount() Output only.
List<com.google.rpc.Status>	getPartialFailuresList() Output only.
com.google.rpc.StatusOrBuilder	getPartialFailuresOrBuilder(int index) Output only.
List<? extends com.google.rpc.StatusOrBuilder>	getPartialFailuresOrBuilderList() Output only.
ResourcesConsumed	getResourcesConsumed() Output only.
ResourcesConsumedOrBuilder	getResourcesConsumedOrBuilder() Output only.
String	getServiceAccount() The service account that the DeployedModel's container runs as.
com.google.protobuf.ByteString	getServiceAccountBytes() The service account that the DeployedModel's container runs as.
com.google.protobuf.Timestamp	getStartTime() Output only.
com.google.protobuf.TimestampOrBuilder	getStartTimeOrBuilder() Output only.
JobState	getState() Output only.
int	getStateValue() Output only.
UnmanagedContainerModel	getUnmanagedContainerModel() Contains model information necessary to perform batch prediction without requiring uploading to model registry.
UnmanagedContainerModelOrBuilder	getUnmanagedContainerModelOrBuilder() Contains model information necessary to perform batch prediction without requiring uploading to model registry.
com.google.protobuf.Timestamp	getUpdateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
boolean	hasCompletionStats() Output only.
boolean	hasCreateTime() Output only.
boolean	hasDedicatedResources() The config of resources used by the Model during the batch prediction.
boolean	hasEncryptionSpec() Customer-managed encryption key options for a BatchPredictionJob.
boolean	hasEndTime() Output only.
boolean	hasError() Output only.
boolean	hasExplanationSpec() Explanation configuration for this BatchPredictionJob.
boolean	hasInputConfig() Required.
boolean	hasInstanceConfig() Configuration for how to convert batch prediction input instances to the prediction instances that are sent to the Model.
boolean	hasManualBatchTuningParameters() Immutable.
boolean	hasModelMonitoringConfig() Model monitoring config will be used for analysis model behaviors, based on the input and output to the batch prediction job, as well as the provided training dataset.
boolean	hasModelMonitoringStatus() Output only.
boolean	hasModelParameters() The parameters that govern the predictions.
boolean	hasOutputConfig() Required.
boolean	hasOutputInfo() Output only.
boolean	hasResourcesConsumed() Output only.
boolean	hasStartTime() Output only.
boolean	hasUnmanagedContainerModel() Contains model information necessary to perform batch prediction without requiring uploading to model registry.
boolean	hasUpdateTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 Output only. Resource name of the BatchPredictionJob.
 

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

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Output only. Resource name of the BatchPredictionJob.
 

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

Returns:

The bytes for name.

getDisplayName

String getDisplayName()

 Required. The user-defined name of this BatchPredictionJob.
 

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

Returns:

The displayName.

getDisplayNameBytes

com.google.protobuf.ByteString getDisplayNameBytes()

 Required. The user-defined name of this BatchPredictionJob.
 

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

Returns:

The bytes for displayName.

getModel

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:

The model.

getModelBytes

com.google.protobuf.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:

The bytes for model.

getModelVersionId

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:

The modelVersionId.

getModelVersionIdBytes

com.google.protobuf.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:

The bytes for modelVersionId.

hasUnmanagedContainerModel

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.v1beta1.UnmanagedContainerModel unmanaged_container_model = 28;

Returns:

Whether the unmanagedContainerModel field is set.

getUnmanagedContainerModel

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.v1beta1.UnmanagedContainerModel unmanaged_container_model = 28;

Returns:

The unmanagedContainerModel.

getUnmanagedContainerModelOrBuilder

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.v1beta1.UnmanagedContainerModel unmanaged_container_model = 28;

hasInputConfig

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][google.cloud.aiplatform.v1beta1.BatchPredictionJob.model]
 [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri].
 

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

Returns:

Whether the inputConfig field is set.

getInputConfig

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][google.cloud.aiplatform.v1beta1.BatchPredictionJob.model]
 [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri].
 

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

Returns:

The inputConfig.

getInputConfigOrBuilder

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][google.cloud.aiplatform.v1beta1.BatchPredictionJob.model]
 [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri].
 

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

hasInstanceConfig

boolean hasInstanceConfig()

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

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

Returns:

Whether the instanceConfig field is set.

getInstanceConfig

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.v1beta1.BatchPredictionJob.InstanceConfig instance_config = 27;

Returns:

The instanceConfig.

getInstanceConfigOrBuilder

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.v1beta1.BatchPredictionJob.InstanceConfig instance_config = 27;

hasModelParameters

boolean hasModelParameters()

 The parameters that govern the predictions. The schema of the parameters
 may be specified via the
 [Model's][google.cloud.aiplatform.v1beta1.BatchPredictionJob.model]
 [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata]
 [parameters_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri].
 

.google.protobuf.Value model_parameters = 5;

Returns:

Whether the modelParameters field is set.

getModelParameters

com.google.protobuf.Value getModelParameters()

 The parameters that govern the predictions. The schema of the parameters
 may be specified via the
 [Model's][google.cloud.aiplatform.v1beta1.BatchPredictionJob.model]
 [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata]
 [parameters_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri].
 

.google.protobuf.Value model_parameters = 5;

Returns:

The modelParameters.

getModelParametersOrBuilder

com.google.protobuf.ValueOrBuilder getModelParametersOrBuilder()

 The parameters that govern the predictions. The schema of the parameters
 may be specified via the
 [Model's][google.cloud.aiplatform.v1beta1.BatchPredictionJob.model]
 [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata]
 [parameters_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri].
 

.google.protobuf.Value model_parameters = 5;

hasOutputConfig

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][google.cloud.aiplatform.v1beta1.BatchPredictionJob.model]
 [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri]
 and
 [prediction_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.prediction_schema_uri].
 

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

Returns:

Whether the outputConfig field is set.

getOutputConfig

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][google.cloud.aiplatform.v1beta1.BatchPredictionJob.model]
 [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri]
 and
 [prediction_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.prediction_schema_uri].
 

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

Returns:

The outputConfig.

getOutputConfigOrBuilder

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][google.cloud.aiplatform.v1beta1.BatchPredictionJob.model]
 [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri]
 and
 [prediction_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.prediction_schema_uri].
 

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

hasDedicatedResources

boolean hasDedicatedResources()

 The config of resources used by the Model during the batch prediction. If
 the Model
 [supports][google.cloud.aiplatform.v1beta1.Model.supported_deployment_resources_types]
 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.v1beta1.BatchDedicatedResources dedicated_resources = 7;

Returns:

Whether the dedicatedResources field is set.

getDedicatedResources

BatchDedicatedResources getDedicatedResources()

 The config of resources used by the Model during the batch prediction. If
 the Model
 [supports][google.cloud.aiplatform.v1beta1.Model.supported_deployment_resources_types]
 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.v1beta1.BatchDedicatedResources dedicated_resources = 7;

Returns:

The dedicatedResources.

getDedicatedResourcesOrBuilder

BatchDedicatedResourcesOrBuilder getDedicatedResourcesOrBuilder()

 The config of resources used by the Model during the batch prediction. If
 the Model
 [supports][google.cloud.aiplatform.v1beta1.Model.supported_deployment_resources_types]
 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.v1beta1.BatchDedicatedResources dedicated_resources = 7;

getServiceAccount

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:

The serviceAccount.

getServiceAccountBytes

com.google.protobuf.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:

The bytes for serviceAccount.

hasManualBatchTuningParameters

boolean hasManualBatchTuningParameters()

 Immutable. Parameters configuring the batch behavior. Currently only
 applicable when
 [dedicated_resources][google.cloud.aiplatform.v1beta1.BatchPredictionJob.dedicated_resources]
 are used (in other cases Vertex AI does the tuning itself).
 

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

Returns:

Whether the manualBatchTuningParameters field is set.

getManualBatchTuningParameters

ManualBatchTuningParameters getManualBatchTuningParameters()

 Immutable. Parameters configuring the batch behavior. Currently only
 applicable when
 [dedicated_resources][google.cloud.aiplatform.v1beta1.BatchPredictionJob.dedicated_resources]
 are used (in other cases Vertex AI does the tuning itself).
 

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

Returns:

The manualBatchTuningParameters.

getManualBatchTuningParametersOrBuilder

ManualBatchTuningParametersOrBuilder getManualBatchTuningParametersOrBuilder()

 Immutable. Parameters configuring the batch behavior. Currently only
 applicable when
 [dedicated_resources][google.cloud.aiplatform.v1beta1.BatchPredictionJob.dedicated_resources]
 are used (in other cases Vertex AI does the tuning itself).
 

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

getGenerateExplanation

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][google.cloud.aiplatform.v1beta1.BatchPredictionJob.output_config]
 object:

  * `bigquery`: output includes a column named `explanation`. The value
    is a struct that conforms to the
    [Explanation][google.cloud.aiplatform.v1beta1.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][google.cloud.aiplatform.v1beta1.Explanation] object.
  * `csv`: Generating explanations for CSV format is not supported.

 If this field is set to true, either the
 [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec]
 or
 [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec]
 must be populated.
 

bool generate_explanation = 23;

Returns:

The generateExplanation.

hasExplanationSpec

boolean hasExplanationSpec()

 Explanation configuration for this BatchPredictionJob. Can be
 specified only if
 [generate_explanation][google.cloud.aiplatform.v1beta1.BatchPredictionJob.generate_explanation]
 is set to `true`.

 This value overrides the value of
 [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec].
 All fields of
 [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec]
 are optional in the request. If a field of the
 [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec]
 object is not populated, the corresponding field of the
 [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec]
 object is inherited.
 

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

Returns:

Whether the explanationSpec field is set.

getExplanationSpec

ExplanationSpec getExplanationSpec()

 Explanation configuration for this BatchPredictionJob. Can be
 specified only if
 [generate_explanation][google.cloud.aiplatform.v1beta1.BatchPredictionJob.generate_explanation]
 is set to `true`.

 This value overrides the value of
 [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec].
 All fields of
 [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec]
 are optional in the request. If a field of the
 [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec]
 object is not populated, the corresponding field of the
 [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec]
 object is inherited.
 

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

Returns:

The explanationSpec.

getExplanationSpecOrBuilder

ExplanationSpecOrBuilder getExplanationSpecOrBuilder()

 Explanation configuration for this BatchPredictionJob. Can be
 specified only if
 [generate_explanation][google.cloud.aiplatform.v1beta1.BatchPredictionJob.generate_explanation]
 is set to `true`.

 This value overrides the value of
 [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec].
 All fields of
 [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec]
 are optional in the request. If a field of the
 [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec]
 object is not populated, the corresponding field of the
 [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec]
 object is inherited.
 

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

hasOutputInfo

boolean hasOutputInfo()

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

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

Returns:

Whether the outputInfo field is set.

getOutputInfo

BatchPredictionJob.OutputInfo getOutputInfo()

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

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

Returns:

The outputInfo.

getOutputInfoOrBuilder

BatchPredictionJob.OutputInfoOrBuilder getOutputInfoOrBuilder()

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

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

getStateValue

int getStateValue()

 Output only. The detailed state of the job.
 

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

Returns:

The enum numeric value on the wire for state.

getState

JobState getState()

 Output only. The detailed state of the job.
 

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

Returns:

The state.

hasError

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:

Whether the error field is set.

getError

com.google.rpc.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:

The error.

getErrorOrBuilder

com.google.rpc.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];

getPartialFailuresList

List<com.google.rpc.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];

getPartialFailures

com.google.rpc.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];

getPartialFailuresCount

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

getPartialFailuresOrBuilderList

List<? extends com.google.rpc.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];

getPartialFailuresOrBuilder

com.google.rpc.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];

hasResourcesConsumed

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.v1beta1.ResourcesConsumed resources_consumed = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the resourcesConsumed field is set.

getResourcesConsumed

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.v1beta1.ResourcesConsumed resources_consumed = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The resourcesConsumed.

getResourcesConsumedOrBuilder

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.v1beta1.ResourcesConsumed resources_consumed = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasCompletionStats

boolean hasCompletionStats()

 Output only. Statistics on completed and failed prediction instances.
 

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

Returns:

Whether the completionStats field is set.

getCompletionStats

CompletionStats getCompletionStats()

 Output only. Statistics on completed and failed prediction instances.
 

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

Returns:

The completionStats.

getCompletionStatsOrBuilder

CompletionStatsOrBuilder getCompletionStatsOrBuilder()

 Output only. Statistics on completed and failed prediction instances.
 

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

hasCreateTime

boolean hasCreateTime()

 Output only. Time when the BatchPredictionJob was created.
 

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

Returns:

Whether the createTime field is set.

getCreateTime

com.google.protobuf.Timestamp getCreateTime()

 Output only. Time when the BatchPredictionJob was created.
 

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

Returns:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Time when the BatchPredictionJob was created.
 

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

hasStartTime

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:

Whether the startTime field is set.

getStartTime

com.google.protobuf.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:

The startTime.

getStartTimeOrBuilder

com.google.protobuf.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];

hasEndTime

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:

Whether the endTime field is set.

getEndTime

com.google.protobuf.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:

The endTime.

getEndTimeOrBuilder

com.google.protobuf.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];

hasUpdateTime

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:

Whether the updateTime field is set.

getUpdateTime

com.google.protobuf.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:

The updateTime.

getUpdateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

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

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

getLabelsCount

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;

containsLabels

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;

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

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;

getLabelsOrDefault

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;

getLabelsOrThrow

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;

hasEncryptionSpec

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.v1beta1.EncryptionSpec encryption_spec = 24;

Returns:

Whether the encryptionSpec field is set.

getEncryptionSpec

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.v1beta1.EncryptionSpec encryption_spec = 24;

Returns:

The encryptionSpec.

getEncryptionSpecOrBuilder

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.v1beta1.EncryptionSpec encryption_spec = 24;

hasModelMonitoringConfig

boolean hasModelMonitoringConfig()

 Model monitoring config will be used for analysis model behaviors, based on
 the input and output to the batch prediction job, as well as the provided
 training dataset.
 

.google.cloud.aiplatform.v1beta1.ModelMonitoringConfig model_monitoring_config = 26;

Returns:

Whether the modelMonitoringConfig field is set.

getModelMonitoringConfig

ModelMonitoringConfig getModelMonitoringConfig()

 Model monitoring config will be used for analysis model behaviors, based on
 the input and output to the batch prediction job, as well as the provided
 training dataset.
 

.google.cloud.aiplatform.v1beta1.ModelMonitoringConfig model_monitoring_config = 26;

Returns:

The modelMonitoringConfig.

getModelMonitoringConfigOrBuilder

ModelMonitoringConfigOrBuilder getModelMonitoringConfigOrBuilder()

 Model monitoring config will be used for analysis model behaviors, based on
 the input and output to the batch prediction job, as well as the provided
 training dataset.
 

.google.cloud.aiplatform.v1beta1.ModelMonitoringConfig model_monitoring_config = 26;

getModelMonitoringStatsAnomaliesList

List<ModelMonitoringStatsAnomalies> getModelMonitoringStatsAnomaliesList()

 Get batch prediction job monitoring statistics.
 

repeated .google.cloud.aiplatform.v1beta1.ModelMonitoringStatsAnomalies model_monitoring_stats_anomalies = 31;

getModelMonitoringStatsAnomalies

ModelMonitoringStatsAnomalies getModelMonitoringStatsAnomalies(int index)

 Get batch prediction job monitoring statistics.
 

repeated .google.cloud.aiplatform.v1beta1.ModelMonitoringStatsAnomalies model_monitoring_stats_anomalies = 31;

getModelMonitoringStatsAnomaliesCount

int getModelMonitoringStatsAnomaliesCount()

 Get batch prediction job monitoring statistics.
 

repeated .google.cloud.aiplatform.v1beta1.ModelMonitoringStatsAnomalies model_monitoring_stats_anomalies = 31;

getModelMonitoringStatsAnomaliesOrBuilderList

List<? extends ModelMonitoringStatsAnomaliesOrBuilder> getModelMonitoringStatsAnomaliesOrBuilderList()

 Get batch prediction job monitoring statistics.
 

repeated .google.cloud.aiplatform.v1beta1.ModelMonitoringStatsAnomalies model_monitoring_stats_anomalies = 31;

getModelMonitoringStatsAnomaliesOrBuilder

ModelMonitoringStatsAnomaliesOrBuilder getModelMonitoringStatsAnomaliesOrBuilder(int index)

 Get batch prediction job monitoring statistics.
 

repeated .google.cloud.aiplatform.v1beta1.ModelMonitoringStatsAnomalies model_monitoring_stats_anomalies = 31;

hasModelMonitoringStatus

boolean hasModelMonitoringStatus()

 Output only. The running status of the model monitoring pipeline.
 

.google.rpc.Status model_monitoring_status = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the modelMonitoringStatus field is set.

getModelMonitoringStatus

com.google.rpc.Status getModelMonitoringStatus()

 Output only. The running status of the model monitoring pipeline.
 

.google.rpc.Status model_monitoring_status = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The modelMonitoringStatus.

getModelMonitoringStatusOrBuilder

com.google.rpc.StatusOrBuilder getModelMonitoringStatusOrBuilder()

 Output only. The running status of the model monitoring pipeline.
 

.google.rpc.Status model_monitoring_status = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];

getDisableContainerLogging

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](https://cloud.google.com/logging/pricing).

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

bool disable_container_logging = 34;

Returns:

The disableContainerLogging.