Class: Google::Apis::BatchV1::AgentTaskRunnable

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

AgentTaskRunnable is the Runnable representation between Agent and CLH communication.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ AgentTaskRunnable

Returns a new instance of AgentTaskRunnable.



491
492
493
# File 'lib/google/apis/batch_v1/classes.rb', line 491

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

Instance Attribute Details

#always_runBoolean Also known as: always_run?

By default, after a Runnable fails, no further Runnable are executed. This flag indicates that this Runnable must be run even if the Task has already failed. This is useful for Runnables that copy output files off of the VM or for debugging. The always_run flag does not override the Task's overall max_run_duration. If the max_run_duration has expired then no further Runnables will execute, not even always_run Runnables. Corresponds to the JSON property alwaysRun

Returns:

  • (Boolean)


452
453
454
# File 'lib/google/apis/batch_v1/classes.rb', line 452

def always_run
  @always_run
end

#backgroundBoolean Also known as: background?

This flag allows a Runnable to continue running in the background while the Task executes subsequent Runnables. This is useful to provide services to other Runnables (or to provide debugging support tools like SSH servers). Corresponds to the JSON property background

Returns:

  • (Boolean)


460
461
462
# File 'lib/google/apis/batch_v1/classes.rb', line 460

def background
  @background
end

#containerGoogle::Apis::BatchV1::AgentContainer

Container runnable representation on the agent side. Corresponds to the JSON property container



466
467
468
# File 'lib/google/apis/batch_v1/classes.rb', line 466

def container
  @container
end

#environmentGoogle::Apis::BatchV1::AgentEnvironment

AgentEnvironment is the Environment representation between Agent and CLH communication. The environment is used in both task level and agent level. Corresponds to the JSON property environment



472
473
474
# File 'lib/google/apis/batch_v1/classes.rb', line 472

def environment
  @environment
end

#ignore_exit_statusBoolean Also known as: ignore_exit_status?

Normally, a non-zero exit status causes the Task to fail. This flag allows execution of other Runnables to continue instead. Corresponds to the JSON property ignoreExitStatus

Returns:

  • (Boolean)


478
479
480
# File 'lib/google/apis/batch_v1/classes.rb', line 478

def ignore_exit_status
  @ignore_exit_status
end

#scriptGoogle::Apis::BatchV1::AgentScript

Script runnable representation on the agent side. Corresponds to the JSON property script



484
485
486
# File 'lib/google/apis/batch_v1/classes.rb', line 484

def script
  @script
end

#timeoutString

Timeout for this Runnable. Corresponds to the JSON property timeout

Returns:

  • (String)


489
490
491
# File 'lib/google/apis/batch_v1/classes.rb', line 489

def timeout
  @timeout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



496
497
498
499
500
501
502
503
504
# File 'lib/google/apis/batch_v1/classes.rb', line 496

def update!(**args)
  @always_run = args[:always_run] if args.key?(:always_run)
  @background = args[:background] if args.key?(:background)
  @container = args[:container] if args.key?(:container)
  @environment = args[:environment] if args.key?(:environment)
  @ignore_exit_status = args[:ignore_exit_status] if args.key?(:ignore_exit_status)
  @script = args[:script] if args.key?(:script)
  @timeout = args[:timeout] if args.key?(:timeout)
end