GoogleCloudAiplatformV1PipelineJob

import type { GoogleCloudAiplatformV1PipelineJob } from "https://googleapis.deno.dev/v1/aiplatform:v1.ts";

An instance of a machine learning PipelineJob.

interface GoogleCloudAiplatformV1PipelineJob {

readonly createTime?: Date;

displayName?: string;

encryptionSpec?: GoogleCloudAiplatformV1EncryptionSpec;

readonly endTime?: Date;

readonly error?: GoogleRpcStatus;

readonly jobDetail?: GoogleCloudAiplatformV1PipelineJobDetail;

labels?: {

[key: string]: string;

};

readonly name?: string;

network?: string;

pipelineSpec?: {

[key: string]: any;

};

reservedIpRanges?: string[];

runtimeConfig?: GoogleCloudAiplatformV1PipelineJobRuntimeConfig;

readonly scheduleName?: string;

serviceAccount?: string;

readonly startTime?: Date;

readonly state?:

| "PIPELINE_STATE_UNSPECIFIED"

| "PIPELINE_STATE_QUEUED"

| "PIPELINE_STATE_PENDING"

| "PIPELINE_STATE_RUNNING"

| "PIPELINE_STATE_SUCCEEDED"

| "PIPELINE_STATE_FAILED"

| "PIPELINE_STATE_CANCELLING"

| "PIPELINE_STATE_CANCELLED"

| "PIPELINE_STATE_PAUSED";

readonly templateMetadata?: GoogleCloudAiplatformV1PipelineTemplateMetadata;

templateUri?: string;

readonly updateTime?: Date;

}

§Properties

readonly createTime?: Date

[src]

Output only. Pipeline creation time.

displayName?: string

[src]

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

encryptionSpec?: GoogleCloudAiplatformV1EncryptionSpec

[src]

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 endTime?: Date

[src]

Output only. Pipeline end time.

readonly error?: GoogleRpcStatus

[src]

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

readonly jobDetail?: GoogleCloudAiplatformV1PipelineJobDetail

[src]

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

labels?: {

[key: string]: string;

}

[src]

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 name?: string

[src]

Output only. The resource name of the PipelineJob.

network?: string

[src]

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.

pipelineSpec?: {

[key: string]: any;

}

[src]

The spec of the pipeline.

reservedIpRanges?: string[]

[src]

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'].

runtimeConfig?: GoogleCloudAiplatformV1PipelineJobRuntimeConfig

[src]

Runtime config of the pipeline.

readonly scheduleName?: string

[src]

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

serviceAccount?: string

[src]

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 startTime?: Date

[src]

Output only. Pipeline start time.

[src]

Output only. The detailed state of the job.

readonly templateMetadata?: GoogleCloudAiplatformV1PipelineTemplateMetadata

[src]

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

templateUri?: string

[src]

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 updateTime?: Date

[src]

Output only. Timestamp when this PipelineJob was most recently updated.