| _key | core | string | |
| ancestors | core | array<string> | |
| completion_stats | core | json | Output only. Statistics on completed and failed prediction instances. |
| create_time | core | timestamp | Output only. Time when the BatchPredictionJob was created. |
| datadog_display_name | core | string | |
| dedicated_resources | core | json | The config of resources used by the Model during the batch prediction. If the Model supports DEDICATED_RESOURCES this config may be provided (and the job will use these resources), if the Model doesn't support AUTOMATIC_RESOURCES, this config must be provided. |
| disable_container_logging | core | bool | 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. |
| encryption_spec | core | json | 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. |
| end_time | core | timestamp | Output only. Time when the BatchPredictionJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. |
| error | core | json | Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED. |
| explanation_spec | core | json | Explanation configuration for this BatchPredictionJob. Can be specified only if generate_explanation is set to `true`. This value overrides the value of Model.explanation_spec. All fields of explanation_spec are optional in the request. If a field of the explanation_spec object is not populated, the corresponding field of the Model.explanation_spec object is inherited. |
| gcp_display_name | core | string | Required. The user-defined name of this BatchPredictionJob. |
| generate_explanation | core | bool | Generate explanation with the batch prediction results. When set to `true`, the batch prediction output changes based on the `predictions_format` field of the BatchPredictionJob.output_config object: * `bigquery`: output includes a column named `explanation`. The value is a struct that conforms to the Explanation object. * `jsonl`: The JSON objects on each line include an additional entry keyed `explanation`. The value of the entry is a JSON object that conforms to the Explanation object. * `csv`: Generating explanations for CSV format is not supported. If this field is set to true, either the Model.explanation_spec or explanation_spec must be populated. |
| input_config | core | json | Required. Input configuration of the instances on which predictions are performed. The schema of any single instance may be specified via the Model's PredictSchemata's instance_schema_uri. |
| instance_config | core | json | Configuration for how to convert batch prediction input instances to the prediction instances that are sent to the Model. |
| labels | core | array<string> | |
| manual_batch_tuning_parameters | core | json | Immutable. Parameters configuring the batch behavior. Currently only applicable when dedicated_resources are used (in other cases Vertex AI does the tuning itself). |
| model | core | string | 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}` |
| model_version_id | core | string | Output only. The version ID of the Model that produces the predictions via this job. |
| name | core | string | Output only. Resource name of the BatchPredictionJob. |
| organization_id | core | string | |
| output_config | core | json | Required. The Configuration specifying where output predictions should be written. The schema of any single prediction may be specified as a concatenation of Model's PredictSchemata's instance_schema_uri and prediction_schema_uri. |
| output_info | core | json | Output only. Information further describing the output of this job. |
| parent | core | string | |
| partial_failures | core | json | 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. |
| project_id | core | string | |
| project_number | core | string | |
| resource_name | core | string | |
| resources_consumed | core | json | 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. |
| satisfies_pzi | core | bool | Output only. Reserved for future use. |
| satisfies_pzs | core | bool | Output only. Reserved for future use. |
| service_account | core | string | 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. |
| start_time | core | timestamp | Output only. Time when the BatchPredictionJob for the first time entered the `JOB_STATE_RUNNING` state. |
| state | core | string | Output only. The detailed state of the job. Possible values: ['JOB_STATE_UNSPECIFIED', 'JOB_STATE_QUEUED', 'JOB_STATE_PENDING', 'JOB_STATE_RUNNING', 'JOB_STATE_SUCCEEDED', 'JOB_STATE_FAILED', 'JOB_STATE_CANCELLING', 'JOB_STATE_CANCELLED', 'JOB_STATE_PAUSED', 'JOB_STATE_EXPIRED', 'JOB_STATE_UPDATING', 'JOB_STATE_PARTIALLY_SUCCEEDED']. Values descriptions: ['The job state is unspecified.', 'The job has been just created or resumed and processing has not yet begun.', 'The service is preparing to run the job.', 'The job is in progress.', 'The job completed successfully.', 'The job failed.', 'The job is being cancelled. From this state the job may only go to either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.', 'The job has been cancelled.', 'The job has been stopped, and can be resumed.', 'The job has expired.', 'The job is being updated. Only jobs in the `RUNNING` state can be updated. After updating, the job goes back to the `RUNNING` state.', 'The job is partially succeeded, some results may be missing due to errors.'] |
| tags | core | hstore | |
| unmanaged_container_model | core | json | 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. |
| update_time | core | timestamp | Output only. Time when the BatchPredictionJob was most recently updated. |
