Class: Google::Apis::BatchV1::TaskSpec

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

Spec of a task

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ TaskSpec

Returns a new instance of TaskSpec.



2328
2329
2330
 
# File 'lib/google/apis/batch_v1/classes.rb', line 2328

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

Instance Attribute Details

#compute_resource ⇒ Google::Apis::BatchV1::ComputeResource

Compute resource requirements. ComputeResource defines the amount of resources required for each task. Make sure your tasks have enough resources to successfully run. If you also define the types of resources for a job to use with the InstancePolicyOrTemplate field, make sure both fields are compatible with each other. Corresponds to the JSON property computeResource

Returns:



2276
2277
2278
 
# File 'lib/google/apis/batch_v1/classes.rb', line 2276

def compute_resource
  @compute_resource
end

#environment ⇒ Google::Apis::BatchV1::Environment

An Environment describes a collection of environment variables to set when executing Tasks. Corresponds to the JSON property environment

Returns:



2282
2283
2284
 
# File 'lib/google/apis/batch_v1/classes.rb', line 2282

def environment
  @environment
end

#environments ⇒ Hash<String,String>

Deprecated: please use environment(non-plural) instead. Corresponds to the JSON property environments

Returns:

  • (Hash<String,String>) 


2287
2288
2289
 
# File 'lib/google/apis/batch_v1/classes.rb', line 2287

def environments
  @environments
end

#lifecycle_policies ⇒ Array<Google::Apis::BatchV1::LifecyclePolicy>

Lifecycle management schema when any task in a task group is failed. Currently we only support one lifecycle policy. When the lifecycle policy condition is met, the action in the policy will execute. If task execution result does not meet with the defined lifecycle policy, we consider it as the default policy. Default policy means if the exit code is 0, exit task. If task ends with non- zero exit code, retry the task with max_retry_count. Corresponds to the JSON property lifecyclePolicies

Returns:



2297
2298
2299
 
# File 'lib/google/apis/batch_v1/classes.rb', line 2297

def lifecycle_policies
  @lifecycle_policies
end

#max_retry_count ⇒ Fixnum

Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10]. Corresponds to the JSON property maxRetryCount

Returns:

  • (Fixnum) 


2303
2304
2305
 
# File 'lib/google/apis/batch_v1/classes.rb', line 2303

def max_retry_count
  @max_retry_count
end

#max_run_duration ⇒ String

Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit. Corresponds to the JSON property maxRunDuration

Returns:

  • (String) 


2309
2310
2311
 
# File 'lib/google/apis/batch_v1/classes.rb', line 2309

def max_run_duration
  @max_run_duration
end

#runnables ⇒ Array<Google::Apis::BatchV1::Runnable>

The sequence of scripts or containers to run for this Task. Each Task using this TaskSpec executes its list of runnables in order. The Task succeeds if all of its runnables either exit with a zero status or any that exit with a non-zero status have the ignore_exit_status flag. Background runnables are killed automatically (if they have not already exited) a short time after all foreground runnables have completed. Even though this is likely to result in a non-zero exit status for the background runnable, these automatic kills are not treated as Task failures. Corresponds to the JSON property runnables

Returns:



2321
2322
2323
 
# File 'lib/google/apis/batch_v1/classes.rb', line 2321

def runnables
  @runnables
end

#volumes ⇒ Array<Google::Apis::BatchV1::Volume>

Volumes to mount before running Tasks using this TaskSpec. Corresponds to the JSON property volumes

Returns:



2326
2327
2328
 
# File 'lib/google/apis/batch_v1/classes.rb', line 2326

def volumes
  @volumes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
 
# File 'lib/google/apis/batch_v1/classes.rb', line 2333

def update!(**args)
  @compute_resource = args[:compute_resource] if args.key?(:compute_resource)
  @environment = args[:environment] if args.key?(:environment)
  @environments = args[:environments] if args.key?(:environments)
  @lifecycle_policies = args[:lifecycle_policies] if args.key?(:lifecycle_policies)
  @max_retry_count = args[:max_retry_count] if args.key?(:max_retry_count)
  @max_run_duration = args[:max_run_duration] if args.key?(:max_run_duration)
  @runnables = args[:runnables] if args.key?(:runnables)
  @volumes = args[:volumes] if args.key?(:volumes)
end