Class: Google::Apis::BatchV1::Runnable

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

Runnable describes instructions for executing a specific script or container as part of a Task.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Runnable

Returns a new instance of Runnable.



1777
1778
1779
 
# File 'lib/google/apis/batch_v1/classes.rb', line 1777

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

Instance Attribute Details

#always_run ⇒ Boolean 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) 


1733
1734
1735
 
# File 'lib/google/apis/batch_v1/classes.rb', line 1733

def always_run
  @always_run
end

#background ⇒ Boolean 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) 


1741
1742
1743
 
# File 'lib/google/apis/batch_v1/classes.rb', line 1741

def background
  @background
end

#barrier ⇒ Google::Apis::BatchV1::Barrier

Barrier runnable blocks until all tasks in a taskgroup reach it. Corresponds to the JSON property barrier

Returns:



1747
1748
1749
 
# File 'lib/google/apis/batch_v1/classes.rb', line 1747

def barrier
  @barrier
end

#container ⇒ Google::Apis::BatchV1::Container

Container runnable. Corresponds to the JSON property container

Returns:



1752
1753
1754
 
# File 'lib/google/apis/batch_v1/classes.rb', line 1752

def container
  @container
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:



1758
1759
1760
 
# File 'lib/google/apis/batch_v1/classes.rb', line 1758

def environment
  @environment
end

#ignore_exit_status ⇒ Boolean 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) 


1764
1765
1766
 
# File 'lib/google/apis/batch_v1/classes.rb', line 1764

def ignore_exit_status
  @ignore_exit_status
end

#script ⇒ Google::Apis::BatchV1::Script

Script runnable. Corresponds to the JSON property script

Returns:



1770
1771
1772
 
# File 'lib/google/apis/batch_v1/classes.rb', line 1770

def script
  @script
end

#timeout ⇒ String

Timeout for this Runnable. Corresponds to the JSON property timeout

Returns:

  • (String) 


1775
1776
1777
 
# File 'lib/google/apis/batch_v1/classes.rb', line 1775

def timeout
  @timeout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
 
# File 'lib/google/apis/batch_v1/classes.rb', line 1782

def update!(**args)
  @always_run = args[:always_run] if args.key?(:always_run)
  @background = args[:background] if args.key?(:background)
  @barrier = args[:barrier] if args.key?(:barrier)
  @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