Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CustomJob

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1beta1/classes.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb

Overview

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).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1CustomJob

Returns a new instance of GoogleCloudAiplatformV1beta1CustomJob.



4168
4169
4170
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4168

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#create_time ⇒ String

Output only. Time when the CustomJob was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


4092
4093
4094
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4092

def create_time
  @create_time
end

#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. Corresponds to the JSON property displayName

Returns:

  • (String) 


4098
4099
4100
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4098

def display_name
  @display_name
end

#encryption_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EncryptionSpec

Represents a customer-managed encryption key spec that can be applied to a top- level resource. Corresponds to the JSON property encryptionSpec

Returns:



4104
4105
4106
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4104

def encryption_spec
  @encryption_spec
end

#end_time ⇒ String

Output only. Time when the CustomJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED. Corresponds to the JSON property endTime

Returns:

  • (String) 


4110
4111
4112
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4110

def end_time
  @end_time
end

#error ⇒ Google::Apis::AiplatformV1beta1::GoogleRpcStatus

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. Corresponds to the JSON property error

Returns:



4120
4121
4122
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4120

def error
  @error
end

#job_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CustomJobSpec

Represents the spec of a CustomJob. Corresponds to the JSON property jobSpec

Returns:



4125
4126
4127
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4125

def job_spec
  @job_spec
end

#labels ⇒ Hash<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. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


4134
4135
4136
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4134

def labels
  @labels
end

#name ⇒ String

Output only. Resource name of a CustomJob. Corresponds to the JSON property name

Returns:

  • (String) 


4139
4140
4141
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4139

def name
  @name
end

#start_time ⇒ String

Output only. Time when the CustomJob for the first time entered the JOB_STATE_RUNNING state. Corresponds to the JSON property startTime

Returns:

  • (String) 


4145
4146
4147
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4145

def start_time
  @start_time
end

#state ⇒ String

Output only. The detailed state of the job. Corresponds to the JSON property state

Returns:

  • (String) 


4150
4151
4152
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4150

def state
  @state
end

#update_time ⇒ String

Output only. Time when the CustomJob was most recently updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


4155
4156
4157
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4155

def update_time
  @update_time
end

#web_access_uris ⇒ Hash<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. Corresponds to the JSON property webAccessUris

Returns:

  • (Hash<String,String>) 


4166
4167
4168
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4166

def web_access_uris
  @web_access_uris
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4173

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @encryption_spec = args[:encryption_spec] if args.key?(:encryption_spec)
  @end_time = args[:end_time] if args.key?(:end_time)
  @error = args[:error] if args.key?(:error)
  @job_spec = args[:job_spec] if args.key?(:job_spec)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @start_time = args[:start_time] if args.key?(:start_time)
  @state = args[:state] if args.key?(:state)
  @update_time = args[:update_time] if args.key?(:update_time)
  @web_access_uris = args[:web_access_uris] if args.key?(:web_access_uris)
end