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

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

Overview

Represents a training or prediction job.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudMlV1Job

Returns a new instance of GoogleCloudMlV1Job.



1436
1437
1438
 
# File 'lib/google/apis/ml_v1/classes.rb', line 1436

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) 


1358
1359
1360
 
# File 'lib/google/apis/ml_v1/classes.rb', line 1358

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) 


1363
1364
1365
 
# File 'lib/google/apis/ml_v1/classes.rb', line 1363

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) 


1368
1369
1370
 
# File 'lib/google/apis/ml_v1/classes.rb', line 1368

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) 


1380
1381
1382
 
# File 'lib/google/apis/ml_v1/classes.rb', line 1380

def etag
  @etag
end

#job_id ⇒ String

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

Returns:

  • (String) 


1385
1386
1387
 
# File 'lib/google/apis/ml_v1/classes.rb', line 1385

def job_id
  @job_id
end

#job_position ⇒ Fixnum

Output only. It's only effect when the job is in QUEUED state. If it's positive, it indicates the job's position in the job scheduler. It's 0 when the job is already scheduled. Corresponds to the JSON property jobPosition

Returns:

  • (Fixnum) 


1392
1393
1394
 
# File 'lib/google/apis/ml_v1/classes.rb', line 1392

def job_position
  @job_position
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>) 


1400
1401
1402
 
# File 'lib/google/apis/ml_v1/classes.rb', line 1400

def labels
  @labels
end

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

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

Returns:



1405
1406
1407
 
# File 'lib/google/apis/ml_v1/classes.rb', line 1405

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:



1410
1411
1412
 
# File 'lib/google/apis/ml_v1/classes.rb', line 1410

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) 


1415
1416
1417
 
# File 'lib/google/apis/ml_v1/classes.rb', line 1415

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


1420
1421
1422
 
# File 'lib/google/apis/ml_v1/classes.rb', line 1420

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:



1429
1430
1431
 
# File 'lib/google/apis/ml_v1/classes.rb', line 1429

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:



1434
1435
1436
 
# File 'lib/google/apis/ml_v1/classes.rb', line 1434

def training_output
  @training_output
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
 
# File 'lib/google/apis/ml_v1/classes.rb', line 1441

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)
  @job_position = args[:job_position] if args.key?(:job_position)
  @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