Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class BatchPredictionJob.
A job that uses a Model to produce predictions on multiple input instances. If predictions for significant portion of the instances fail, the job may finish without attempting predictions for all remaining instances.
Generated from protobuf message google.cloud.aiplatform.v1.BatchPredictionJob
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. Resource name of the BatchPredictionJob. |
↳ display_name |
string
Required. The user-defined name of this BatchPredictionJob. |
↳ model |
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, if no version is specified, the default version will be used. |
↳ model_version_id |
string
Output only. The version ID of the Model that produces the predictions via this job. |
↳ unmanaged_container_model |
Google\Cloud\AIPlatform\V1\UnmanagedContainerModel
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. |
↳ input_config |
Google\Cloud\AIPlatform\V1\BatchPredictionJob\InputConfig
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. |
↳ model_parameters |
Google\Protobuf\Value
The parameters that govern the predictions. The schema of the parameters may be specified via the Model's PredictSchemata's parameters_schema_uri. |
↳ output_config |
Google\Cloud\AIPlatform\V1\BatchPredictionJob\OutputConfig
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. |
↳ dedicated_resources |
Google\Cloud\AIPlatform\V1\BatchDedicatedResources
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. |
↳ service_account |
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 |
↳ manual_batch_tuning_parameters |
Google\Cloud\AIPlatform\V1\ManualBatchTuningParameters
Immutable. Parameters configuring the batch behavior. Currently only applicable when dedicated_resources are used (in other cases Vertex AI does the tuning itself). |
↳ generate_explanation |
bool
Generate explanation with the batch prediction results. When set to |
↳ explanation_spec |
Google\Cloud\AIPlatform\V1\ExplanationSpec
Explanation configuration for this BatchPredictionJob. Can be specified only if generate_explanation is set to |
↳ output_info |
Google\Cloud\AIPlatform\V1\BatchPredictionJob\OutputInfo
Output only. Information further describing the output of this job. |
↳ state |
int
Output only. The detailed state of the job. |
↳ error |
Google\Rpc\Status
Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED. |
↳ partial_failures |
array<Google\Rpc\Status>
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. |
↳ resources_consumed |
Google\Cloud\AIPlatform\V1\ResourcesConsumed
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. |
↳ completion_stats |
Google\Cloud\AIPlatform\V1\CompletionStats
Output only. Statistics on completed and failed prediction instances. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Time when the BatchPredictionJob was created. |
↳ start_time |
Google\Protobuf\Timestamp
Output only. Time when the BatchPredictionJob for the first time entered the |
↳ end_time |
Google\Protobuf\Timestamp
Output only. Time when the BatchPredictionJob entered any of the following states: |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Time when the BatchPredictionJob was most recently updated. |
↳ labels |
array|Google\Protobuf\Internal\MapField
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. |
↳ encryption_spec |
Google\Cloud\AIPlatform\V1\EncryptionSpec
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. |
getName
Output only. Resource name of the BatchPredictionJob.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. Resource name of the BatchPredictionJob.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
Required. The user-defined name of this BatchPredictionJob.
Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
Required. The user-defined name of this BatchPredictionJob.
Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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, if no version is specified, the default version will be used.
Generated from protobuf field string model = 3 [(.google.api.resource_reference) = {
| Returns | |
|---|---|
| Type | Description |
string | |
setModel
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, if no version is specified, the default version will be used.
Generated from protobuf field string model = 3 [(.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getModelVersionId
Output only. The version ID of the Model that produces the predictions via this job.
Generated from protobuf field string model_version_id = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
string | |
setModelVersionId
Output only. The version ID of the Model that produces the predictions via this job.
Generated from protobuf field string model_version_id = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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.
Generated from protobuf field .google.cloud.aiplatform.v1.UnmanagedContainerModel unmanaged_container_model = 28;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\UnmanagedContainerModel|null | |
hasUnmanagedContainerModel
clearUnmanagedContainerModel
setUnmanagedContainerModel
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.
Generated from protobuf field .google.cloud.aiplatform.v1.UnmanagedContainerModel unmanaged_container_model = 28;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\UnmanagedContainerModel
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getInputConfig
Required. Input configuration of the instances on which predictions are performed.
The schema of any single instance may be specified via the Model's PredictSchemata's instance_schema_uri.
Generated from protobuf field .google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig input_config = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\BatchPredictionJob\InputConfig|null | |
hasInputConfig
clearInputConfig
setInputConfig
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.
Generated from protobuf field .google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig input_config = 4 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\BatchPredictionJob\InputConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getModelParameters
The parameters that govern the predictions. The schema of the parameters may be specified via the Model's PredictSchemata's parameters_schema_uri.
Generated from protobuf field .google.protobuf.Value model_parameters = 5;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Value|null | |
hasModelParameters
clearModelParameters
setModelParameters
The parameters that govern the predictions. The schema of the parameters may be specified via the Model's PredictSchemata's parameters_schema_uri.
Generated from protobuf field .google.protobuf.Value model_parameters = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Value
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOutputConfig
Required. The Configuration specifying where output predictions should be written.
The schema of any single prediction may be specified as a concatenation of Model's PredictSchemata's instance_schema_uri and prediction_schema_uri.
Generated from protobuf field .google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\BatchPredictionJob\OutputConfig|null | |
hasOutputConfig
clearOutputConfig
setOutputConfig
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.
Generated from protobuf field .google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\BatchPredictionJob\OutputConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDedicatedResources
The config of resources used by the Model during the batch prediction. If the Model supports DEDICATED_RESOURCES this config may be provided (and the job will use these resources), if the Model doesn't support AUTOMATIC_RESOURCES, this config must be provided.
Generated from protobuf field .google.cloud.aiplatform.v1.BatchDedicatedResources dedicated_resources = 7;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\BatchDedicatedResources|null | |
hasDedicatedResources
clearDedicatedResources
setDedicatedResources
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.
Generated from protobuf field .google.cloud.aiplatform.v1.BatchDedicatedResources dedicated_resources = 7;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\BatchDedicatedResources
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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.
Generated from protobuf field string service_account = 29;
| Returns | |
|---|---|
| Type | Description |
string | |
setServiceAccount
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.
Generated from protobuf field string service_account = 29;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getManualBatchTuningParameters
Immutable. Parameters configuring the batch behavior. Currently only applicable when dedicated_resources are used (in other cases Vertex AI does the tuning itself).
Generated from protobuf field .google.cloud.aiplatform.v1.ManualBatchTuningParameters manual_batch_tuning_parameters = 8 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\ManualBatchTuningParameters|null | |
hasManualBatchTuningParameters
clearManualBatchTuningParameters
setManualBatchTuningParameters
Immutable. Parameters configuring the batch behavior. Currently only applicable when dedicated_resources are used (in other cases Vertex AI does the tuning itself).
Generated from protobuf field .google.cloud.aiplatform.v1.ManualBatchTuningParameters manual_batch_tuning_parameters = 8 [(.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\ManualBatchTuningParameters
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getGenerateExplanation
Generate explanation with the batch prediction results.
When set to true, the batch prediction output changes based on the
predictions_format field of the
BatchPredictionJob.output_config object:
bigquery: output includes a column namedexplanation. The value is a struct that conforms to the Explanation object.jsonl: The JSON objects on each line include an additional entry keyedexplanation. 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.
Generated from protobuf field bool generate_explanation = 23;
| Returns | |
|---|---|
| Type | Description |
bool | |
setGenerateExplanation
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 namedexplanation. The value is a struct that conforms to the Explanation object.jsonl: The JSON objects on each line include an additional entry keyedexplanation. 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.
Generated from protobuf field bool generate_explanation = 23;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getExplanationSpec
Explanation configuration for this BatchPredictionJob. Can be
specified only if generate_explanation is set to true.
This value overrides the value of Model.explanation_spec. All fields of explanation_spec are optional in the request. If a field of the explanation_spec object is not populated, the corresponding field of the Model.explanation_spec object is inherited.
Generated from protobuf field .google.cloud.aiplatform.v1.ExplanationSpec explanation_spec = 25;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\ExplanationSpec|null | |
hasExplanationSpec
clearExplanationSpec
setExplanationSpec
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.
Generated from protobuf field .google.cloud.aiplatform.v1.ExplanationSpec explanation_spec = 25;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\ExplanationSpec
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOutputInfo
Output only. Information further describing the output of this job.
Generated from protobuf field .google.cloud.aiplatform.v1.BatchPredictionJob.OutputInfo output_info = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\BatchPredictionJob\OutputInfo|null | |
hasOutputInfo
clearOutputInfo
setOutputInfo
Output only. Information further describing the output of this job.
Generated from protobuf field .google.cloud.aiplatform.v1.BatchPredictionJob.OutputInfo output_info = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\BatchPredictionJob\OutputInfo
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. The detailed state of the job.
Generated from protobuf field .google.cloud.aiplatform.v1.JobState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. The detailed state of the job.
Generated from protobuf field .google.cloud.aiplatform.v1.JobState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getError
Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.
Generated from protobuf field .google.rpc.Status error = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Rpc\Status|null | |
hasError
clearError
setError
Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.
Generated from protobuf field .google.rpc.Status error = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Rpc\Status
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPartialFailures
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.
Generated from protobuf field repeated .google.rpc.Status partial_failures = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setPartialFailures
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.
Generated from protobuf field repeated .google.rpc.Status partial_failures = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Rpc\Status>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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.
Generated from protobuf field .google.cloud.aiplatform.v1.ResourcesConsumed resources_consumed = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\ResourcesConsumed|null | |
hasResourcesConsumed
clearResourcesConsumed
setResourcesConsumed
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.
Generated from protobuf field .google.cloud.aiplatform.v1.ResourcesConsumed resources_consumed = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\ResourcesConsumed
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCompletionStats
Output only. Statistics on completed and failed prediction instances.
Generated from protobuf field .google.cloud.aiplatform.v1.CompletionStats completion_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\CompletionStats|null | |
hasCompletionStats
clearCompletionStats
setCompletionStats
Output only. Statistics on completed and failed prediction instances.
Generated from protobuf field .google.cloud.aiplatform.v1.CompletionStats completion_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\CompletionStats
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. Time when the BatchPredictionJob was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time when the BatchPredictionJob was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStartTime
Output only. Time when the BatchPredictionJob for the first time entered the
JOB_STATE_RUNNING state.
Generated from protobuf field .google.protobuf.Timestamp start_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasStartTime
clearStartTime
setStartTime
Output only. Time when the BatchPredictionJob for the first time entered the
JOB_STATE_RUNNING state.
Generated from protobuf field .google.protobuf.Timestamp start_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEndTime
Output only. Time when the BatchPredictionJob entered any of the following states:
JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.
Generated from protobuf field .google.protobuf.Timestamp end_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasEndTime
clearEndTime
setEndTime
Output only. Time when the BatchPredictionJob entered any of the following states:
JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.
Generated from protobuf field .google.protobuf.Timestamp end_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. Time when the BatchPredictionJob was most recently updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Time when the BatchPredictionJob was most recently updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLabels
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.
Generated from protobuf field map<string, string> labels = 19;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setLabels
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.
Generated from protobuf field map<string, string> labels = 19;
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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.
Generated from protobuf field .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 24;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\EncryptionSpec|null | |
hasEncryptionSpec
clearEncryptionSpec
setEncryptionSpec
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.
Generated from protobuf field .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 24;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\EncryptionSpec
|
| Returns | |
|---|---|
| Type | Description |
$this | |