- 0.58.0 (latest)
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 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.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.1
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.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- (::Google::Protobuf::Timestamp) — Output only. Time when the CustomJob was created.
#display_name
def display_name() -> ::String- (::String) — Required. The display name of the CustomJob. The name can be up to 128 characters long and can be consist of any UTF-8 characters.
#display_name=
def display_name=(value) -> ::String- value (::String) — Required. The display name of the CustomJob. The name can be up to 128 characters long and can be consist of any UTF-8 characters.
- (::String) — Required. The display name of the CustomJob. The name can be up to 128 characters long and can be consist of any UTF-8 characters.
#encryption_spec
def encryption_spec() -> ::Google::Cloud::AIPlatform::V1::EncryptionSpec- (::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- 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.
- (::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-
(::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-
(::Google::Rpc::Status) — Output only. Only populated when job's state is
JOB_STATE_FAILEDorJOB_STATE_CANCELLED.
#job_spec
def job_spec() -> ::Google::Cloud::AIPlatform::V1::CustomJobSpec- (::Google::Cloud::AIPlatform::V1::CustomJobSpec) — Required. Job spec.
#job_spec=
def job_spec=(value) -> ::Google::Cloud::AIPlatform::V1::CustomJobSpec- value (::Google::Cloud::AIPlatform::V1::CustomJobSpec) — Required. Job spec.
- (::Google::Cloud::AIPlatform::V1::CustomJobSpec) — Required. Job spec.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}-
(::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}-
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.
-
(::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- (::String) — Output only. Resource name of a CustomJob.
#start_time
def start_time() -> ::Google::Protobuf::Timestamp-
(::Google::Protobuf::Timestamp) — Output only. Time when the CustomJob for the first time entered the
JOB_STATE_RUNNINGstate.
#state
def state() -> ::Google::Cloud::AIPlatform::V1::JobState- (::Google::Cloud::AIPlatform::V1::JobState) — Output only. The detailed state of the job.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp- (::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}-
(::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-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.