Package com.google.cloud.aiplatform.v1

Class BatchPredictionJob

  • All Implemented Interfaces:
    BatchPredictionJobOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class BatchPredictionJob
extends com.google.protobuf.GeneratedMessageV3
implements BatchPredictionJobOrBuilder
     A job that uses a
 [Model][google.cloud.aiplatform.v1.BatchPredictionJob.model] to produce
 predictions on multiple [input
 instances][google.cloud.aiplatform.v1.BatchPredictionJob.input_config]. 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
    See Also:
    Serialized Form

    • Field Detail

      • DISPLAY_NAME_FIELD_NUMBER

        public static final int DISPLAY_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MODEL_VERSION_ID_FIELD_NUMBER

        public static final int MODEL_VERSION_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UNMANAGED_CONTAINER_MODEL_FIELD_NUMBER

        public static final int UNMANAGED_CONTAINER_MODEL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INPUT_CONFIG_FIELD_NUMBER

        public static final int INPUT_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INSTANCE_CONFIG_FIELD_NUMBER

        public static final int INSTANCE_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MODEL_PARAMETERS_FIELD_NUMBER

        public static final int MODEL_PARAMETERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • OUTPUT_CONFIG_FIELD_NUMBER

        public static final int OUTPUT_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DEDICATED_RESOURCES_FIELD_NUMBER

        public static final int DEDICATED_RESOURCES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SERVICE_ACCOUNT_FIELD_NUMBER

        public static final int SERVICE_ACCOUNT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MANUAL_BATCH_TUNING_PARAMETERS_FIELD_NUMBER

        public static final int MANUAL_BATCH_TUNING_PARAMETERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • GENERATE_EXPLANATION_FIELD_NUMBER

        public static final int GENERATE_EXPLANATION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXPLANATION_SPEC_FIELD_NUMBER

        public static final int EXPLANATION_SPEC_FIELD_NUMBER
        See Also:
        Constant Field Values

      • OUTPUT_INFO_FIELD_NUMBER

        public static final int OUTPUT_INFO_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PARTIAL_FAILURES_FIELD_NUMBER

        public static final int PARTIAL_FAILURES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RESOURCES_CONSUMED_FIELD_NUMBER

        public static final int RESOURCES_CONSUMED_FIELD_NUMBER
        See Also:
        Constant Field Values

      • COMPLETION_STATS_FIELD_NUMBER

        public static final int COMPLETION_STATS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CREATE_TIME_FIELD_NUMBER

        public static final int CREATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • START_TIME_FIELD_NUMBER

        public static final int START_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UPDATE_TIME_FIELD_NUMBER

        public static final int UPDATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENCRYPTION_SPEC_FIELD_NUMBER

        public static final int ENCRYPTION_SPEC_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DISABLE_CONTAINER_LOGGING_FIELD_NUMBER

        public static final int DISABLE_CONTAINER_LOGGING_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

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

      • getName

        public String getName()
         Output only. Resource name of the BatchPredictionJob.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface BatchPredictionJobOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. Resource name of the BatchPredictionJob.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface BatchPredictionJobOrBuilder
        Returns:
        The bytes for name.

      • getDisplayName

        public String getDisplayName()
         Required. The user-defined name of this BatchPredictionJob.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDisplayName in interface BatchPredictionJobOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         Required. The user-defined name of this BatchPredictionJob.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDisplayNameBytes in interface BatchPredictionJobOrBuilder
        Returns:
        The bytes for displayName.

      • 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) = { ... }
        Specified by:
        getModel in interface BatchPredictionJobOrBuilder
        Returns:
        The model.

      • getModelBytes

        public 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) = { ... }
        Specified by:
        getModelBytes in interface BatchPredictionJobOrBuilder
        Returns:
        The bytes for model.

      • 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];
        Specified by:
        getModelVersionId in interface BatchPredictionJobOrBuilder
        Returns:
        The modelVersionId.

      • getModelVersionIdBytes

        public 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];
        Specified by:
        getModelVersionIdBytes in interface BatchPredictionJobOrBuilder
        Returns:
        The bytes for modelVersionId.

      • 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;
        Specified by:
        hasUnmanagedContainerModel in interface BatchPredictionJobOrBuilder
        Returns:
        Whether the unmanagedContainerModel field is set.

      • 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;
        Specified by:
        getUnmanagedContainerModel in interface BatchPredictionJobOrBuilder
        Returns:
        The unmanagedContainerModel.

      • 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;
        Specified by:
        getUnmanagedContainerModelOrBuilder in interface BatchPredictionJobOrBuilder

      • 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][google.cloud.aiplatform.v1.BatchPredictionJob.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
        .google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig input_config = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasInputConfig in interface BatchPredictionJobOrBuilder
        Returns:
        Whether the inputConfig field is set.

      • 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][google.cloud.aiplatform.v1.BatchPredictionJob.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
        .google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig input_config = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getInputConfig in interface BatchPredictionJobOrBuilder
        Returns:
        The inputConfig.

      • 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][google.cloud.aiplatform.v1.BatchPredictionJob.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri].
        .google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig input_config = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getInputConfigOrBuilder in interface BatchPredictionJobOrBuilder

      • 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;
        Specified by:
        hasInstanceConfig in interface BatchPredictionJobOrBuilder
        Returns:
        Whether the instanceConfig field is set.

      • 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;
        Specified by:
        getInstanceConfig in interface BatchPredictionJobOrBuilder
        Returns:
        The instanceConfig.

      • hasModelParameters

        public boolean hasModelParameters()
         The parameters that govern the predictions. The schema of the parameters
 may be specified via the
 [Model's][google.cloud.aiplatform.v1.BatchPredictionJob.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [parameters_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri].
        .google.protobuf.Value model_parameters = 5;
        Specified by:
        hasModelParameters in interface BatchPredictionJobOrBuilder
        Returns:
        Whether the modelParameters field is set.

      • getModelParameters

        public 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.v1.BatchPredictionJob.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [parameters_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri].
        .google.protobuf.Value model_parameters = 5;
        Specified by:
        getModelParameters in interface BatchPredictionJobOrBuilder
        Returns:
        The modelParameters.

      • getModelParametersOrBuilder

        public 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.v1.BatchPredictionJob.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [parameters_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.parameters_schema_uri].
        .google.protobuf.Value model_parameters = 5;
        Specified by:
        getModelParametersOrBuilder in interface BatchPredictionJobOrBuilder

      • 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][google.cloud.aiplatform.v1.BatchPredictionJob.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]
 and
 [prediction_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.prediction_schema_uri].
        .google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasOutputConfig in interface BatchPredictionJobOrBuilder
        Returns:
        Whether the outputConfig field is set.

      • 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][google.cloud.aiplatform.v1.BatchPredictionJob.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]
 and
 [prediction_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.prediction_schema_uri].
        .google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getOutputConfig in interface BatchPredictionJobOrBuilder
        Returns:
        The outputConfig.

      • 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][google.cloud.aiplatform.v1.BatchPredictionJob.model]
 [PredictSchemata's][google.cloud.aiplatform.v1.Model.predict_schemata]
 [instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]
 and
 [prediction_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.prediction_schema_uri].
        .google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getOutputConfigOrBuilder in interface BatchPredictionJobOrBuilder

      • hasDedicatedResources

        public boolean hasDedicatedResources()
         The config of resources used by the Model during the batch prediction. If
 the Model
 [supports][google.cloud.aiplatform.v1.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.v1.BatchDedicatedResources dedicated_resources = 7;
        Specified by:
        hasDedicatedResources in interface BatchPredictionJobOrBuilder
        Returns:
        Whether the dedicatedResources field is set.

      • getDedicatedResources

        public BatchDedicatedResources getDedicatedResources()
         The config of resources used by the Model during the batch prediction. If
 the Model
 [supports][google.cloud.aiplatform.v1.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.v1.BatchDedicatedResources dedicated_resources = 7;
        Specified by:
        getDedicatedResources in interface BatchPredictionJobOrBuilder
        Returns:
        The dedicatedResources.

      • getDedicatedResourcesOrBuilder

        public BatchDedicatedResourcesOrBuilder getDedicatedResourcesOrBuilder()
         The config of resources used by the Model during the batch prediction. If
 the Model
 [supports][google.cloud.aiplatform.v1.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.v1.BatchDedicatedResources dedicated_resources = 7;
        Specified by:
        getDedicatedResourcesOrBuilder in interface BatchPredictionJobOrBuilder

      • 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;
        Specified by:
        getServiceAccount in interface BatchPredictionJobOrBuilder
        Returns:
        The serviceAccount.

      • getServiceAccountBytes

        public 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;
        Specified by:
        getServiceAccountBytes in interface BatchPredictionJobOrBuilder
        Returns:
        The bytes for serviceAccount.

      • hasManualBatchTuningParameters

        public boolean hasManualBatchTuningParameters()
         Immutable. Parameters configuring the batch behavior. Currently only
 applicable when
 [dedicated_resources][google.cloud.aiplatform.v1.BatchPredictionJob.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];
        Specified by:
        hasManualBatchTuningParameters in interface BatchPredictionJobOrBuilder
        Returns:
        Whether the manualBatchTuningParameters field is set.

      • getManualBatchTuningParameters

        public ManualBatchTuningParameters getManualBatchTuningParameters()
         Immutable. Parameters configuring the batch behavior. Currently only
 applicable when
 [dedicated_resources][google.cloud.aiplatform.v1.BatchPredictionJob.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];
        Specified by:
        getManualBatchTuningParameters in interface BatchPredictionJobOrBuilder
        Returns:
        The manualBatchTuningParameters.

      • getManualBatchTuningParametersOrBuilder

        public ManualBatchTuningParametersOrBuilder getManualBatchTuningParametersOrBuilder()
         Immutable. Parameters configuring the batch behavior. Currently only
 applicable when
 [dedicated_resources][google.cloud.aiplatform.v1.BatchPredictionJob.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];
        Specified by:
        getManualBatchTuningParametersOrBuilder in interface BatchPredictionJobOrBuilder

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

  * `bigquery`: output includes a column named `explanation`. The value
    is a struct that conforms to the
    [Explanation][google.cloud.aiplatform.v1.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.v1.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.v1.Model.explanation_spec]
 or
 [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec]
 must be populated.
        bool generate_explanation = 23;
        Specified by:
        getGenerateExplanation in interface BatchPredictionJobOrBuilder
        Returns:
        The generateExplanation.

      • hasExplanationSpec

        public boolean hasExplanationSpec()
         Explanation configuration for this BatchPredictionJob. Can be
 specified only if
 [generate_explanation][google.cloud.aiplatform.v1.BatchPredictionJob.generate_explanation]
 is set to `true`.

 This value overrides the value of
 [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec].
 All fields of
 [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec]
 are optional in the request. If a field of the
 [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec]
 object is not populated, the corresponding field of the
 [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec]
 object is inherited.
        .google.cloud.aiplatform.v1.ExplanationSpec explanation_spec = 25;
        Specified by:
        hasExplanationSpec in interface BatchPredictionJobOrBuilder
        Returns:
        Whether the explanationSpec field is set.

      • getExplanationSpec

        public ExplanationSpec getExplanationSpec()
         Explanation configuration for this BatchPredictionJob. Can be
 specified only if
 [generate_explanation][google.cloud.aiplatform.v1.BatchPredictionJob.generate_explanation]
 is set to `true`.

 This value overrides the value of
 [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec].
 All fields of
 [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec]
 are optional in the request. If a field of the
 [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec]
 object is not populated, the corresponding field of the
 [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec]
 object is inherited.
        .google.cloud.aiplatform.v1.ExplanationSpec explanation_spec = 25;
        Specified by:
        getExplanationSpec in interface BatchPredictionJobOrBuilder
        Returns:
        The explanationSpec.

      • getExplanationSpecOrBuilder

        public ExplanationSpecOrBuilder getExplanationSpecOrBuilder()
         Explanation configuration for this BatchPredictionJob. Can be
 specified only if
 [generate_explanation][google.cloud.aiplatform.v1.BatchPredictionJob.generate_explanation]
 is set to `true`.

 This value overrides the value of
 [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec].
 All fields of
 [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec]
 are optional in the request. If a field of the
 [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec]
 object is not populated, the corresponding field of the
 [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec]
 object is inherited.
        .google.cloud.aiplatform.v1.ExplanationSpec explanation_spec = 25;
        Specified by:
        getExplanationSpecOrBuilder in interface BatchPredictionJobOrBuilder

      • 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];
        Specified by:
        hasOutputInfo in interface BatchPredictionJobOrBuilder
        Returns:
        Whether the outputInfo field is set.

      • 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];
        Specified by:
        getOutputInfo in interface BatchPredictionJobOrBuilder
        Returns:
        The outputInfo.

      • 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];
        Specified by:
        getStateValue in interface BatchPredictionJobOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • 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];
        Specified by:
        getState in interface BatchPredictionJobOrBuilder
        Returns:
        The state.

      • 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];
        Specified by:
        hasError in interface BatchPredictionJobOrBuilder
        Returns:
        Whether the error field is set.

      • getError

        public 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];
        Specified by:
        getError in interface BatchPredictionJobOrBuilder
        Returns:
        The error.

      • getErrorOrBuilder

        public 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];
        Specified by:
        getErrorOrBuilder in interface BatchPredictionJobOrBuilder

      • getPartialFailuresList

        public 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];
        Specified by:
        getPartialFailuresList in interface BatchPredictionJobOrBuilder

      • getPartialFailuresOrBuilderList

        public 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];
        Specified by:
        getPartialFailuresOrBuilderList in interface BatchPredictionJobOrBuilder

      • 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];
        Specified by:
        getPartialFailuresCount in interface BatchPredictionJobOrBuilder

      • getPartialFailures

        public 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];
        Specified by:
        getPartialFailures in interface BatchPredictionJobOrBuilder

      • getPartialFailuresOrBuilder

        public 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];
        Specified by:
        getPartialFailuresOrBuilder in interface BatchPredictionJobOrBuilder

      • 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];
        Specified by:
        hasResourcesConsumed in interface BatchPredictionJobOrBuilder
        Returns:
        Whether the resourcesConsumed field is set.

      • 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];
        Specified by:
        getResourcesConsumed in interface BatchPredictionJobOrBuilder
        Returns:
        The resourcesConsumed.

      • 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];
        Specified by:
        getResourcesConsumedOrBuilder in interface BatchPredictionJobOrBuilder

      • 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];
        Specified by:
        hasCompletionStats in interface BatchPredictionJobOrBuilder
        Returns:
        Whether the completionStats field is set.

      • 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];
        Specified by:
        getCompletionStats in interface BatchPredictionJobOrBuilder
        Returns:
        The completionStats.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. Time when the BatchPredictionJob was created.
        .google.protobuf.Timestamp create_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface BatchPredictionJobOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public 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];
        Specified by:
        getCreateTime in interface BatchPredictionJobOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public 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];
        Specified by:
        getCreateTimeOrBuilder in interface BatchPredictionJobOrBuilder

      • 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];
        Specified by:
        hasStartTime in interface BatchPredictionJobOrBuilder
        Returns:
        Whether the startTime field is set.

      • getStartTime

        public 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];
        Specified by:
        getStartTime in interface BatchPredictionJobOrBuilder
        Returns:
        The startTime.

      • getStartTimeOrBuilder

        public 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];
        Specified by:
        getStartTimeOrBuilder in interface BatchPredictionJobOrBuilder

      • 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];
        Specified by:
        hasEndTime in interface BatchPredictionJobOrBuilder
        Returns:
        Whether the endTime field is set.

      • getEndTime

        public 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];
        Specified by:
        getEndTime in interface BatchPredictionJobOrBuilder
        Returns:
        The endTime.

      • getEndTimeOrBuilder

        public 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];
        Specified by:
        getEndTimeOrBuilder in interface BatchPredictionJobOrBuilder

      • 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];
        Specified by:
        hasUpdateTime in interface BatchPredictionJobOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public 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];
        Specified by:
        getUpdateTime in interface BatchPredictionJobOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public 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];
        Specified by:
        getUpdateTimeOrBuilder in interface BatchPredictionJobOrBuilder

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: BatchPredictionJobOrBuilder
         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;
        Specified by:
        getLabelsCount in interface BatchPredictionJobOrBuilder

      • containsLabels

        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;
        Specified by:
        containsLabels in interface BatchPredictionJobOrBuilder

      • 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;
        Specified by:
        getLabelsMap in interface BatchPredictionJobOrBuilder

      • getLabelsOrDefault

        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;
        Specified by:
        getLabelsOrDefault in interface BatchPredictionJobOrBuilder

      • getLabelsOrThrow

        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;
        Specified by:
        getLabelsOrThrow in interface BatchPredictionJobOrBuilder

      • 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;
        Specified by:
        hasEncryptionSpec in interface BatchPredictionJobOrBuilder
        Returns:
        Whether the encryptionSpec field is set.

      • 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;
        Specified by:
        getEncryptionSpec in interface BatchPredictionJobOrBuilder
        Returns:
        The encryptionSpec.

      • 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;
        Specified by:
        getEncryptionSpecOrBuilder in interface BatchPredictionJobOrBuilder

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

 User can disable container logging by setting this flag to true.
        bool disable_container_logging = 34;
        Specified by:
        getDisableContainerLogging in interface BatchPredictionJobOrBuilder
        Returns:
        The disableContainerLogging.

      • isInitialized

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

      • writeTo

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

      • getSerializedSize

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

      • equals

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

      • hashCode

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected BatchPredictionJob.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

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

      • getDefaultInstanceForType

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