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.



1002
1003
1004
 
# File 'lib/google/apis/batch_v1/classes.rb', line 1002

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:



942
943
944
 
# File 'lib/google/apis/batch_v1/classes.rb', line 942

def allocation_policy
  @allocation_policy
end

#create_time ⇒ String

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

Returns:

  • (String) 


947
948
949
 
# File 'lib/google/apis/batch_v1/classes.rb', line 947

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


956
957
958
 
# File 'lib/google/apis/batch_v1/classes.rb', line 956

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:



962
963
964
 
# File 'lib/google/apis/batch_v1/classes.rb', line 962

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) 


968
969
970
 
# File 'lib/google/apis/batch_v1/classes.rb', line 968

def name
  @name
end

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

Notification configurations. Corresponds to the JSON property notifications

Returns:



973
974
975
 
# File 'lib/google/apis/batch_v1/classes.rb', line 973

def notifications
  @notifications
end

#priority ⇒ Fixnum

Priority of the Job. The valid value range is [0, 100). 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) 


980
981
982
 
# File 'lib/google/apis/batch_v1/classes.rb', line 980

def priority
  @priority
end

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

Job status. Corresponds to the JSON property status

Returns:



985
986
987
 
# File 'lib/google/apis/batch_v1/classes.rb', line 985

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:



990
991
992
 
# File 'lib/google/apis/batch_v1/classes.rb', line 990

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) 


995
996
997
 
# File 'lib/google/apis/batch_v1/classes.rb', line 995

def uid
  @uid
end

#update_time ⇒ String

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

Returns:

  • (String) 


1000
1001
1002
 
# File 'lib/google/apis/batch_v1/classes.rb', line 1000

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'lib/google/apis/batch_v1/classes.rb', line 1007

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