import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../../types/input"; import * as outputs from "../../types/output"; /** * Creates a PipelineJob. A PipelineJob will run immediately when created. * Auto-naming is currently not supported for this resource. */ export declare class PipelineJob extends pulumi.CustomResource { /** * Get an existing PipelineJob resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, opts?: pulumi.CustomResourceOptions): PipelineJob; /** * Returns true if the given object is an instance of PipelineJob. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is PipelineJob; /** * Pipeline creation time. */ readonly createTime: pulumi.Output; /** * The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters. */ readonly displayName: pulumi.Output; /** * Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key. */ readonly encryptionSpec: pulumi.Output; /** * Pipeline end time. */ readonly endTime: pulumi.Output; /** * The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED. */ readonly error: pulumi.Output; /** * The details of pipeline run. Not available in the list view. */ readonly jobDetail: pulumi.Output; /** * 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. */ readonly labels: pulumi.Output<{ [key: string]: string; }>; readonly location: pulumi.Output; /** * The resource name of the PipelineJob. */ readonly name: pulumi.Output; /** * The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Pipeline Job's workload should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) 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. */ readonly network: pulumi.Output; /** * 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-/`. */ readonly pipelineJobId: pulumi.Output; /** * The spec of the pipeline. */ readonly pipelineSpec: pulumi.Output<{ [key: string]: string; }>; readonly project: pulumi.Output; /** * 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']. */ readonly reservedIpRanges: pulumi.Output; /** * Runtime config of the pipeline. */ readonly runtimeConfig: pulumi.Output; /** * The schedule resource name. Only returned if the Pipeline is created by Schedule API. */ readonly scheduleName: pulumi.Output; /** * 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. */ readonly serviceAccount: pulumi.Output; /** * Pipeline start time. */ readonly startTime: pulumi.Output; /** * The detailed state of the job. */ readonly state: pulumi.Output; /** * Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry. */ readonly templateMetadata: pulumi.Output; /** * 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. */ readonly templateUri: pulumi.Output; /** * Timestamp when this PipelineJob was most recently updated. */ readonly updateTime: pulumi.Output; /** * Create a PipelineJob resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args?: PipelineJobArgs, opts?: pulumi.CustomResourceOptions); } /** * The set of arguments for constructing a PipelineJob resource. */ export interface PipelineJobArgs { /** * The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters. */ displayName?: pulumi.Input; /** * Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key. */ encryptionSpec?: pulumi.Input; /** * 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. */ labels?: pulumi.Input<{ [key: string]: pulumi.Input; }>; location?: pulumi.Input; /** * The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Pipeline Job's workload should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) 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. */ network?: pulumi.Input; /** * 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-/`. */ pipelineJobId?: pulumi.Input; /** * The spec of the pipeline. */ pipelineSpec?: pulumi.Input<{ [key: string]: pulumi.Input; }>; project?: pulumi.Input; /** * 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']. */ reservedIpRanges?: pulumi.Input[]>; /** * Runtime config of the pipeline. */ runtimeConfig?: pulumi.Input; /** * 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. */ serviceAccount?: pulumi.Input; /** * 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. */ templateUri?: pulumi.Input; }