Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::CustomJob (v0.25.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::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).

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Time when the CustomJob was created.

#display_name

def display_name() -> ::String

Returns

(::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.

#display_name=

def display_name=(value) -> ::String

Parameter

value (::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.

Returns

(::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.

#encryption_spec

def encryption_spec() -> ::Google::Cloud::AIPlatform::V1::EncryptionSpec

Returns

(::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.

#encryption_spec=

def encryption_spec=(value) -> ::Google::Cloud::AIPlatform::V1::EncryptionSpec

Parameter

value (::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.

Returns

(::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.

#end_time

def end_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Time when the CustomJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.

#error

def error() -> ::Google::Rpc::Status

Returns

(::Google::Rpc::Status) — Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

#job_spec

def job_spec() -> ::Google::Cloud::AIPlatform::V1::CustomJobSpec

Returns

(::Google::Cloud::AIPlatform::V1::CustomJobSpec) — Required. Job spec.

#job_spec=

def job_spec=(value) -> ::Google::Cloud::AIPlatform::V1::CustomJobSpec

Parameter

value (::Google::Cloud::AIPlatform::V1::CustomJobSpec) — Required. Job spec.

Returns

(::Google::Cloud::AIPlatform::V1::CustomJobSpec) — Required. Job spec.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::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.

See https://goo.gl/xmQnxf for more information and examples of labels.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::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.

See https://goo.gl/xmQnxf for more information and examples of labels.

Returns

(::Google::Protobuf::Map{::String => ::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.

See https://goo.gl/xmQnxf for more information and examples of labels.

#name

def name() -> ::String

Returns

(::String) — Output only. Resource name of a CustomJob.

#start_time

def start_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Time when the CustomJob for the first time entered the JOB_STATE_RUNNING state.

#state

def state() -> ::Google::Cloud::AIPlatform::V1::JobState

Returns

(::Google::Cloud::AIPlatform::V1::JobState) — Output only. The detailed state of the job.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Time when the CustomJob was most recently updated.

#web_access_uris

def web_access_uris() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — 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.