Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class 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).
Generated from protobuf messagegoogle.cloud.aiplatform.v1.CustomJob
Namespace
Google \ Cloud \ AIPlatform \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. Resource name of a CustomJob.
↳ display_name
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.
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. Seehttps://goo.gl/xmQnxffor more information and examples of labels.
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.
Output only. URIs for accessinginteractive shells(one URI for each training node). Only available ifjob_spec.enable_web_accessistrue. The keys are names of each node in the training job; for example,workerpool0-0for the primary node,workerpool1-0for the first node in the second worker pool, andworkerpool1-1for the second node in the second worker pool. The values are the URIs for each node's interactive shell.
↳ satisfies_pzs
bool
Output only. Reserved for future use.
↳ satisfies_pzi
bool
Output only. Reserved for future use.
getName
Output only. Resource name of a CustomJob.
Returns
Type
Description
string
setName
Output only. Resource name of a CustomJob.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDisplayName
Required. The display name of the CustomJob.
The name can be up to 128 characters long and can consist of any UTF-8
characters.
Returns
Type
Description
string
setDisplayName
Required. The display name of the CustomJob.
The name can be up to 128 characters long and can consist of any UTF-8
characters.
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.
Seehttps://goo.gl/xmQnxffor more information and examples of labels.
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.
Seehttps://goo.gl/xmQnxffor more information and examples of labels.
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.
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-0for the primary node,workerpool1-0for the first node in
the second worker pool, andworkerpool1-1for the second node in the
second worker pool.
The values are the URIs for each node's interactive shell.
The keys are names of each node in the training job; for example,workerpool0-0for the primary node,workerpool1-0for the first node in
the second worker pool, andworkerpool1-1for 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-09-04 UTC."],[],[],null,["# Google Cloud Ai Platform V1 Client - Class CustomJob (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-ai-platform/latest/V1.CustomJob)\n- [1.34.0](/php/docs/reference/cloud-ai-platform/1.34.0/V1.CustomJob)\n- [1.33.0](/php/docs/reference/cloud-ai-platform/1.33.0/V1.CustomJob)\n- [1.32.1](/php/docs/reference/cloud-ai-platform/1.32.1/V1.CustomJob)\n- [1.31.0](/php/docs/reference/cloud-ai-platform/1.31.0/V1.CustomJob)\n- [1.30.0](/php/docs/reference/cloud-ai-platform/1.30.0/V1.CustomJob)\n- [1.26.0](/php/docs/reference/cloud-ai-platform/1.26.0/V1.CustomJob)\n- [1.23.0](/php/docs/reference/cloud-ai-platform/1.23.0/V1.CustomJob)\n- [1.22.0](/php/docs/reference/cloud-ai-platform/1.22.0/V1.CustomJob)\n- [1.21.0](/php/docs/reference/cloud-ai-platform/1.21.0/V1.CustomJob)\n- [1.20.0](/php/docs/reference/cloud-ai-platform/1.20.0/V1.CustomJob)\n- [1.19.0](/php/docs/reference/cloud-ai-platform/1.19.0/V1.CustomJob)\n- [1.18.0](/php/docs/reference/cloud-ai-platform/1.18.0/V1.CustomJob)\n- [1.17.0](/php/docs/reference/cloud-ai-platform/1.17.0/V1.CustomJob)\n- [1.16.0](/php/docs/reference/cloud-ai-platform/1.16.0/V1.CustomJob)\n- [1.15.0](/php/docs/reference/cloud-ai-platform/1.15.0/V1.CustomJob)\n- [1.14.0](/php/docs/reference/cloud-ai-platform/1.14.0/V1.CustomJob)\n- [1.13.1](/php/docs/reference/cloud-ai-platform/1.13.1/V1.CustomJob)\n- [1.12.0](/php/docs/reference/cloud-ai-platform/1.12.0/V1.CustomJob)\n- [1.11.0](/php/docs/reference/cloud-ai-platform/1.11.0/V1.CustomJob)\n- [1.10.0](/php/docs/reference/cloud-ai-platform/1.10.0/V1.CustomJob)\n- [1.9.0](/php/docs/reference/cloud-ai-platform/1.9.0/V1.CustomJob)\n- [1.8.0](/php/docs/reference/cloud-ai-platform/1.8.0/V1.CustomJob)\n- [1.7.0](/php/docs/reference/cloud-ai-platform/1.7.0/V1.CustomJob)\n- [1.6.0](/php/docs/reference/cloud-ai-platform/1.6.0/V1.CustomJob)\n- [1.5.0](/php/docs/reference/cloud-ai-platform/1.5.0/V1.CustomJob)\n- [1.4.0](/php/docs/reference/cloud-ai-platform/1.4.0/V1.CustomJob)\n- [1.3.0](/php/docs/reference/cloud-ai-platform/1.3.0/V1.CustomJob)\n- [1.2.0](/php/docs/reference/cloud-ai-platform/1.2.0/V1.CustomJob)\n- [1.1.0](/php/docs/reference/cloud-ai-platform/1.1.0/V1.CustomJob)\n- [1.0.0](/php/docs/reference/cloud-ai-platform/1.0.0/V1.CustomJob)\n- [0.39.0](/php/docs/reference/cloud-ai-platform/0.39.0/V1.CustomJob)\n- [0.38.0](/php/docs/reference/cloud-ai-platform/0.38.0/V1.CustomJob)\n- [0.37.1](/php/docs/reference/cloud-ai-platform/0.37.1/V1.CustomJob)\n- [0.32.0](/php/docs/reference/cloud-ai-platform/0.32.0/V1.CustomJob)\n- [0.31.0](/php/docs/reference/cloud-ai-platform/0.31.0/V1.CustomJob)\n- [0.30.0](/php/docs/reference/cloud-ai-platform/0.30.0/V1.CustomJob)\n- [0.29.0](/php/docs/reference/cloud-ai-platform/0.29.0/V1.CustomJob)\n- [0.28.0](/php/docs/reference/cloud-ai-platform/0.28.0/V1.CustomJob)\n- [0.27.0](/php/docs/reference/cloud-ai-platform/0.27.0/V1.CustomJob)\n- [0.26.2](/php/docs/reference/cloud-ai-platform/0.26.2/V1.CustomJob)\n- [0.25.0](/php/docs/reference/cloud-ai-platform/0.25.0/V1.CustomJob)\n- [0.24.0](/php/docs/reference/cloud-ai-platform/0.24.0/V1.CustomJob)\n- [0.23.0](/php/docs/reference/cloud-ai-platform/0.23.0/V1.CustomJob)\n- [0.22.0](/php/docs/reference/cloud-ai-platform/0.22.0/V1.CustomJob)\n- [0.21.0](/php/docs/reference/cloud-ai-platform/0.21.0/V1.CustomJob)\n- [0.20.0](/php/docs/reference/cloud-ai-platform/0.20.0/V1.CustomJob)\n- [0.19.0](/php/docs/reference/cloud-ai-platform/0.19.0/V1.CustomJob)\n- [0.18.0](/php/docs/reference/cloud-ai-platform/0.18.0/V1.CustomJob)\n- [0.17.0](/php/docs/reference/cloud-ai-platform/0.17.0/V1.CustomJob)\n- [0.16.0](/php/docs/reference/cloud-ai-platform/0.16.0/V1.CustomJob)\n- [0.15.0](/php/docs/reference/cloud-ai-platform/0.15.0/V1.CustomJob)\n- [0.13.0](/php/docs/reference/cloud-ai-platform/0.13.0/V1.CustomJob)\n- [0.12.0](/php/docs/reference/cloud-ai-platform/0.12.0/V1.CustomJob)\n- [0.11.1](/php/docs/reference/cloud-ai-platform/0.11.1/V1.CustomJob)\n- [0.10.0](/php/docs/reference/cloud-ai-platform/0.10.0/V1.CustomJob) \nReference documentation and code samples for the Google Cloud Ai Platform V1 Client class CustomJob.\n\nRepresents a job that runs custom workloads such as a Docker container or a\nPython package. A CustomJob can have multiple worker pools and each worker\npool can have its own machine and input spec. A CustomJob will be cleaned up\nonce the job enters terminal state (failed or succeeded).\n\nGenerated from protobuf message `google.cloud.aiplatform.v1.CustomJob`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AIPlatform \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nOutput only. Resource name of a CustomJob.\n\n### setName\n\nOutput only. Resource name of a CustomJob.\n\n### getDisplayName\n\nRequired. The display name of the CustomJob.\n\nThe name can be up to 128 characters long and can consist of any UTF-8\ncharacters.\n\n### setDisplayName\n\nRequired. The display name of the CustomJob.\n\nThe name can be up to 128 characters long and can consist of any UTF-8\ncharacters.\n\n### getJobSpec\n\nRequired. Job spec.\n\n### hasJobSpec\n\n### clearJobSpec\n\n### setJobSpec\n\nRequired. Job spec.\n\n### getState\n\nOutput only. The detailed state of the job.\n\n### setState\n\nOutput only. The detailed state of the job.\n\n### getCreateTime\n\nOutput only. Time when the CustomJob was created.\n\n### hasCreateTime\n\n### clearCreateTime\n\n### setCreateTime\n\nOutput only. Time when the CustomJob was created.\n\n### getStartTime\n\nOutput only. Time when the CustomJob for the first time entered the\n`JOB_STATE_RUNNING` state.\n\n### hasStartTime\n\n### clearStartTime\n\n### setStartTime\n\nOutput only. Time when the CustomJob for the first time entered the\n`JOB_STATE_RUNNING` state.\n\n### getEndTime\n\nOutput only. Time when the CustomJob entered any of the following states:\n`JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.\n\n### hasEndTime\n\n### clearEndTime\n\n### setEndTime\n\nOutput only. Time when the CustomJob entered any of the following states:\n`JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.\n\n### getUpdateTime\n\nOutput only. Time when the CustomJob was most recently updated.\n\n### hasUpdateTime\n\n### clearUpdateTime\n\n### setUpdateTime\n\nOutput only. Time when the CustomJob was most recently updated.\n\n### getError\n\nOutput only. Only populated when job's state is `JOB_STATE_FAILED` or\n`JOB_STATE_CANCELLED`.\n\n### hasError\n\n### clearError\n\n### setError\n\nOutput only. Only populated when job's state is `JOB_STATE_FAILED` or\n`JOB_STATE_CANCELLED`.\n\n### getLabels\n\nThe labels with user-defined metadata to organize CustomJobs.\n\nLabel keys and values can be no longer than 64 characters\n(Unicode codepoints), can only contain lowercase letters, numeric\ncharacters, underscores and dashes. International characters are allowed.\nSee \u003chttps://goo.gl/xmQnxf\u003e for more information and examples of labels.\n\n### setLabels\n\nThe labels with user-defined metadata to organize CustomJobs.\n\nLabel keys and values can be no longer than 64 characters\n(Unicode codepoints), can only contain lowercase letters, numeric\ncharacters, underscores and dashes. International characters are allowed.\nSee \u003chttps://goo.gl/xmQnxf\u003e for more information and examples of labels.\n\n### getEncryptionSpec\n\nCustomer-managed encryption key options for a CustomJob. If this is set,\nthen all resources created by the CustomJob will be encrypted with the\nprovided encryption key.\n\n### hasEncryptionSpec\n\n### clearEncryptionSpec\n\n### setEncryptionSpec\n\nCustomer-managed encryption key options for a CustomJob. If this is set,\nthen all resources created by the CustomJob will be encrypted with the\nprovided encryption key.\n\n### getWebAccessUris\n\nOutput only. URIs for accessing [interactive\nshells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell)\n(one URI for each training node). Only available if\n[job_spec.enable_web_access](/php/docs/reference/cloud-ai-platform/latest/V1.CustomJobSpec#_Google_Cloud_AIPlatform_V1_CustomJobSpec__getEnableWebAccess__)\nis `true`.\n\nThe keys are names of each node in the training job; for example,\n`workerpool0-0` for the primary node, `workerpool1-0` for the first node in\nthe second worker pool, and `workerpool1-1` for the second node in the\nsecond worker pool.\nThe values are the URIs for each node's interactive shell.\n\n### setWebAccessUris\n\nOutput only. URIs for accessing [interactive\nshells](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell)\n(one URI for each training node). Only available if\n[job_spec.enable_web_access](/php/docs/reference/cloud-ai-platform/latest/V1.CustomJobSpec#_Google_Cloud_AIPlatform_V1_CustomJobSpec__getEnableWebAccess__)\nis `true`.\n\nThe keys are names of each node in the training job; for example,\n`workerpool0-0` for the primary node, `workerpool1-0` for the first node in\nthe second worker pool, and `workerpool1-1` for the second node in the\nsecond worker pool.\nThe values are the URIs for each node's interactive shell.\n\n### getSatisfiesPzs\n\nOutput only. Reserved for future use.\n\n### setSatisfiesPzs\n\nOutput only. Reserved for future use.\n\n### getSatisfiesPzi\n\nOutput only. Reserved for future use.\n\n### setSatisfiesPzi\n\nOutput only. Reserved for future use."]]
