- 3.52.0 (latest)
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public interface BatchPredictionJobOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsLabels(String key)
public abstract boolean containsLabels(String key)The labels with user-defined metadata to organize BatchPredictionJobs.
Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.
See https://goo.gl/xmQnxf for more information and examples of labels.
map<string, string> labels = 19;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getCompletionStats()
public abstract 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 | |
|---|---|
| Type | Description |
CompletionStats | The completionStats. |
getCompletionStatsOrBuilder()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
CompletionStatsOrBuilder | |
getCreateTime()
public abstract Timestamp getCreateTime()Output only. Time when the BatchPredictionJob was created.
.google.protobuf.Timestamp create_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp | The createTime. |
getCreateTimeOrBuilder()
public abstract TimestampOrBuilder getCreateTimeOrBuilder()Output only. Time when the BatchPredictionJob was created.
.google.protobuf.Timestamp create_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
getDedicatedResources()
public abstract BatchDedicatedResources getDedicatedResources()The config of resources used by the Model during the batch prediction. If the Model supports DEDICATED_RESOURCES this config may be provided (and the job will use these resources), if the Model doesn't support AUTOMATIC_RESOURCES, this config must be provided.
.google.cloud.aiplatform.v1beta1.BatchDedicatedResources dedicated_resources = 7;
| Returns | |
|---|---|
| Type | Description |
BatchDedicatedResources | The dedicatedResources. |
getDedicatedResourcesOrBuilder()
public abstract BatchDedicatedResourcesOrBuilder getDedicatedResourcesOrBuilder()The config of resources used by the Model during the batch prediction. If the Model supports DEDICATED_RESOURCES this config may be provided (and the job will use these resources), if the Model doesn't support AUTOMATIC_RESOURCES, this config must be provided.
.google.cloud.aiplatform.v1beta1.BatchDedicatedResources dedicated_resources = 7;
| Returns | |
|---|---|
| Type | Description |
BatchDedicatedResourcesOrBuilder | |
getDisableContainerLogging()
public abstract boolean getDisableContainerLogging() For custom-trained Models and AutoML Tabular Models, the container of the
DeployedModel instances will send stderr and stdout streams to
Cloud Logging by default. Please note that the logs incur cost,
which are subject to Cloud Logging
pricing.
User can disable container logging by setting this flag to true.
bool disable_container_logging = 34;
| Returns | |
|---|---|
| Type | Description |
boolean | The disableContainerLogging. |
getDisplayName()
public abstract String getDisplayName()Required. The user-defined name of this BatchPredictionJob.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String | The displayName. |
getDisplayNameBytes()
public abstract ByteString getDisplayNameBytes()Required. The user-defined name of this BatchPredictionJob.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for displayName. |
getEncryptionSpec()
public abstract 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 | |
|---|---|
| Type | Description |
EncryptionSpec | The encryptionSpec. |
getEncryptionSpecOrBuilder()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
EncryptionSpecOrBuilder | |
getEndTime()
public abstract Timestamp getEndTime() Output only. Time when the BatchPredictionJob entered any of the following
states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.
.google.protobuf.Timestamp end_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp | The endTime. |
getEndTimeOrBuilder()
public abstract TimestampOrBuilder getEndTimeOrBuilder() Output only. Time when the BatchPredictionJob entered any of the following
states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.
.google.protobuf.Timestamp end_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
getError()
public abstract Status getError()Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.
.google.rpc.Status error = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
com.google.rpc.Status | The error. |
getErrorOrBuilder()
public abstract StatusOrBuilder getErrorOrBuilder()Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.
.google.rpc.Status error = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
com.google.rpc.StatusOrBuilder | |
getExplanationSpec()
public abstract ExplanationSpec getExplanationSpec() Explanation configuration for this BatchPredictionJob. Can be
specified only if
generate_explanation
is set to true.
This value overrides the value of Model.explanation_spec. All fields of explanation_spec are optional in the request. If a field of the explanation_spec object is not populated, the corresponding field of the Model.explanation_spec object is inherited.
.google.cloud.aiplatform.v1beta1.ExplanationSpec explanation_spec = 25;
| Returns | |
|---|---|
| Type | Description |
ExplanationSpec | The explanationSpec. |
getExplanationSpecOrBuilder()
public abstract ExplanationSpecOrBuilder getExplanationSpecOrBuilder() Explanation configuration for this BatchPredictionJob. Can be
specified only if
generate_explanation
is set to true.
This value overrides the value of Model.explanation_spec. All fields of explanation_spec are optional in the request. If a field of the explanation_spec object is not populated, the corresponding field of the Model.explanation_spec object is inherited.
.google.cloud.aiplatform.v1beta1.ExplanationSpec explanation_spec = 25;
| Returns | |
|---|---|
| Type | Description |
ExplanationSpecOrBuilder | |
getGenerateExplanation()
public abstract boolean getGenerateExplanation()Generate explanation with the batch prediction results.
When set to true, the batch prediction output changes based on the
predictions_format field of the
BatchPredictionJob.output_config
object:
bigquery: output includes a column 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.
bool generate_explanation = 23;
| Returns | |
|---|---|
| Type | Description |
boolean | The generateExplanation. |
getInputConfig()
public abstract BatchPredictionJob.InputConfig getInputConfig()Required. Input configuration of the instances on which predictions are performed. The schema of any single instance may be specified via the Model's PredictSchemata's instance_schema_uri.
.google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig input_config = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
BatchPredictionJob.InputConfig | The inputConfig. |
getInputConfigOrBuilder()
public abstract BatchPredictionJob.InputConfigOrBuilder getInputConfigOrBuilder()Required. Input configuration of the instances on which predictions are performed. The schema of any single instance may be specified via the Model's PredictSchemata's instance_schema_uri.
.google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig input_config = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
BatchPredictionJob.InputConfigOrBuilder | |
getInstanceConfig()
public abstract 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 | |
|---|---|
| Type | Description |
BatchPredictionJob.InstanceConfig | The instanceConfig. |
getInstanceConfigOrBuilder()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
BatchPredictionJob.InstanceConfigOrBuilder | |
getLabels()
public abstract Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getLabelsCount()
public abstract int getLabelsCount()The labels with user-defined metadata to organize BatchPredictionJobs.
Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.
See https://goo.gl/xmQnxf for more information and examples of labels.
map<string, string> labels = 19;
| Returns | |
|---|---|
| Type | Description |
int | |
getLabelsMap()
public abstract Map<String,String> getLabelsMap()The labels with user-defined metadata to organize BatchPredictionJobs.
Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.
See https://goo.gl/xmQnxf for more information and examples of labels.
map<string, string> labels = 19;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getLabelsOrDefault(String key, String defaultValue)
public abstract String getLabelsOrDefault(String key, String defaultValue)The labels with user-defined metadata to organize BatchPredictionJobs.
Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.
See https://goo.gl/xmQnxf for more information and examples of labels.
map<string, string> labels = 19;
| Parameters | |
|---|---|
| Name | Description |
key | String |
defaultValue | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getLabelsOrThrow(String key)
public abstract String getLabelsOrThrow(String key)The labels with user-defined metadata to organize BatchPredictionJobs.
Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.
See https://goo.gl/xmQnxf for more information and examples of labels.
map<string, string> labels = 19;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getManualBatchTuningParameters()
public abstract ManualBatchTuningParameters getManualBatchTuningParameters()Immutable. Parameters configuring the batch behavior. Currently only applicable when dedicated_resources are used (in other cases Vertex AI does the tuning itself).
.google.cloud.aiplatform.v1beta1.ManualBatchTuningParameters manual_batch_tuning_parameters = 8 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
ManualBatchTuningParameters | The manualBatchTuningParameters. |
getManualBatchTuningParametersOrBuilder()
public abstract ManualBatchTuningParametersOrBuilder getManualBatchTuningParametersOrBuilder()Immutable. Parameters configuring the batch behavior. Currently only applicable when dedicated_resources are used (in other cases Vertex AI does the tuning itself).
.google.cloud.aiplatform.v1beta1.ManualBatchTuningParameters manual_batch_tuning_parameters = 8 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
ManualBatchTuningParametersOrBuilder | |
getModel()
public abstract 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.
string model = 3 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String | The model. |
getModelBytes()
public abstract 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.
string model = 3 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for model. |
getModelMonitoringConfig()
public abstract 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 | |
|---|---|
| Type | Description |
ModelMonitoringConfig | The modelMonitoringConfig. |
getModelMonitoringConfigOrBuilder()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
ModelMonitoringConfigOrBuilder | |
getModelMonitoringStatsAnomalies(int index)
public abstract ModelMonitoringStatsAnomalies getModelMonitoringStatsAnomalies(int index)Get batch prediction job monitoring statistics.
repeated .google.cloud.aiplatform.v1beta1.ModelMonitoringStatsAnomalies model_monitoring_stats_anomalies = 31;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
ModelMonitoringStatsAnomalies | |
getModelMonitoringStatsAnomaliesCount()
public abstract int getModelMonitoringStatsAnomaliesCount()Get batch prediction job monitoring statistics.
repeated .google.cloud.aiplatform.v1beta1.ModelMonitoringStatsAnomalies model_monitoring_stats_anomalies = 31;
| Returns | |
|---|---|
| Type | Description |
int | |
getModelMonitoringStatsAnomaliesList()
public abstract List<ModelMonitoringStatsAnomalies> getModelMonitoringStatsAnomaliesList()Get batch prediction job monitoring statistics.
repeated .google.cloud.aiplatform.v1beta1.ModelMonitoringStatsAnomalies model_monitoring_stats_anomalies = 31;
| Returns | |
|---|---|
| Type | Description |
List<ModelMonitoringStatsAnomalies> | |
getModelMonitoringStatsAnomaliesOrBuilder(int index)
public abstract ModelMonitoringStatsAnomaliesOrBuilder getModelMonitoringStatsAnomaliesOrBuilder(int index)Get batch prediction job monitoring statistics.
repeated .google.cloud.aiplatform.v1beta1.ModelMonitoringStatsAnomalies model_monitoring_stats_anomalies = 31;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
ModelMonitoringStatsAnomaliesOrBuilder | |
getModelMonitoringStatsAnomaliesOrBuilderList()
public abstract List<? extends ModelMonitoringStatsAnomaliesOrBuilder> getModelMonitoringStatsAnomaliesOrBuilderList()Get batch prediction job monitoring statistics.
repeated .google.cloud.aiplatform.v1beta1.ModelMonitoringStatsAnomalies model_monitoring_stats_anomalies = 31;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.aiplatform.v1beta1.ModelMonitoringStatsAnomaliesOrBuilder> | |
getModelMonitoringStatus()
public abstract 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 | |
|---|---|
| Type | Description |
com.google.rpc.Status | The modelMonitoringStatus. |
getModelMonitoringStatusOrBuilder()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
com.google.rpc.StatusOrBuilder | |
getModelParameters()
public abstract Value getModelParameters()The parameters that govern the predictions. The schema of the parameters may be specified via the Model's PredictSchemata's parameters_schema_uri.
.google.protobuf.Value model_parameters = 5;
| Returns | |
|---|---|
| Type | Description |
Value | The modelParameters. |
getModelParametersOrBuilder()
public abstract ValueOrBuilder getModelParametersOrBuilder()The parameters that govern the predictions. The schema of the parameters may be specified via the Model's PredictSchemata's parameters_schema_uri.
.google.protobuf.Value model_parameters = 5;
| Returns | |
|---|---|
| Type | Description |
ValueOrBuilder | |
getModelVersionId()
public abstract String getModelVersionId()Output only. The version ID of the Model that produces the predictions via this job.
string model_version_id = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String | The modelVersionId. |
getModelVersionIdBytes()
public abstract ByteString getModelVersionIdBytes()Output only. The version ID of the Model that produces the predictions via this job.
string model_version_id = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for modelVersionId. |
getName()
public abstract String getName()Output only. Resource name of the BatchPredictionJob.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String | The name. |
getNameBytes()
public abstract ByteString getNameBytes()Output only. Resource name of the BatchPredictionJob.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for name. |
getOutputConfig()
public abstract BatchPredictionJob.OutputConfig getOutputConfig()Required. The Configuration specifying where output predictions should be written. The schema of any single prediction may be specified as a concatenation of Model's PredictSchemata's instance_schema_uri and prediction_schema_uri.
.google.cloud.aiplatform.v1beta1.BatchPredictionJob.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
BatchPredictionJob.OutputConfig | The outputConfig. |
getOutputConfigOrBuilder()
public abstract BatchPredictionJob.OutputConfigOrBuilder getOutputConfigOrBuilder()Required. The Configuration specifying where output predictions should be written. The schema of any single prediction may be specified as a concatenation of Model's PredictSchemata's instance_schema_uri and prediction_schema_uri.
.google.cloud.aiplatform.v1beta1.BatchPredictionJob.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
BatchPredictionJob.OutputConfigOrBuilder | |
getOutputInfo()
public abstract 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 | |
|---|---|
| Type | Description |
BatchPredictionJob.OutputInfo | The outputInfo. |
getOutputInfoOrBuilder()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
BatchPredictionJob.OutputInfoOrBuilder | |
getPartialFailures(int index)
public abstract Status getPartialFailures(int index)Output only. Partial failures encountered. For example, single files that can't be read. This field never exceeds 20 entries. Status details fields contain standard Google Cloud error details.
repeated .google.rpc.Status partial_failures = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
com.google.rpc.Status | |
getPartialFailuresCount()
public abstract int getPartialFailuresCount()Output only. Partial failures encountered. For example, single files that can't be read. This field never exceeds 20 entries. Status details fields contain standard Google Cloud error details.
repeated .google.rpc.Status partial_failures = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int | |
getPartialFailuresList()
public abstract List<Status> getPartialFailuresList()Output only. Partial failures encountered. For example, single files that can't be read. This field never exceeds 20 entries. Status details fields contain standard Google Cloud error details.
repeated .google.rpc.Status partial_failures = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<com.google.rpc.Status> | |
getPartialFailuresOrBuilder(int index)
public abstract StatusOrBuilder getPartialFailuresOrBuilder(int index)Output only. Partial failures encountered. For example, single files that can't be read. This field never exceeds 20 entries. Status details fields contain standard Google Cloud error details.
repeated .google.rpc.Status partial_failures = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
com.google.rpc.StatusOrBuilder | |
getPartialFailuresOrBuilderList()
public abstract List<? extends StatusOrBuilder> getPartialFailuresOrBuilderList()Output only. Partial failures encountered. For example, single files that can't be read. This field never exceeds 20 entries. Status details fields contain standard Google Cloud error details.
repeated .google.rpc.Status partial_failures = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.rpc.StatusOrBuilder> | |
getResourcesConsumed()
public abstract 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 | |
|---|---|
| Type | Description |
ResourcesConsumed | The resourcesConsumed. |
getResourcesConsumedOrBuilder()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
ResourcesConsumedOrBuilder | |
getServiceAccount()
public abstract String getServiceAccount()The service account that the DeployedModel's container runs as. If not specified, a system generated one will be used, which has minimal permissions and the custom container, if used, may not have enough permission to access other Google Cloud resources.
Users deploying the Model must have the iam.serviceAccounts.actAs
permission on this service account.
string service_account = 29;
| Returns | |
|---|---|
| Type | Description |
String | The serviceAccount. |
getServiceAccountBytes()
public abstract ByteString getServiceAccountBytes()The service account that the DeployedModel's container runs as. If not specified, a system generated one will be used, which has minimal permissions and the custom container, if used, may not have enough permission to access other Google Cloud resources.
Users deploying the Model must have the iam.serviceAccounts.actAs
permission on this service account.
string service_account = 29;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for serviceAccount. |
getStartTime()
public abstract Timestamp getStartTime() Output only. Time when the BatchPredictionJob for the first time entered
the JOB_STATE_RUNNING state.
.google.protobuf.Timestamp start_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp | The startTime. |
getStartTimeOrBuilder()
public abstract TimestampOrBuilder getStartTimeOrBuilder() Output only. Time when the BatchPredictionJob for the first time entered
the JOB_STATE_RUNNING state.
.google.protobuf.Timestamp start_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
getState()
public abstract JobState getState()Output only. The detailed state of the job.
.google.cloud.aiplatform.v1beta1.JobState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
JobState | The state. |
getStateValue()
public abstract int getStateValue()Output only. The detailed state of the job.
.google.cloud.aiplatform.v1beta1.JobState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int | The enum numeric value on the wire for state. |
getUnmanagedContainerModel()
public abstract 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 | |
|---|---|
| Type | Description |
UnmanagedContainerModel | The unmanagedContainerModel. |
getUnmanagedContainerModelOrBuilder()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
UnmanagedContainerModelOrBuilder | |
getUpdateTime()
public abstract Timestamp getUpdateTime()Output only. Time when the BatchPredictionJob was most recently updated.
.google.protobuf.Timestamp update_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp | The updateTime. |
getUpdateTimeOrBuilder()
public abstract TimestampOrBuilder getUpdateTimeOrBuilder()Output only. Time when the BatchPredictionJob was most recently updated.
.google.protobuf.Timestamp update_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
hasCompletionStats()
public abstract 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 | |
|---|---|
| Type | Description |
boolean | Whether the completionStats field is set. |
hasCreateTime()
public abstract boolean hasCreateTime()Output only. Time when the BatchPredictionJob was created.
.google.protobuf.Timestamp create_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the createTime field is set. |
hasDedicatedResources()
public abstract boolean hasDedicatedResources()The config of resources used by the Model during the batch prediction. If the Model supports DEDICATED_RESOURCES this config may be provided (and the job will use these resources), if the Model doesn't support AUTOMATIC_RESOURCES, this config must be provided.
.google.cloud.aiplatform.v1beta1.BatchDedicatedResources dedicated_resources = 7;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the dedicatedResources field is set. |
hasEncryptionSpec()
public abstract 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 | |
|---|---|
| Type | Description |
boolean | Whether the encryptionSpec field is set. |
hasEndTime()
public abstract boolean hasEndTime() Output only. Time when the BatchPredictionJob entered any of the following
states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.
.google.protobuf.Timestamp end_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the endTime field is set. |
hasError()
public abstract boolean hasError()Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.
.google.rpc.Status error = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the error field is set. |
hasExplanationSpec()
public abstract boolean hasExplanationSpec() Explanation configuration for this BatchPredictionJob. Can be
specified only if
generate_explanation
is set to true.
This value overrides the value of Model.explanation_spec. All fields of explanation_spec are optional in the request. If a field of the explanation_spec object is not populated, the corresponding field of the Model.explanation_spec object is inherited.
.google.cloud.aiplatform.v1beta1.ExplanationSpec explanation_spec = 25;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the explanationSpec field is set. |
hasInputConfig()
public abstract boolean hasInputConfig()Required. Input configuration of the instances on which predictions are performed. The schema of any single instance may be specified via the Model's PredictSchemata's instance_schema_uri.
.google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig input_config = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the inputConfig field is set. |
hasInstanceConfig()
public abstract 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 | |
|---|---|
| Type | Description |
boolean | Whether the instanceConfig field is set. |
hasManualBatchTuningParameters()
public abstract boolean hasManualBatchTuningParameters()Immutable. Parameters configuring the batch behavior. Currently only applicable when dedicated_resources are used (in other cases Vertex AI does the tuning itself).
.google.cloud.aiplatform.v1beta1.ManualBatchTuningParameters manual_batch_tuning_parameters = 8 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the manualBatchTuningParameters field is set. |
hasModelMonitoringConfig()
public abstract 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 | |
|---|---|
| Type | Description |
boolean | Whether the modelMonitoringConfig field is set. |
hasModelMonitoringStatus()
public abstract 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 | |
|---|---|
| Type | Description |
boolean | Whether the modelMonitoringStatus field is set. |
hasModelParameters()
public abstract boolean hasModelParameters()The parameters that govern the predictions. The schema of the parameters may be specified via the Model's PredictSchemata's parameters_schema_uri.
.google.protobuf.Value model_parameters = 5;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the modelParameters field is set. |
hasOutputConfig()
public abstract boolean hasOutputConfig()Required. The Configuration specifying where output predictions should be written. The schema of any single prediction may be specified as a concatenation of Model's PredictSchemata's instance_schema_uri and prediction_schema_uri.
.google.cloud.aiplatform.v1beta1.BatchPredictionJob.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the outputConfig field is set. |
hasOutputInfo()
public abstract 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 | |
|---|---|
| Type | Description |
boolean | Whether the outputInfo field is set. |
hasResourcesConsumed()
public abstract 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 | |
|---|---|
| Type | Description |
boolean | Whether the resourcesConsumed field is set. |
hasStartTime()
public abstract boolean hasStartTime() Output only. Time when the BatchPredictionJob for the first time entered
the JOB_STATE_RUNNING state.
.google.protobuf.Timestamp start_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the startTime field is set. |
hasUnmanagedContainerModel()
public abstract 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 | |
|---|---|
| Type | Description |
boolean | Whether the unmanagedContainerModel field is set. |
hasUpdateTime()
public abstract boolean hasUpdateTime()Output only. Time when the BatchPredictionJob was most recently updated.
.google.protobuf.Timestamp update_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the updateTime field is set. |