BatchPredictionJob class

Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start. Auto-naming is currently not supported for this resource.

Constructors

BatchPredictionJob(String name, {BatchPredictionJobArgs? args, CustomResourceOptions? options})

Creates a new BatchPredictionJob. name The Pulumi resource name. args Arguments used to configure this BatchPredictionJob. The set of arguments for BatchPredictionJob. options Resource options controlling this resource's behavior.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

completionStats ↔ Output<GoogleCloudAiplatformV1CompletionStatsResponse>

Statistics on completed and failed prediction instances.

late, final

createTime ↔ Output<String>

Time when the BatchPredictionJob was created.

late, final

dedicatedResources ↔ Output<GoogleCloudAiplatformV1BatchDedicatedResourcesResponse>

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.

late, final

disableContainerLogging ↔ Output<bool>

For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send stderr and stdout streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to Cloud Logging pricing. User can disable container logging by setting this flag to true.

late, final

displayName ↔ Output<String>

The user-defined name of this BatchPredictionJob.

late, final

encryptionSpec ↔ Output<GoogleCloudAiplatformV1EncryptionSpecResponse>

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.

late, final

endTime ↔ Output<String>

Time when the BatchPredictionJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.

late, final

error ↔ Output<GoogleRpcStatusResponse>

Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

late, final

explanationSpec ↔ Output<GoogleCloudAiplatformV1ExplanationSpecResponse>

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.

late, final

generateExplanation ↔ Output<bool>

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

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

inputConfig ↔ Output<GoogleCloudAiplatformV1BatchPredictionJobInputConfigResponse>

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.

late, final

instanceConfig ↔ Output<GoogleCloudAiplatformV1BatchPredictionJobInstanceConfigResponse>

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

late, final

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

labels ↔ Output<Map<String, String>>

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.

late, final

location ↔ Output<String>

late, final

manualBatchTuningParameters ↔ Output<GoogleCloudAiplatformV1ManualBatchTuningParametersResponse>

Immutable. Parameters configuring the batch behavior. Currently only applicable when dedicated_resources are used (in other cases Vertex AI does the tuning itself).

late, final

model ↔ Output<String>

The name of the Model resource that produces the predictions via this job, must share the same ancestor Location. Starting this job has no impact on any existing deployments of the Model and their resources. Exactly one of model and unmanaged_container_model must be set. The model resource name may contain version id or version alias to specify the version. Example: projects/{project}/locations/{location}/models/{model}@2 or projects/{project}/locations/{location}/models/{model}@golden if no version is specified, the default version will be deployed. The model resource could also be a publisher model. Example: publishers/{publisher}/models/{model} or projects/{project}/locations/{location}/publishers/{publisher}/models/{model}

late, final

modelParameters ↔ Output

The parameters that govern the predictions. The schema of the parameters may be specified via the Model's PredictSchemata's parameters_schema_uri.

late, final

modelVersionId ↔ Output<String>

The version ID of the Model that produces the predictions via this job.

late, final

name ↔ Output<String>

Resource name of the BatchPredictionJob.

late, final

outputConfig ↔ Output<GoogleCloudAiplatformV1BatchPredictionJobOutputConfigResponse>

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.

late, final

outputInfo ↔ Output<GoogleCloudAiplatformV1BatchPredictionJobOutputInfoResponse>

Information further describing the output of this job.

late, final

partialFailures ↔ Output<List<Map<String, dynamic>>>

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.

late, final

project ↔ Output<String>

late, final

resourcesConsumed ↔ Output<GoogleCloudAiplatformV1ResourcesConsumedResponse>

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.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

serviceAccount ↔ Output<String>

The service account that the DeployedModel's container runs as. If not specified, a system generated one will be used, which has minimal permissions and the custom container, if used, may not have enough permission to access other Google Cloud resources. Users deploying the Model must have the iam.serviceAccounts.actAs permission on this service account.

late, final

startTime ↔ Output<String>

Time when the BatchPredictionJob for the first time entered the JOB_STATE_RUNNING state.

late, final

state ↔ Output<String>

The detailed state of the job.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

unmanagedContainerModel ↔ Output<GoogleCloudAiplatformV1UnmanagedContainerModelResponse>

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.

late, final

updateTime ↔ Output<String>

Time when the BatchPredictionJob was most recently updated.

late, final

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited