Class BatchPredictionJob
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.cloud.aiplatform.v1beta1.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.v1beta1.BatchPredictionJob.model] to produce predictions on multiple [input instances][google.cloud.aiplatform.v1beta1.BatchPredictionJob.input_config]. If predictions for significant portion of the instances fail, the job may finish without attempting predictions for all remaining instances.
Protobuf typegoogle.cloud.aiplatform.v1beta1.BatchPredictionJob
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
BatchPredictionJob.Builder
A job that uses a [Model][google.cloud.aiplatform.v1beta1.BatchPredictionJob.model] to produce predictions on multiple [input instances][google.cloud.aiplatform.v1beta1.BatchPredictionJob.input_config].static class
BatchPredictionJob.InputConfig
Configures the input to [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob].static interface
BatchPredictionJob.InputConfigOrBuilder
static class
BatchPredictionJob.InstanceConfig
Configuration defining how to transform batch prediction input instances to the instances that the Model accepts.static interface
BatchPredictionJob.InstanceConfigOrBuilder
static class
BatchPredictionJob.OutputConfig
Configures the output of [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob].static interface
BatchPredictionJob.OutputConfigOrBuilder
static class
BatchPredictionJob.OutputInfo
Further describes this job's output.static interface
BatchPredictionJob.OutputInfoOrBuilder
-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
containsLabels(String key)
The labels with user-defined metadata to organize BatchPredictionJobs.boolean
equals(Object obj)
CompletionStats
getCompletionStats()
Output only.CompletionStatsOrBuilder
getCompletionStatsOrBuilder()
Output only.com.google.protobuf.Timestamp
getCreateTime()
Output only.com.google.protobuf.TimestampOrBuilder
getCreateTimeOrBuilder()
Output only.BatchDedicatedResources
getDedicatedResources()
The config of resources used by the Model during the batch prediction.BatchDedicatedResourcesOrBuilder
getDedicatedResourcesOrBuilder()
The config of resources used by the Model during the batch prediction.static BatchPredictionJob
getDefaultInstance()
BatchPredictionJob
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
boolean
getDisableContainerLogging()
For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send `stderr` and `stdout` streams to Cloud Logging by default.String
getDisplayName()
Required.com.google.protobuf.ByteString
getDisplayNameBytes()
Required.EncryptionSpec
getEncryptionSpec()
Customer-managed encryption key options for a BatchPredictionJob.EncryptionSpecOrBuilder
getEncryptionSpecOrBuilder()
Customer-managed encryption key options for a BatchPredictionJob.com.google.protobuf.Timestamp
getEndTime()
Output only.com.google.protobuf.TimestampOrBuilder
getEndTimeOrBuilder()
Output only.com.google.rpc.Status
getError()
Output only.com.google.rpc.StatusOrBuilder
getErrorOrBuilder()
Output only.ExplanationSpec
getExplanationSpec()
Explanation configuration for this BatchPredictionJob.ExplanationSpecOrBuilder
getExplanationSpecOrBuilder()
Explanation configuration for this BatchPredictionJob.boolean
getGenerateExplanation()
Generate explanation with the batch prediction results.BatchPredictionJob.InputConfig
getInputConfig()
Required.BatchPredictionJob.InputConfigOrBuilder
getInputConfigOrBuilder()
Required.BatchPredictionJob.InstanceConfig
getInstanceConfig()
Configuration for how to convert batch prediction input instances to the prediction instances that are sent to the Model.BatchPredictionJob.InstanceConfigOrBuilder
getInstanceConfigOrBuilder()
Configuration for how to convert batch prediction input instances to the prediction instances that are sent to the Model.Map<String,String>
getLabels()
Deprecated.int
getLabelsCount()
The labels with user-defined metadata to organize BatchPredictionJobs.Map<String,String>
getLabelsMap()
The labels with user-defined metadata to organize BatchPredictionJobs.String
getLabelsOrDefault(String key, String defaultValue)
The labels with user-defined metadata to organize BatchPredictionJobs.String
getLabelsOrThrow(String key)
The labels with user-defined metadata to organize BatchPredictionJobs.ManualBatchTuningParameters
getManualBatchTuningParameters()
Immutable.ManualBatchTuningParametersOrBuilder
getManualBatchTuningParametersOrBuilder()
Immutable.String
getModel()
The name of the Model resource that produces the predictions via this job, must share the same ancestor Location.com.google.protobuf.ByteString
getModelBytes()
The name of the Model resource that produces the predictions via this job, must share the same ancestor Location.ModelMonitoringConfig
getModelMonitoringConfig()
Model monitoring config will be used for analysis model behaviors, based on the input and output to the batch prediction job, as well as the provided training dataset.ModelMonitoringConfigOrBuilder
getModelMonitoringConfigOrBuilder()
Model monitoring config will be used for analysis model behaviors, based on the input and output to the batch prediction job, as well as the provided training dataset.ModelMonitoringStatsAnomalies
getModelMonitoringStatsAnomalies(int index)
Get batch prediction job monitoring statistics.int
getModelMonitoringStatsAnomaliesCount()
Get batch prediction job monitoring statistics.List<ModelMonitoringStatsAnomalies>
getModelMonitoringStatsAnomaliesList()
Get batch prediction job monitoring statistics.ModelMonitoringStatsAnomaliesOrBuilder
getModelMonitoringStatsAnomaliesOrBuilder(int index)
Get batch prediction job monitoring statistics.List<? extends ModelMonitoringStatsAnomaliesOrBuilder>
getModelMonitoringStatsAnomaliesOrBuilderList()
Get batch prediction job monitoring statistics.com.google.rpc.Status
getModelMonitoringStatus()
Output only.com.google.rpc.StatusOrBuilder
getModelMonitoringStatusOrBuilder()
Output only.com.google.protobuf.Value
getModelParameters()
The parameters that govern the predictions.com.google.protobuf.ValueOrBuilder
getModelParametersOrBuilder()
The parameters that govern the predictions.String
getModelVersionId()
Output only.com.google.protobuf.ByteString
getModelVersionIdBytes()
Output only.String
getName()
Output only.com.google.protobuf.ByteString
getNameBytes()
Output only.BatchPredictionJob.OutputConfig
getOutputConfig()
Required.BatchPredictionJob.OutputConfigOrBuilder
getOutputConfigOrBuilder()
Required.BatchPredictionJob.OutputInfo
getOutputInfo()
Output only.BatchPredictionJob.OutputInfoOrBuilder
getOutputInfoOrBuilder()
Output only.com.google.protobuf.Parser<BatchPredictionJob>
getParserForType()
com.google.rpc.Status
getPartialFailures(int index)
Output only.int
getPartialFailuresCount()
Output only.List<com.google.rpc.Status>
getPartialFailuresList()
Output only.com.google.rpc.StatusOrBuilder
getPartialFailuresOrBuilder(int index)
Output only.List<? extends com.google.rpc.StatusOrBuilder>
getPartialFailuresOrBuilderList()
Output only.ResourcesConsumed
getResourcesConsumed()
Output only.ResourcesConsumedOrBuilder
getResourcesConsumedOrBuilder()
Output only.int
getSerializedSize()
String
getServiceAccount()
The service account that the DeployedModel's container runs as.com.google.protobuf.ByteString
getServiceAccountBytes()
The service account that the DeployedModel's container runs as.com.google.protobuf.Timestamp
getStartTime()
Output only.com.google.protobuf.TimestampOrBuilder
getStartTimeOrBuilder()
Output only.JobState
getState()
Output only.int
getStateValue()
Output only.UnmanagedContainerModel
getUnmanagedContainerModel()
Contains model information necessary to perform batch prediction without requiring uploading to model registry.UnmanagedContainerModelOrBuilder
getUnmanagedContainerModelOrBuilder()
Contains model information necessary to perform batch prediction without requiring uploading to model registry.com.google.protobuf.Timestamp
getUpdateTime()
Output only.com.google.protobuf.TimestampOrBuilder
getUpdateTimeOrBuilder()
Output only.boolean
hasCompletionStats()
Output only.boolean
hasCreateTime()
Output only.boolean
hasDedicatedResources()
The config of resources used by the Model during the batch prediction.boolean
hasEncryptionSpec()
Customer-managed encryption key options for a BatchPredictionJob.boolean
hasEndTime()
Output only.boolean
hasError()
Output only.boolean
hasExplanationSpec()
Explanation configuration for this BatchPredictionJob.int
hashCode()
boolean
hasInputConfig()
Required.boolean
hasInstanceConfig()
Configuration for how to convert batch prediction input instances to the prediction instances that are sent to the Model.boolean
hasManualBatchTuningParameters()
Immutable.boolean
hasModelMonitoringConfig()
Model monitoring config will be used for analysis model behaviors, based on the input and output to the batch prediction job, as well as the provided training dataset.boolean
hasModelMonitoringStatus()
Output only.boolean
hasModelParameters()
The parameters that govern the predictions.boolean
hasOutputConfig()
Required.boolean
hasOutputInfo()
Output only.boolean
hasResourcesConsumed()
Output only.boolean
hasStartTime()
Output only.boolean
hasUnmanagedContainerModel()
Contains model information necessary to perform batch prediction without requiring uploading to model registry.boolean
hasUpdateTime()
Output only.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
protected com.google.protobuf.MapField
internalGetMapField(int number)
boolean
isInitialized()
static BatchPredictionJob.Builder
newBuilder()
static BatchPredictionJob.Builder
newBuilder(BatchPredictionJob prototype)
BatchPredictionJob.Builder
newBuilderForType()
protected BatchPredictionJob.Builder
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static BatchPredictionJob
parseDelimitedFrom(InputStream input)
static BatchPredictionJob
parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchPredictionJob
parseFrom(byte[] data)
static BatchPredictionJob
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchPredictionJob
parseFrom(com.google.protobuf.ByteString data)
static BatchPredictionJob
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchPredictionJob
parseFrom(com.google.protobuf.CodedInputStream input)
static BatchPredictionJob
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchPredictionJob
parseFrom(InputStream input)
static BatchPredictionJob
parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchPredictionJob
parseFrom(ByteBuffer data)
static BatchPredictionJob
parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<BatchPredictionJob>
parser()
BatchPredictionJob.Builder
toBuilder()
void
writeTo(com.google.protobuf.CodedOutputStream output)
-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
MODEL_FIELD_NUMBER
public static final int MODEL_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
-
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ERROR_FIELD_NUMBER
public static final int ERROR_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
-
END_TIME_FIELD_NUMBER
public static final int END_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
-
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ENCRYPTION_SPEC_FIELD_NUMBER
public static final int ENCRYPTION_SPEC_FIELD_NUMBER
- See Also:
- Constant Field Values
-
MODEL_MONITORING_CONFIG_FIELD_NUMBER
public static final int MODEL_MONITORING_CONFIG_FIELD_NUMBER
- See Also:
- Constant Field Values
-
MODEL_MONITORING_STATS_ANOMALIES_FIELD_NUMBER
public static final int MODEL_MONITORING_STATS_ANOMALIES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
MODEL_MONITORING_STATUS_FIELD_NUMBER
public static final int MODEL_MONITORING_STATUS_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 classcom.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 classcom.google.protobuf.GeneratedMessageV3
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.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 interfaceBatchPredictionJobOrBuilder
- 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 interfaceBatchPredictionJobOrBuilder
- 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 interfaceBatchPredictionJobOrBuilder
- 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 interfaceBatchPredictionJobOrBuilder
- 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 interfaceBatchPredictionJobOrBuilder
- 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 interfaceBatchPredictionJobOrBuilder
- 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 interfaceBatchPredictionJobOrBuilder
- 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 interfaceBatchPredictionJobOrBuilder
- 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.v1beta1.UnmanagedContainerModel unmanaged_container_model = 28;
- Specified by:
hasUnmanagedContainerModel
in interfaceBatchPredictionJobOrBuilder
- 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.v1beta1.UnmanagedContainerModel unmanaged_container_model = 28;
- Specified by:
getUnmanagedContainerModel
in interfaceBatchPredictionJobOrBuilder
- 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.v1beta1.UnmanagedContainerModel unmanaged_container_model = 28;
- Specified by:
getUnmanagedContainerModelOrBuilder
in interfaceBatchPredictionJobOrBuilder
-
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.v1beta1.BatchPredictionJob.model] [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata] [instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri].
.google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig input_config = 4 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
hasInputConfig
in interfaceBatchPredictionJobOrBuilder
- 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.v1beta1.BatchPredictionJob.model] [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata] [instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri].
.google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig input_config = 4 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getInputConfig
in interfaceBatchPredictionJobOrBuilder
- 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.v1beta1.BatchPredictionJob.model] [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata] [instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri].
.google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig input_config = 4 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getInputConfigOrBuilder
in interfaceBatchPredictionJobOrBuilder
-
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.v1beta1.BatchPredictionJob.InstanceConfig instance_config = 27;
- Specified by:
hasInstanceConfig
in interfaceBatchPredictionJobOrBuilder
- 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.v1beta1.BatchPredictionJob.InstanceConfig instance_config = 27;
- Specified by:
getInstanceConfig
in interfaceBatchPredictionJobOrBuilder
- Returns:
- The instanceConfig.
-
getInstanceConfigOrBuilder
public 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;
- Specified by:
getInstanceConfigOrBuilder
in interfaceBatchPredictionJobOrBuilder
-
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.v1beta1.BatchPredictionJob.model] [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata] [parameters_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri].
.google.protobuf.Value model_parameters = 5;
- Specified by:
hasModelParameters
in interfaceBatchPredictionJobOrBuilder
- 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.v1beta1.BatchPredictionJob.model] [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata] [parameters_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri].
.google.protobuf.Value model_parameters = 5;
- Specified by:
getModelParameters
in interfaceBatchPredictionJobOrBuilder
- 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.v1beta1.BatchPredictionJob.model] [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata] [parameters_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.parameters_schema_uri].
.google.protobuf.Value model_parameters = 5;
- Specified by:
getModelParametersOrBuilder
in interfaceBatchPredictionJobOrBuilder
-
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.v1beta1.BatchPredictionJob.model] [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata] [instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri] and [prediction_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.prediction_schema_uri].
.google.cloud.aiplatform.v1beta1.BatchPredictionJob.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
hasOutputConfig
in interfaceBatchPredictionJobOrBuilder
- 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.v1beta1.BatchPredictionJob.model] [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata] [instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri] and [prediction_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.prediction_schema_uri].
.google.cloud.aiplatform.v1beta1.BatchPredictionJob.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getOutputConfig
in interfaceBatchPredictionJobOrBuilder
- 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.v1beta1.BatchPredictionJob.model] [PredictSchemata's][google.cloud.aiplatform.v1beta1.Model.predict_schemata] [instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri] and [prediction_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.prediction_schema_uri].
.google.cloud.aiplatform.v1beta1.BatchPredictionJob.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getOutputConfigOrBuilder
in interfaceBatchPredictionJobOrBuilder
-
hasDedicatedResources
public boolean hasDedicatedResources()
The config of resources used by the Model during the batch prediction. If the Model [supports][google.cloud.aiplatform.v1beta1.Model.supported_deployment_resources_types] DEDICATED_RESOURCES this config may be provided (and the job will use these resources), if the Model doesn't support AUTOMATIC_RESOURCES, this config must be provided.
.google.cloud.aiplatform.v1beta1.BatchDedicatedResources dedicated_resources = 7;
- Specified by:
hasDedicatedResources
in interfaceBatchPredictionJobOrBuilder
- 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.v1beta1.Model.supported_deployment_resources_types] DEDICATED_RESOURCES this config may be provided (and the job will use these resources), if the Model doesn't support AUTOMATIC_RESOURCES, this config must be provided.
.google.cloud.aiplatform.v1beta1.BatchDedicatedResources dedicated_resources = 7;
- Specified by:
getDedicatedResources
in interfaceBatchPredictionJobOrBuilder
- 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.v1beta1.Model.supported_deployment_resources_types] DEDICATED_RESOURCES this config may be provided (and the job will use these resources), if the Model doesn't support AUTOMATIC_RESOURCES, this config must be provided.
.google.cloud.aiplatform.v1beta1.BatchDedicatedResources dedicated_resources = 7;
- Specified by:
getDedicatedResourcesOrBuilder
in interfaceBatchPredictionJobOrBuilder
-
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 interfaceBatchPredictionJobOrBuilder
- 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 interfaceBatchPredictionJobOrBuilder
- Returns:
- The bytes for serviceAccount.
-
hasManualBatchTuningParameters
public boolean hasManualBatchTuningParameters()
Immutable. Parameters configuring the batch behavior. Currently only applicable when [dedicated_resources][google.cloud.aiplatform.v1beta1.BatchPredictionJob.dedicated_resources] are used (in other cases Vertex AI does the tuning itself).
.google.cloud.aiplatform.v1beta1.ManualBatchTuningParameters manual_batch_tuning_parameters = 8 [(.google.api.field_behavior) = IMMUTABLE];
- Specified by:
hasManualBatchTuningParameters
in interfaceBatchPredictionJobOrBuilder
- 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.v1beta1.BatchPredictionJob.dedicated_resources] are used (in other cases Vertex AI does the tuning itself).
.google.cloud.aiplatform.v1beta1.ManualBatchTuningParameters manual_batch_tuning_parameters = 8 [(.google.api.field_behavior) = IMMUTABLE];
- Specified by:
getManualBatchTuningParameters
in interfaceBatchPredictionJobOrBuilder
- Returns:
- The manualBatchTuningParameters.
-
getManualBatchTuningParametersOrBuilder
public ManualBatchTuningParametersOrBuilder getManualBatchTuningParametersOrBuilder()
Immutable. Parameters configuring the batch behavior. Currently only applicable when [dedicated_resources][google.cloud.aiplatform.v1beta1.BatchPredictionJob.dedicated_resources] are used (in other cases Vertex AI does the tuning itself).
.google.cloud.aiplatform.v1beta1.ManualBatchTuningParameters manual_batch_tuning_parameters = 8 [(.google.api.field_behavior) = IMMUTABLE];
- Specified by:
getManualBatchTuningParametersOrBuilder
in interfaceBatchPredictionJobOrBuilder
-
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.v1beta1.BatchPredictionJob.output_config] object: * `bigquery`: output includes a column named `explanation`. The value is a struct that conforms to the [Explanation][google.cloud.aiplatform.v1beta1.Explanation] object. * `jsonl`: The JSON objects on each line include an additional entry keyed `explanation`. The value of the entry is a JSON object that conforms to the [Explanation][google.cloud.aiplatform.v1beta1.Explanation] object. * `csv`: Generating explanations for CSV format is not supported. If this field is set to true, either the [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec] or [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec] must be populated.
bool generate_explanation = 23;
- Specified by:
getGenerateExplanation
in interfaceBatchPredictionJobOrBuilder
- Returns:
- The generateExplanation.
-
hasExplanationSpec
public boolean hasExplanationSpec()
Explanation configuration for this BatchPredictionJob. Can be specified only if [generate_explanation][google.cloud.aiplatform.v1beta1.BatchPredictionJob.generate_explanation] is set to `true`. This value overrides the value of [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec]. All fields of [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec] are optional in the request. If a field of the [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec] object is not populated, the corresponding field of the [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec] object is inherited.
.google.cloud.aiplatform.v1beta1.ExplanationSpec explanation_spec = 25;
- Specified by:
hasExplanationSpec
in interfaceBatchPredictionJobOrBuilder
- 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.v1beta1.BatchPredictionJob.generate_explanation] is set to `true`. This value overrides the value of [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec]. All fields of [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec] are optional in the request. If a field of the [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec] object is not populated, the corresponding field of the [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec] object is inherited.
.google.cloud.aiplatform.v1beta1.ExplanationSpec explanation_spec = 25;
- Specified by:
getExplanationSpec
in interfaceBatchPredictionJobOrBuilder
- Returns:
- The explanationSpec.
-
getExplanationSpecOrBuilder
public ExplanationSpecOrBuilder getExplanationSpecOrBuilder()
Explanation configuration for this BatchPredictionJob. Can be specified only if [generate_explanation][google.cloud.aiplatform.v1beta1.BatchPredictionJob.generate_explanation] is set to `true`. This value overrides the value of [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec]. All fields of [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec] are optional in the request. If a field of the [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec] object is not populated, the corresponding field of the [Model.explanation_spec][google.cloud.aiplatform.v1beta1.Model.explanation_spec] object is inherited.
.google.cloud.aiplatform.v1beta1.ExplanationSpec explanation_spec = 25;
- Specified by:
getExplanationSpecOrBuilder
in interfaceBatchPredictionJobOrBuilder
-
hasOutputInfo
public 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];
- Specified by:
hasOutputInfo
in interfaceBatchPredictionJobOrBuilder
- 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.v1beta1.BatchPredictionJob.OutputInfo output_info = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getOutputInfo
in interfaceBatchPredictionJobOrBuilder
- Returns:
- The outputInfo.
-
getOutputInfoOrBuilder
public 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];
- Specified by:
getOutputInfoOrBuilder
in interfaceBatchPredictionJobOrBuilder
-
getStateValue
public int getStateValue()
Output only. The detailed state of the job.
.google.cloud.aiplatform.v1beta1.JobState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getStateValue
in interfaceBatchPredictionJobOrBuilder
- 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.v1beta1.JobState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getState
in interfaceBatchPredictionJobOrBuilder
- 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 interfaceBatchPredictionJobOrBuilder
- 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 interfaceBatchPredictionJobOrBuilder
- 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 interfaceBatchPredictionJobOrBuilder
-
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 interfaceBatchPredictionJobOrBuilder
-
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 interfaceBatchPredictionJobOrBuilder
-
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 interfaceBatchPredictionJobOrBuilder
-
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 interfaceBatchPredictionJobOrBuilder
-
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 interfaceBatchPredictionJobOrBuilder
-
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.v1beta1.ResourcesConsumed resources_consumed = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
hasResourcesConsumed
in interfaceBatchPredictionJobOrBuilder
- 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.v1beta1.ResourcesConsumed resources_consumed = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getResourcesConsumed
in interfaceBatchPredictionJobOrBuilder
- 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.v1beta1.ResourcesConsumed resources_consumed = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getResourcesConsumedOrBuilder
in interfaceBatchPredictionJobOrBuilder
-
hasCompletionStats
public 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];
- Specified by:
hasCompletionStats
in interfaceBatchPredictionJobOrBuilder
- Returns:
- Whether the completionStats field is set.
-
getCompletionStats
public 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];
- Specified by:
getCompletionStats
in interfaceBatchPredictionJobOrBuilder
- Returns:
- The completionStats.
-
getCompletionStatsOrBuilder
public 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];
- Specified by:
getCompletionStatsOrBuilder
in interfaceBatchPredictionJobOrBuilder
-
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 interfaceBatchPredictionJobOrBuilder
- 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 interfaceBatchPredictionJobOrBuilder
- 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 interfaceBatchPredictionJobOrBuilder
-
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 interfaceBatchPredictionJobOrBuilder
- 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 interfaceBatchPredictionJobOrBuilder
- 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 interfaceBatchPredictionJobOrBuilder
-
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 interfaceBatchPredictionJobOrBuilder
- 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 interfaceBatchPredictionJobOrBuilder
- 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 interfaceBatchPredictionJobOrBuilder
-
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 interfaceBatchPredictionJobOrBuilder
- 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 interfaceBatchPredictionJobOrBuilder
- 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 interfaceBatchPredictionJobOrBuilder
-
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 interfaceBatchPredictionJobOrBuilder
-
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 interfaceBatchPredictionJobOrBuilder
-
getLabels
@Deprecated public Map<String,String> getLabels()
Deprecated.UsegetLabelsMap()
instead.- Specified by:
getLabels
in interfaceBatchPredictionJobOrBuilder
-
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 interfaceBatchPredictionJobOrBuilder
-
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 interfaceBatchPredictionJobOrBuilder
-
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 interfaceBatchPredictionJobOrBuilder
-
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.v1beta1.EncryptionSpec encryption_spec = 24;
- Specified by:
hasEncryptionSpec
in interfaceBatchPredictionJobOrBuilder
- 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.v1beta1.EncryptionSpec encryption_spec = 24;
- Specified by:
getEncryptionSpec
in interfaceBatchPredictionJobOrBuilder
- 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.v1beta1.EncryptionSpec encryption_spec = 24;
- Specified by:
getEncryptionSpecOrBuilder
in interfaceBatchPredictionJobOrBuilder
-
hasModelMonitoringConfig
public 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;
- Specified by:
hasModelMonitoringConfig
in interfaceBatchPredictionJobOrBuilder
- Returns:
- Whether the modelMonitoringConfig field is set.
-
getModelMonitoringConfig
public 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;
- Specified by:
getModelMonitoringConfig
in interfaceBatchPredictionJobOrBuilder
- Returns:
- The modelMonitoringConfig.
-
getModelMonitoringConfigOrBuilder
public 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;
- Specified by:
getModelMonitoringConfigOrBuilder
in interfaceBatchPredictionJobOrBuilder
-
getModelMonitoringStatsAnomaliesList
public List<ModelMonitoringStatsAnomalies> getModelMonitoringStatsAnomaliesList()
Get batch prediction job monitoring statistics.
repeated .google.cloud.aiplatform.v1beta1.ModelMonitoringStatsAnomalies model_monitoring_stats_anomalies = 31;
- Specified by:
getModelMonitoringStatsAnomaliesList
in interfaceBatchPredictionJobOrBuilder
-
getModelMonitoringStatsAnomaliesOrBuilderList
public List<? extends ModelMonitoringStatsAnomaliesOrBuilder> getModelMonitoringStatsAnomaliesOrBuilderList()
Get batch prediction job monitoring statistics.
repeated .google.cloud.aiplatform.v1beta1.ModelMonitoringStatsAnomalies model_monitoring_stats_anomalies = 31;
- Specified by:
getModelMonitoringStatsAnomaliesOrBuilderList
in interfaceBatchPredictionJobOrBuilder
-
getModelMonitoringStatsAnomaliesCount
public int getModelMonitoringStatsAnomaliesCount()
Get batch prediction job monitoring statistics.
repeated .google.cloud.aiplatform.v1beta1.ModelMonitoringStatsAnomalies model_monitoring_stats_anomalies = 31;
- Specified by:
getModelMonitoringStatsAnomaliesCount
in interfaceBatchPredictionJobOrBuilder
-
getModelMonitoringStatsAnomalies
public ModelMonitoringStatsAnomalies getModelMonitoringStatsAnomalies(int index)
Get batch prediction job monitoring statistics.
repeated .google.cloud.aiplatform.v1beta1.ModelMonitoringStatsAnomalies model_monitoring_stats_anomalies = 31;
- Specified by:
getModelMonitoringStatsAnomalies
in interfaceBatchPredictionJobOrBuilder
-
getModelMonitoringStatsAnomaliesOrBuilder
public ModelMonitoringStatsAnomaliesOrBuilder getModelMonitoringStatsAnomaliesOrBuilder(int index)
Get batch prediction job monitoring statistics.
repeated .google.cloud.aiplatform.v1beta1.ModelMonitoringStatsAnomalies model_monitoring_stats_anomalies = 31;
- Specified by:
getModelMonitoringStatsAnomaliesOrBuilder
in interfaceBatchPredictionJobOrBuilder
-
hasModelMonitoringStatus
public 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];
- Specified by:
hasModelMonitoringStatus
in interfaceBatchPredictionJobOrBuilder
- Returns:
- Whether the modelMonitoringStatus field is set.
-
getModelMonitoringStatus
public com.google.rpc.Status getModelMonitoringStatus()
Output only. The running status of the model monitoring pipeline.
.google.rpc.Status model_monitoring_status = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getModelMonitoringStatus
in interfaceBatchPredictionJobOrBuilder
- Returns:
- The modelMonitoringStatus.
-
getModelMonitoringStatusOrBuilder
public com.google.rpc.StatusOrBuilder getModelMonitoringStatusOrBuilder()
Output only. The running status of the model monitoring pipeline.
.google.rpc.Status model_monitoring_status = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
- Specified by:
getModelMonitoringStatusOrBuilder
in interfaceBatchPredictionJobOrBuilder
-
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 interfaceBatchPredictionJobOrBuilder
- Returns:
- The disableContainerLogging.
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.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(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static BatchPredictionJob parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static BatchPredictionJob parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static BatchPredictionJob parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static BatchPredictionJob parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
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 interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static BatchPredictionJob.Builder newBuilder()
-
newBuilder
public static BatchPredictionJob.Builder newBuilder(BatchPredictionJob prototype)
-
toBuilder
public BatchPredictionJob.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected BatchPredictionJob.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static BatchPredictionJob getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<BatchPredictionJob> parser()
-
getParserForType
public com.google.protobuf.Parser<BatchPredictionJob> getParserForType()
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public BatchPredictionJob getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-