PipelineJob class

Creates a PipelineJob. A PipelineJob will run immediately when created. Auto-naming is currently not supported for this resource.

Constructors

PipelineJob(String name, {PipelineJobArgs? args, CustomResourceOptions? options})

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

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

Pipeline creation time.

late, final

displayName ↔ Output<String>

The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.

late, final

encryptionSpec ↔ Output<GoogleCloudAiplatformV1EncryptionSpecResponse>

Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key.

late, final

endTime ↔ Output<String>

Pipeline end time.

late, final

error ↔ Output<GoogleRpcStatusResponse>

The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

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

jobDetail ↔ Output<GoogleCloudAiplatformV1PipelineJobDetailResponse>

The details of pipeline run. Not available in the list view.

late, final

labels ↔ Output<Map<String, String>>

The labels with user-defined metadata to organize PipelineJob. 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. Note there is some reserved label key for Vertex AI Pipelines. - vertex-ai-pipelines-run-billing-id, user set value will get overrided.

late, final

location ↔ Output<String>

late, final

name ↔ Output<String>

The resource name of the PipelineJob.

late, final

network ↔ Output<String>

The full name of the Compute Engine network to which the Pipeline Job's workload should be peered. For example, projects/12345/global/networks/myVPC. Format is of the form projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network.

late, final

pipelineJobId ↔ Output<String?>

The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are /a-z-/.

late, final

pipelineSpec ↔ Output<Map<String, String>>

The spec of the pipeline.

late, final

project ↔ Output<String>

late, final

reservedIpRanges ↔ Output<List<String>>

A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: 'vertex-ai-ip-range'.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeConfig ↔ Output<GoogleCloudAiplatformV1PipelineJobRuntimeConfigResponse>

Runtime config of the pipeline.

late, final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

scheduleName ↔ Output<String>

The schedule resource name. Only returned if the Pipeline is created by Schedule API.

late, final

serviceAccount ↔ Output<String>

The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the iam.serviceAccounts.actAs permission on this service account.

late, final

startTime ↔ Output<String>

Pipeline start time.

late, final

state ↔ Output<String>

The detailed state of the job.

late, final

templateMetadata ↔ Output<GoogleCloudAiplatformV1PipelineTemplateMetadataResponse>

Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.

late, final

templateUri ↔ Output<String>

A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported. Reference to https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

updateTime ↔ Output<String>

Timestamp when this PipelineJob 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