Class BatchPredictionJob (3.17.0)

Version 3.17.0

• 3.55.0 (latest)
• 3.54.0
• 3.53.0
• 3.52.0
• 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 final class BatchPredictionJob extends GeneratedMessageV3 implements BatchPredictionJobOrBuilder

A job that uses a Model to produce predictions on multiple input instances. If predictions for significant portion of the instances fail, the job may finish without attempting predictions for all remaining instances.

Protobuf type google.cloud.aiplatform.v1.BatchPredictionJob

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > BatchPredictionJob

Implements

BatchPredictionJobOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

COMPLETION_STATS_FIELD_NUMBER

public static final int COMPLETION_STATS_FIELD_NUMBER

Field Value
Type	Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

Field Value
Type	Description
int

DEDICATED_RESOURCES_FIELD_NUMBER

public static final int DEDICATED_RESOURCES_FIELD_NUMBER

Field Value
Type	Description
int

DISABLE_CONTAINER_LOGGING_FIELD_NUMBER

public static final int DISABLE_CONTAINER_LOGGING_FIELD_NUMBER

Field Value
Type	Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

Field Value
Type	Description
int

ENCRYPTION_SPEC_FIELD_NUMBER

public static final int ENCRYPTION_SPEC_FIELD_NUMBER

Field Value
Type	Description
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER

Field Value
Type	Description
int

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER

Field Value
Type	Description
int

EXPLANATION_SPEC_FIELD_NUMBER

public static final int EXPLANATION_SPEC_FIELD_NUMBER

Field Value
Type	Description
int

GENERATE_EXPLANATION_FIELD_NUMBER

public static final int GENERATE_EXPLANATION_FIELD_NUMBER

Field Value
Type	Description
int

INPUT_CONFIG_FIELD_NUMBER

public static final int INPUT_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

INSTANCE_CONFIG_FIELD_NUMBER

public static final int INSTANCE_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER

Field Value
Type	Description
int

MANUAL_BATCH_TUNING_PARAMETERS_FIELD_NUMBER

public static final int MANUAL_BATCH_TUNING_PARAMETERS_FIELD_NUMBER

Field Value
Type	Description
int

MODEL_FIELD_NUMBER

public static final int MODEL_FIELD_NUMBER

Field Value
Type	Description
int

MODEL_PARAMETERS_FIELD_NUMBER

public static final int MODEL_PARAMETERS_FIELD_NUMBER

Field Value
Type	Description
int

MODEL_VERSION_ID_FIELD_NUMBER

public static final int MODEL_VERSION_ID_FIELD_NUMBER

Field Value
Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
int

OUTPUT_CONFIG_FIELD_NUMBER

public static final int OUTPUT_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

OUTPUT_INFO_FIELD_NUMBER

public static final int OUTPUT_INFO_FIELD_NUMBER

Field Value
Type	Description
int

PARTIAL_FAILURES_FIELD_NUMBER

public static final int PARTIAL_FAILURES_FIELD_NUMBER

Field Value
Type	Description
int

RESOURCES_CONSUMED_FIELD_NUMBER

public static final int RESOURCES_CONSUMED_FIELD_NUMBER

Field Value
Type	Description
int

SERVICE_ACCOUNT_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_FIELD_NUMBER

Field Value
Type	Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER

Field Value
Type	Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

Field Value
Type	Description
int

UNMANAGED_CONTAINER_MODEL_FIELD_NUMBER

public static final int UNMANAGED_CONTAINER_MODEL_FIELD_NUMBER

Field Value
Type	Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static BatchPredictionJob getDefaultInstance()

Returns
Type	Description
BatchPredictionJob

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static BatchPredictionJob.Builder newBuilder()

Returns
Type	Description
BatchPredictionJob.Builder

newBuilder(BatchPredictionJob prototype)

public static BatchPredictionJob.Builder newBuilder(BatchPredictionJob prototype)

Parameter
Name	Description
prototype	BatchPredictionJob

Returns
Type	Description
BatchPredictionJob.Builder

parseDelimitedFrom(InputStream input)

public static BatchPredictionJob parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
BatchPredictionJob

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchPredictionJob parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchPredictionJob

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static BatchPredictionJob parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
BatchPredictionJob

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BatchPredictionJob parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchPredictionJob

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BatchPredictionJob parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
BatchPredictionJob

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BatchPredictionJob parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchPredictionJob

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BatchPredictionJob parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
BatchPredictionJob

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchPredictionJob parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchPredictionJob

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static BatchPredictionJob parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
BatchPredictionJob

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchPredictionJob parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchPredictionJob

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static BatchPredictionJob parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
BatchPredictionJob

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BatchPredictionJob parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchPredictionJob

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<BatchPredictionJob> parser()

Returns
Type	Description
Parser<BatchPredictionJob>

Methods

containsLabels(String key)

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;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getCompletionStats()

public CompletionStats getCompletionStats()

Output only. Statistics on completed and failed prediction instances.

.google.cloud.aiplatform.v1.CompletionStats completion_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
CompletionStats	The completionStats.

getCompletionStatsOrBuilder()

public CompletionStatsOrBuilder getCompletionStatsOrBuilder()

Output only. Statistics on completed and failed prediction instances.

.google.cloud.aiplatform.v1.CompletionStats completion_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
CompletionStatsOrBuilder

getCreateTime()

public 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 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 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.v1.BatchDedicatedResources dedicated_resources = 7;

Returns
Type	Description
BatchDedicatedResources	The dedicatedResources.

getDedicatedResourcesOrBuilder()

public 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.v1.BatchDedicatedResources dedicated_resources = 7;

Returns
Type	Description
BatchDedicatedResourcesOrBuilder

getDefaultInstanceForType()

public BatchPredictionJob getDefaultInstanceForType()

Returns
Type	Description
BatchPredictionJob

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 Stackdriver 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 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 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 EncryptionSpec getEncryptionSpec()

Customer-managed encryption key options for a BatchPredictionJob. If this is set, then all resources created by the BatchPredictionJob will be encrypted with the provided encryption key.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 24;

Returns
Type	Description
EncryptionSpec	The encryptionSpec.

getEncryptionSpecOrBuilder()

public EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()

Customer-managed encryption key options for a BatchPredictionJob. If this is set, then all resources created by the BatchPredictionJob will be encrypted with the provided encryption key.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 24;

Returns
Type	Description
EncryptionSpecOrBuilder

getEndTime()

public 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 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 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 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 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.v1.ExplanationSpec explanation_spec = 25;

Returns
Type	Description
ExplanationSpec	The explanationSpec.

getExplanationSpecOrBuilder()

public 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.v1.ExplanationSpec explanation_spec = 25;

Returns
Type	Description
ExplanationSpecOrBuilder

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 object:

• bigquery: output includes a column named explanation. The value is a struct that conforms to the Explanation object.
• jsonl: The JSON objects on each line include an additional entry keyed explanation. The value of the entry is a JSON object that conforms to the Explanation object.
• csv: Generating explanations for CSV format is not supported. If this field is set to true, either the Model.explanation_spec or explanation_spec must be populated.

bool generate_explanation = 23;

Returns
Type	Description
boolean	The generateExplanation.

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 PredictSchemata's instance_schema_uri.

.google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig input_config = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
BatchPredictionJob.InputConfig	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 PredictSchemata's instance_schema_uri.

.google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig input_config = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
BatchPredictionJob.InputConfigOrBuilder

getInstanceConfig()

public BatchPredictionJob.InstanceConfig getInstanceConfig()

Configuration for how to convert batch prediction input instances to the prediction instances that are sent to the Model.

.google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig instance_config = 27;

Returns
Type	Description
BatchPredictionJob.InstanceConfig	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.v1.BatchPredictionJob.InstanceConfig instance_config = 27;

Returns
Type	Description
BatchPredictionJob.InstanceConfigOrBuilder

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public 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 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 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 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 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.v1.ManualBatchTuningParameters manual_batch_tuning_parameters = 8 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
ManualBatchTuningParameters	The manualBatchTuningParameters.

getManualBatchTuningParametersOrBuilder()

public 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.v1.ManualBatchTuningParameters manual_batch_tuning_parameters = 8 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
ManualBatchTuningParametersOrBuilder

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.

string model = 3 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The model.

getModelBytes()

public 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.

getModelParameters()

public 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 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 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 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 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 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 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.v1.BatchPredictionJob.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
BatchPredictionJob.OutputConfig	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 PredictSchemata's instance_schema_uri and prediction_schema_uri.

.google.cloud.aiplatform.v1.BatchPredictionJob.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
BatchPredictionJob.OutputConfigOrBuilder

getOutputInfo()

public BatchPredictionJob.OutputInfo getOutputInfo()

Output only. Information further describing the output of this job.

.google.cloud.aiplatform.v1.BatchPredictionJob.OutputInfo output_info = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
BatchPredictionJob.OutputInfo	The outputInfo.

getOutputInfoOrBuilder()

public BatchPredictionJob.OutputInfoOrBuilder getOutputInfoOrBuilder()

Output only. Information further describing the output of this job.

.google.cloud.aiplatform.v1.BatchPredictionJob.OutputInfo output_info = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
BatchPredictionJob.OutputInfoOrBuilder

getParserForType()

public Parser<BatchPredictionJob> getParserForType()

Returns
Type	Description
Parser<BatchPredictionJob>

Overrides

GeneratedMessageV3.getParserForType()

getPartialFailures(int index)

public 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 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 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 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 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 ResourcesConsumed getResourcesConsumed()

Output only. Information about resources that had been consumed by this job. Provided in real time at best effort basis, as well as a final value once the job completes. Note: This field currently may be not populated for batch predictions that use AutoML Models.

.google.cloud.aiplatform.v1.ResourcesConsumed resources_consumed = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ResourcesConsumed	The resourcesConsumed.

getResourcesConsumedOrBuilder()

public ResourcesConsumedOrBuilder getResourcesConsumedOrBuilder()

Output only. Information about resources that had been consumed by this job. Provided in real time at best effort basis, as well as a final value once the job completes. Note: This field currently may be not populated for batch predictions that use AutoML Models.

.google.cloud.aiplatform.v1.ResourcesConsumed resources_consumed = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ResourcesConsumedOrBuilder

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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;

Returns
Type	Description
String	The serviceAccount.

getServiceAccountBytes()

public 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 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 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 JobState getState()

Output only. The detailed state of the job.

.google.cloud.aiplatform.v1.JobState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
JobState	The state.

getStateValue()

public int getStateValue()

Output only. The detailed state of the job.

.google.cloud.aiplatform.v1.JobState state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for state.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns
Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

getUnmanagedContainerModel()

public UnmanagedContainerModel getUnmanagedContainerModel()

Contains model information necessary to perform batch prediction without requiring uploading to model registry. Exactly one of model and unmanaged_container_model must be set.

.google.cloud.aiplatform.v1.UnmanagedContainerModel unmanaged_container_model = 28;

Returns
Type	Description
UnmanagedContainerModel	The unmanagedContainerModel.

getUnmanagedContainerModelOrBuilder()

public UnmanagedContainerModelOrBuilder getUnmanagedContainerModelOrBuilder()

Contains model information necessary to perform batch prediction without requiring uploading to model registry. Exactly one of model and unmanaged_container_model must be set.

.google.cloud.aiplatform.v1.UnmanagedContainerModel unmanaged_container_model = 28;

Returns
Type	Description
UnmanagedContainerModelOrBuilder

getUpdateTime()

public 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 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 boolean hasCompletionStats()

Output only. Statistics on completed and failed prediction instances.

.google.cloud.aiplatform.v1.CompletionStats completion_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the completionStats field is set.

hasCreateTime()

public 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 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.v1.BatchDedicatedResources dedicated_resources = 7;

Returns
Type	Description
boolean	Whether the dedicatedResources field is set.

hasEncryptionSpec()

public boolean hasEncryptionSpec()

Customer-managed encryption key options for a BatchPredictionJob. If this is set, then all resources created by the BatchPredictionJob will be encrypted with the provided encryption key.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 24;

Returns
Type	Description
boolean	Whether the encryptionSpec field is set.

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];

Returns
Type	Description
boolean	Whether the endTime field is set.

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];

Returns
Type	Description
boolean	Whether the error field is set.

hasExplanationSpec()

public 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.v1.ExplanationSpec explanation_spec = 25;

Returns
Type	Description
boolean	Whether the explanationSpec field is set.

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 PredictSchemata's instance_schema_uri.

.google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig input_config = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the inputConfig field is set.

hasInstanceConfig()

public boolean hasInstanceConfig()

Configuration for how to convert batch prediction input instances to the prediction instances that are sent to the Model.

.google.cloud.aiplatform.v1.BatchPredictionJob.InstanceConfig instance_config = 27;

Returns
Type	Description
boolean	Whether the instanceConfig field is set.

hasManualBatchTuningParameters()

public 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.v1.ManualBatchTuningParameters manual_batch_tuning_parameters = 8 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
boolean	Whether the manualBatchTuningParameters field is set.

hasModelParameters()

public 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 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.v1.BatchPredictionJob.OutputConfig output_config = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the outputConfig field is set.

hasOutputInfo()

public boolean hasOutputInfo()

Output only. Information further describing the output of this job.

.google.cloud.aiplatform.v1.BatchPredictionJob.OutputInfo output_info = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the outputInfo field is set.

hasResourcesConsumed()

public boolean hasResourcesConsumed()

Output only. Information about resources that had been consumed by this job. Provided in real time at best effort basis, as well as a final value once the job completes. Note: This field currently may be not populated for batch predictions that use AutoML Models.

.google.cloud.aiplatform.v1.ResourcesConsumed resources_consumed = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the resourcesConsumed field is set.

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];

Returns
Type	Description
boolean	Whether the startTime field is set.

hasUnmanagedContainerModel()

public boolean hasUnmanagedContainerModel()

Contains model information necessary to perform batch prediction without requiring uploading to model registry. Exactly one of model and unmanaged_container_model must be set.

.google.cloud.aiplatform.v1.UnmanagedContainerModel unmanaged_container_model = 28;

Returns
Type	Description
boolean	Whether the unmanagedContainerModel field is set.

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];

Returns
Type	Description
boolean	Whether the updateTime field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
MapField

Overrides

GeneratedMessageV3.internalGetMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public BatchPredictionJob.Builder newBuilderForType()

Returns
Type	Description
BatchPredictionJob.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BatchPredictionJob.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
BatchPredictionJob.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public BatchPredictionJob.Builder toBuilder()

Returns
Type	Description
BatchPredictionJob.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException