Stay organized with collections
Save and categorize content based on your preferences.
Resource: CustomJob
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).
Fields
name
string
Output only. Resource name of a CustomJob.
displayName
string
Required. The display name of the CustomJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
Output only. time when the CustomJob for the first time entered the JOB_STATE_RUNNING state.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
Output only. time when the CustomJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
Output only. time when the CustomJob was most recently updated.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.
labels
map (key: string, value: string)
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.
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[],[],null,["# REST Resource: projects.locations.customJobs\n\nResource: CustomJob\n-------------------\n\nRepresents 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).\nFields `name` `string` \nOutput only. Resource name of a CustomJob.\n`displayName` `string` \nRequired. The display name of the CustomJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.\n`jobSpec` `object (`[CustomJobSpec](/vertex-ai/docs/reference/rest/v1/CustomJobSpec)`)` \nRequired. Job spec.\n`state` `enum (`[JobState](/vertex-ai/docs/reference/rest/v1/JobState)`)` \nOutput only. The detailed state of the job.\n`createTime` `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` \nOutput only. time when the CustomJob was created.\n\nUses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`.\n`startTime` `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` \nOutput only. time when the CustomJob for the first time entered the `JOB_STATE_RUNNING` state.\n\nUses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`.\n`endTime` `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` \nOutput only. time when the CustomJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.\n\nUses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`.\n`updateTime` `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` \nOutput only. time when the CustomJob was most recently updated.\n\nUses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`.\n`error` `object (`[Status](/vertex-ai/docs/reference/rest/Shared.Types/ListOperationsResponse#Status)`)` \nOutput only. Only populated when job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.\n`labels` `map (key: string, value: string)` \nThe labels with user-defined metadata to organize CustomJobs.\n\nlabel 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.\n\nSee \u003chttps://goo.gl/xmQnxf\u003e for more information and examples of labels.\n`encryptionSpec` `object (`[EncryptionSpec](/vertex-ai/docs/reference/rest/v1/EncryptionSpec)`)` \nCustomer-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.\n`webAccessUris` `map (key: string, value: string)` \nOutput only. URIs for accessing [interactive shells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) (one URI for each training node). Only available if [jobSpec.enable_web_access](/vertex-ai/docs/reference/rest/v1/CustomJobSpec#FIELDS.enable_web_access) is `true`.\n\nThe 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.\n\nThe values are the URIs for each node's interactive shell.\n`satisfiesPzs` `boolean` \nOutput only. reserved for future use.\n`satisfiesPzi` `boolean` \nOutput only. reserved for future use."]]
