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



561
562
563
# File 'generated/google/apis/ml_v1/classes.rb', line 561

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

Instance Attribute Details

#create_timeString

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

Returns:

  • (String)


487
488
489
# File 'generated/google/apis/ml_v1/classes.rb', line 487

def create_time
  @create_time
end

#end_timeString

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

Returns:

  • (String)


492
493
494
# File 'generated/google/apis/ml_v1/classes.rb', line 492

def end_time
  @end_time
end

#error_messageString

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

Returns:

  • (String)


497
498
499
# File 'generated/google/apis/ml_v1/classes.rb', line 497

def error_message
  @error_message
end

#etagString

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)


509
510
511
# File 'generated/google/apis/ml_v1/classes.rb', line 509

def etag
  @etag
end

#job_idString

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

Returns:

  • (String)


514
515
516
# File 'generated/google/apis/ml_v1/classes.rb', line 514

def job_id
  @job_id
end

#labelsHash<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>)


523
524
525
# File 'generated/google/apis/ml_v1/classes.rb', line 523

def labels
  @labels
end

#prediction_inputGoogle::Apis::MlV1::GoogleCloudMlV1PredictionInput

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



528
529
530
# File 'generated/google/apis/ml_v1/classes.rb', line 528

def prediction_input
  @prediction_input
end

#prediction_outputGoogle::Apis::MlV1::GoogleCloudMlV1PredictionOutput

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



533
534
535
# File 'generated/google/apis/ml_v1/classes.rb', line 533

def prediction_output
  @prediction_output
end

#start_timeString

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

Returns:

  • (String)


538
539
540
# File 'generated/google/apis/ml_v1/classes.rb', line 538

def start_time
  @start_time
end

#stateString

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

Returns:

  • (String)


543
544
545
# File 'generated/google/apis/ml_v1/classes.rb', line 543

def state
  @state
end

#training_inputGoogle::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



554
555
556
# File 'generated/google/apis/ml_v1/classes.rb', line 554

def training_input
  @training_input
end

#training_outputGoogle::Apis::MlV1::GoogleCloudMlV1TrainingOutput

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



559
560
561
# File 'generated/google/apis/ml_v1/classes.rb', line 559

def training_output
  @training_output
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



566
567
568
569
570
571
572
573
574
575
576
577
578
579
# File 'generated/google/apis/ml_v1/classes.rb', line 566

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