- 1.44.0 (latest)
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.1
- 1.31.0
- 1.30.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.1
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
- 0.39.0
- 0.38.0
- 0.37.1
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.2
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.13.0
- 0.12.0
- 0.11.1
- 0.10.0
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.
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
↳ 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 JOB_STATE_RUNNING
state.
↳ end_time
Google\Protobuf\Timestamp
Output only. Time when the CustomJob entered any of the following states: JOB_STATE_SUCCEEDED
, JOB_STATE_FAILED
, JOB_STATE_CANCELLED
.
↳ 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 JOB_STATE_FAILED
or JOB_STATE_CANCELLED
.
↳ 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 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.
getName
Output only. Resource name of a CustomJob.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
string
setName
Output only. Resource name of a CustomJob.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
string
$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.
Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
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.
Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
var
string
$this
getJobSpec
Required. Job spec.
Generated from protobuf field .google.cloud.aiplatform.v1.CustomJobSpec job_spec = 4 [(.google.api.field_behavior) = REQUIRED];
hasJobSpec
clearJobSpec
setJobSpec
Required. Job spec.
Generated from protobuf field .google.cloud.aiplatform.v1.CustomJobSpec job_spec = 4 [(.google.api.field_behavior) = REQUIRED];
$this
getState
Output only. The detailed state of the job.
Generated from protobuf field .google.cloud.aiplatform.v1.JobState state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
int
setState
Output only. The detailed state of the job.
Generated from protobuf field .google.cloud.aiplatform.v1.JobState state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
int
$this
getCreateTime
Output only. Time when the CustomJob was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Timestamp|null
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time when the CustomJob was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
Google\Protobuf\Timestamp
$this
getStartTime
Output only. Time when the CustomJob for the first time entered the JOB_STATE_RUNNING
state.
Generated from protobuf field .google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Timestamp|null
hasStartTime
clearStartTime
setStartTime
Output only. Time when the CustomJob for the first time entered the JOB_STATE_RUNNING
state.
Generated from protobuf field .google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
Google\Protobuf\Timestamp
$this
getEndTime
Output only. Time when the CustomJob entered any of the following states: JOB_STATE_SUCCEEDED
, JOB_STATE_FAILED
, JOB_STATE_CANCELLED
.
Generated from protobuf field .google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
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
.
Generated from protobuf field .google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
Google\Protobuf\Timestamp
$this
getUpdateTime
Output only. Time when the CustomJob was most recently updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Timestamp|null
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Time when the CustomJob was most recently updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
Google\Protobuf\Timestamp
$this
getError
Output only. Only populated when job's state is JOB_STATE_FAILED
or JOB_STATE_CANCELLED
.
Generated from protobuf field .google.rpc.Status error = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasError
clearError
setError
Output only. Only populated when job's state is JOB_STATE_FAILED
or JOB_STATE_CANCELLED
.
Generated from protobuf field .google.rpc.Status error = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
$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.
Generated from protobuf field map<string, string> labels = 11;
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.
Generated from protobuf field map<string, string> labels = 11;
var
array|Google\Protobuf\Internal\MapField
$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.
Generated from protobuf field .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 12;
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.
Generated from protobuf field .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 12;
$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.
Generated from protobuf field map<string, string> web_access_uris = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.
Generated from protobuf field map<string, string> web_access_uris = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
array|Google\Protobuf\Internal\MapField
$this
