GoogleCloudAiplatformV1CustomJob

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

Represents a job that runs custom workloads such as a Docker container or a Python package. A CustomJob can have multiple worker pools and each worker pool can have its own machine and input spec. A CustomJob will be cleaned up once the job enters terminal state (failed or succeeded).

interface GoogleCloudAiplatformV1CustomJob {

readonly createTime?: Date;

displayName?: string;

encryptionSpec?: GoogleCloudAiplatformV1EncryptionSpec;

readonly endTime?: Date;

readonly error?: GoogleRpcStatus;

jobSpec?: GoogleCloudAiplatformV1CustomJobSpec;

labels?: {

[key: string]: string;

};

readonly name?: string;

readonly startTime?: Date;

readonly state?:

| "JOB_STATE_UNSPECIFIED"

| "JOB_STATE_QUEUED"

| "JOB_STATE_PENDING"

| "JOB_STATE_RUNNING"

| "JOB_STATE_SUCCEEDED"

| "JOB_STATE_FAILED"

| "JOB_STATE_CANCELLING"

| "JOB_STATE_CANCELLED"

| "JOB_STATE_PAUSED"

| "JOB_STATE_EXPIRED"

| "JOB_STATE_UPDATING"

| "JOB_STATE_PARTIALLY_SUCCEEDED";

readonly updateTime?: Date;

readonly webAccessUris?: {

[key: string]: string;

};

}

§Properties

readonly createTime?: Date

[src]

Output only. Time when the CustomJob was created.

displayName?: string

[src]

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

encryptionSpec?: GoogleCloudAiplatformV1EncryptionSpec

[src]

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

readonly endTime?: Date

[src]

Output only. Time when the CustomJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.

readonly error?: GoogleRpcStatus

[src]

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

jobSpec?: GoogleCloudAiplatformV1CustomJobSpec

[src]

Required. Job spec.

labels?: {

[key: string]: string;

}

[src]

The labels with user-defined metadata to organize CustomJobs. 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.

readonly name?: string

[src]

Output only. Resource name of a CustomJob.

readonly startTime?: Date

[src]

Output only. Time when the CustomJob for the first time entered the JOB_STATE_RUNNING state.

[src]

Output only. The detailed state of the job.

readonly updateTime?: Date

[src]

Output only. Time when the CustomJob was most recently updated.

readonly webAccessUris?: {

[key: string]: string;

}

[src]

Output only. URIs for accessing interactive shells (one URI for each training node). Only available if job_spec.enable_web_access is true. The keys are names of each node in the training job; for example, workerpool0-0 for the primary node, workerpool1-0 for the first node in the second worker pool, and workerpool1-1 for the second node in the second worker pool. The values are the URIs for each node's interactive shell.