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 message google.cloud.aiplatform.v1.CustomJob
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. |
↳ job_spec |
Google\Cloud\AIPlatform\V1\CustomJobSpec
Required. Job spec. |
↳ state |
int
Output only. The detailed state of the job. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Time when the CustomJob was created. |
↳ start_time |
Google\Protobuf\Timestamp
Output only. Time when the CustomJob for the first time entered the |
↳ end_time |
Google\Protobuf\Timestamp
Output only. Time when the CustomJob entered any of the following states: |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Time when the CustomJob was most recently updated. |
↳ error |
Google\Rpc\Status
Output only. Only populated when job's state is |
↳ labels |
array|Google\Protobuf\Internal\MapField
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. |
↳ encryption_spec |
Google\Cloud\AIPlatform\V1\EncryptionSpec
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. |
↳ web_access_uris |
array|Google\Protobuf\Internal\MapField
Output only. URIs for accessing interactive shells (one URI for each training node). Only available if job_spec.enable_web_access is |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getJobSpec
Required. Job spec.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\CustomJobSpec|null | |
hasJobSpec
clearJobSpec
setJobSpec
Required. Job spec.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\CustomJobSpec
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. The detailed state of the job.
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. The detailed state of the job.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. Time when the CustomJob was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time when the CustomJob was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStartTime
Output only. Time when the CustomJob for the first time entered the
JOB_STATE_RUNNING state.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasStartTime
clearStartTime
setStartTime
Output only. Time when the CustomJob for the first time entered the
JOB_STATE_RUNNING state.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEndTime
Output only. Time when the CustomJob entered any of the following states:
JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasEndTime
clearEndTime
setEndTime
Output only. Time when the CustomJob entered any of the following states:
JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. Time when the CustomJob was most recently updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Time when the CustomJob was most recently updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getError
Output only. Only populated when job's state is JOB_STATE_FAILED or
JOB_STATE_CANCELLED.
| Returns | |
|---|---|
| Type | Description |
Google\Rpc\Status|null | |
hasError
clearError
setError
Output only. Only populated when job's state is JOB_STATE_FAILED or
JOB_STATE_CANCELLED.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Rpc\Status
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLabels
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setLabels
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEncryptionSpec
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.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\EncryptionSpec|null | |
hasEncryptionSpec
clearEncryptionSpec
setEncryptionSpec
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\EncryptionSpec
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getWebAccessUris
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setWebAccessUris
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |