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.



2051
2052
2053
 
# File 'lib/google/apis/batch_v1/classes.rb', line 2051

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) 


1994
1995
1996
 
# File 'lib/google/apis/batch_v1/classes.rb', line 1994

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) 


2002
2003
2004
 
# File 'lib/google/apis/batch_v1/classes.rb', line 2002

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:



2008
2009
2010
 
# File 'lib/google/apis/batch_v1/classes.rb', line 2008

def barrier
  @barrier
end

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

Container runnable. Corresponds to the JSON property container

Returns:



2013
2014
2015
 
# File 'lib/google/apis/batch_v1/classes.rb', line 2013

def container
  @container
end

#display_name ⇒ String

Optional. DisplayName is an optional field that can be provided by the caller. If provided, it will be used in logs and other outputs to identify the script, making it easier for users to understand the logs. If not provided the index of the runnable will be used for outputs. Corresponds to the JSON property displayName

Returns:

  • (String) 


2021
2022
2023
 
# File 'lib/google/apis/batch_v1/classes.rb', line 2021

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



2027
2028
2029
 
# File 'lib/google/apis/batch_v1/classes.rb', line 2027

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) 


2033
2034
2035
 
# File 'lib/google/apis/batch_v1/classes.rb', line 2033

def ignore_exit_status
  @ignore_exit_status
end

#labels ⇒ Hash<String,String>

Labels for this Runnable. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


2039
2040
2041
 
# File 'lib/google/apis/batch_v1/classes.rb', line 2039

def labels
  @labels
end

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

Script runnable. Corresponds to the JSON property script

Returns:



2044
2045
2046
 
# File 'lib/google/apis/batch_v1/classes.rb', line 2044

def script
  @script
end

#timeout ⇒ String

Timeout for this Runnable. Corresponds to the JSON property timeout

Returns:

  • (String) 


2049
2050
2051
 
# File 'lib/google/apis/batch_v1/classes.rb', line 2049

def timeout
  @timeout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
 
# File 'lib/google/apis/batch_v1/classes.rb', line 2056

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)
  @display_name = args[:display_name] if args.key?(:display_name)
  @environment = args[:environment] if args.key?(:environment)
  @ignore_exit_status = args[:ignore_exit_status] if args.key?(:ignore_exit_status)
  @labels = args[:labels] if args.key?(:labels)
  @script = args[:script] if args.key?(:script)
  @timeout = args[:timeout] if args.key?(:timeout)
end