Class: Google::Apis::BatchV1::Job

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

Overview

The Cloud Batch Job description.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Job

Returns a new instance of Job.



851
852
853
 
# File 'lib/google/apis/batch_v1/classes.rb', line 851

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

Instance Attribute Details

#allocation_policy ⇒ Google::Apis::BatchV1::AllocationPolicy

A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job. Corresponds to the JSON property allocationPolicy

Returns:



791
792
793
 
# File 'lib/google/apis/batch_v1/classes.rb', line 791

def allocation_policy
  @allocation_policy
end

#create_time ⇒ String

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

Returns:

  • (String) 


796
797
798
 
# File 'lib/google/apis/batch_v1/classes.rb', line 796

def create_time
  @create_time
end

#labels ⇒ Hash<String,String>

Labels for the Job. Labels could be user provided or system generated. For example, "labels": "department": "finance", "environment": "test" You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


805
806
807
 
# File 'lib/google/apis/batch_v1/classes.rb', line 805

def labels
  @labels
end

#logs_policy ⇒ Google::Apis::BatchV1::LogsPolicy

LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be preserved. Corresponds to the JSON property logsPolicy

Returns:



811
812
813
 
# File 'lib/google/apis/batch_v1/classes.rb', line 811

def logs_policy
  @logs_policy
end

#name ⇒ String

Output only. Job name. For example: "projects/123456/locations/us-central1/ jobs/job01". Corresponds to the JSON property name

Returns:

  • (String) 


817
818
819
 
# File 'lib/google/apis/batch_v1/classes.rb', line 817

def name
  @name
end

#notifications ⇒ Array<Google::Apis::BatchV1::JobNotification>

Notification configurations. Corresponds to the JSON property notifications

Returns:



822
823
824
 
# File 'lib/google/apis/batch_v1/classes.rb', line 822

def notifications
  @notifications
end

#priority ⇒ Fixnum

Priority of the Job. The valid value range is [0, 100). Default value is 0. Higher value indicates higher priority. A job with higher priority value is more likely to run earlier if all other requirements are satisfied. Corresponds to the JSON property priority

Returns:

  • (Fixnum) 


829
830
831
 
# File 'lib/google/apis/batch_v1/classes.rb', line 829

def priority
  @priority
end

#status ⇒ Google::Apis::BatchV1::JobStatus

Job status. Corresponds to the JSON property status

Returns:



834
835
836
 
# File 'lib/google/apis/batch_v1/classes.rb', line 834

def status
  @status
end

#task_groups ⇒ Array<Google::Apis::BatchV1::TaskGroup>

Required. TaskGroups in the Job. Only one TaskGroup is supported now. Corresponds to the JSON property taskGroups

Returns:



839
840
841
 
# File 'lib/google/apis/batch_v1/classes.rb', line 839

def task_groups
  @task_groups
end

#uid ⇒ String

Output only. A system generated unique ID (in UUID4 format) for the Job. Corresponds to the JSON property uid

Returns:

  • (String) 


844
845
846
 
# File 'lib/google/apis/batch_v1/classes.rb', line 844

def uid
  @uid
end

#update_time ⇒ String

Output only. The last time the Job was updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


849
850
851
 
# File 'lib/google/apis/batch_v1/classes.rb', line 849

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



856
857
858
859
860
861
862
863
864
865
866
867
868
 
# File 'lib/google/apis/batch_v1/classes.rb', line 856

def update!(**args)
  @allocation_policy = args[:allocation_policy] if args.key?(:allocation_policy)
  @create_time = args[:create_time] if args.key?(:create_time)
  @labels = args[:labels] if args.key?(:labels)
  @logs_policy = args[:logs_policy] if args.key?(:logs_policy)
  @name = args[:name] if args.key?(:name)
  @notifications = args[:notifications] if args.key?(:notifications)
  @priority = args[:priority] if args.key?(:priority)
  @status = args[:status] if args.key?(:status)
  @task_groups = args[:task_groups] if args.key?(:task_groups)
  @uid = args[:uid] if args.key?(:uid)
  @update_time = args[:update_time] if args.key?(:update_time)
end