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.



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

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) 


1957
1958
1959
 
# File 'lib/google/apis/batch_v1/classes.rb', line 1957

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) 


1965
1966
1967
 
# File 'lib/google/apis/batch_v1/classes.rb', line 1965

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:



1971
1972
1973
 
# File 'lib/google/apis/batch_v1/classes.rb', line 1971

def barrier
  @barrier
end

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

Container runnable. Corresponds to the JSON property container

Returns:



1976
1977
1978
 
# File 'lib/google/apis/batch_v1/classes.rb', line 1976

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) 


1984
1985
1986
 
# File 'lib/google/apis/batch_v1/classes.rb', line 1984

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:



1990
1991
1992
 
# File 'lib/google/apis/batch_v1/classes.rb', line 1990

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) 


1996
1997
1998
 
# File 'lib/google/apis/batch_v1/classes.rb', line 1996

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


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

def labels
  @labels
end

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

Script runnable. Corresponds to the JSON property script

Returns:



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

def script
  @script
end

#timeout ⇒ String

Timeout for this Runnable. Corresponds to the JSON property timeout

Returns:

  • (String) 


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

def timeout
  @timeout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
 
# File 'lib/google/apis/batch_v1/classes.rb', line 2019

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