Class: Google::Apis::MlV1::GoogleCloudMlV1Job

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

Overview

Represents a training or prediction job.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleCloudMlV1Job

Returns a new instance of GoogleCloudMlV1Job



393
394
395
 
# File 'generated/google/apis/ml_v1/classes.rb', line 393

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

Instance Attribute Details

#create_time ⇒ String

Output only. When the job was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


320
321
322
 
# File 'generated/google/apis/ml_v1/classes.rb', line 320

def create_time
  @create_time
end

#end_time ⇒ String

Output only. When the job processing was completed. Corresponds to the JSON property endTime

Returns:

  • (String) 


325
326
327
 
# File 'generated/google/apis/ml_v1/classes.rb', line 325

def end_time
  @end_time
end

#error_message ⇒ String

Output only. The details of a failure or a cancellation. Corresponds to the JSON property errorMessage

Returns:

  • (String) 


330
331
332
 
# File 'generated/google/apis/ml_v1/classes.rb', line 330

def error_message
  @error_message
end

#etag ⇒ String

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a job from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform job updates in order to avoid race conditions: An etag is returned in the response to GetJob, and systems are expected to put that etag in the request to UpdateJob to ensure that their change will be applied to the same version of the job. Corresponds to the JSON property etag NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


342
343
344
 
# File 'generated/google/apis/ml_v1/classes.rb', line 342

def etag
  @etag
end

#job_id ⇒ String

Required. The user-specified id of the job. Corresponds to the JSON property jobId

Returns:

  • (String) 


347
348
349
 
# File 'generated/google/apis/ml_v1/classes.rb', line 347

def job_id
  @job_id
end

#labels ⇒ Hash<String,String>

Optional. One or more labels that you can add, to organize your jobs. Each label is a key-value pair, where both the key and the value are arbitrary strings that you supply. For more information, see the documentation on using labels. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


356
357
358
 
# File 'generated/google/apis/ml_v1/classes.rb', line 356

def labels
  @labels
end

#prediction_input ⇒ Google::Apis::MlV1::GoogleCloudMlV1PredictionInput

Represents input parameters for a prediction job. Corresponds to the JSON property predictionInput

Returns:



361
362
363
 
# File 'generated/google/apis/ml_v1/classes.rb', line 361

def prediction_input
  @prediction_input
end

#prediction_output ⇒ Google::Apis::MlV1::GoogleCloudMlV1PredictionOutput

Represents results of a prediction job. Corresponds to the JSON property predictionOutput

Returns:



366
367
368
 
# File 'generated/google/apis/ml_v1/classes.rb', line 366

def prediction_output
  @prediction_output
end

#start_time ⇒ String

Output only. When the job processing was started. Corresponds to the JSON property startTime

Returns:

  • (String) 


371
372
373
 
# File 'generated/google/apis/ml_v1/classes.rb', line 371

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


376
377
378
 
# File 'generated/google/apis/ml_v1/classes.rb', line 376

def state
  @state
end

#training_input ⇒ Google::Apis::MlV1::GoogleCloudMlV1TrainingInput

Represents input parameters for a training job. When using the gcloud command to submit your training job, you can specify the input parameters as command-line arguments and/or in a YAML configuration file referenced from the --config command-line argument. For details, see the guide to submitting a training job. Corresponds to the JSON property trainingInput

Returns:



386
387
388
 
# File 'generated/google/apis/ml_v1/classes.rb', line 386

def training_input
  @training_input
end

#training_output ⇒ Google::Apis::MlV1::GoogleCloudMlV1TrainingOutput

Represents results of a training job. Output only. Corresponds to the JSON property trainingOutput

Returns:



391
392
393
 
# File 'generated/google/apis/ml_v1/classes.rb', line 391

def training_output
  @training_output
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'generated/google/apis/ml_v1/classes.rb', line 398

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @end_time = args[:end_time] if args.key?(:end_time)
  @error_message = args[:error_message] if args.key?(:error_message)
  @etag = args[:etag] if args.key?(:etag)
  @job_id = args[:job_id] if args.key?(:job_id)
  @labels = args[:labels] if args.key?(:labels)
  @prediction_input = args[:prediction_input] if args.key?(:prediction_input)
  @prediction_output = args[:prediction_output] if args.key?(:prediction_output)
  @start_time = args[:start_time] if args.key?(:start_time)
  @state = args[:state] if args.key?(:state)
  @training_input = args[:training_input] if args.key?(:training_input)
  @training_output = args[:training_output] if args.key?(:training_output)
end