Batch V1 API - Class Google::Cloud::Batch::V1::Runnable (v0.15.1)

Reference documentation and code samples for the Batch V1 API class Google::Cloud::Batch::V1::Runnable.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#always_run

def always_run() -> ::Boolean
Returns
  • (::Boolean) — 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.

#always_run=

def always_run=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.

Returns
  • (::Boolean) — 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.

#background

def background() -> ::Boolean
Returns
  • (::Boolean) — 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).

#background=

def background=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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).
Returns
  • (::Boolean) — 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).

#barrier

def barrier() -> ::Google::Cloud::Batch::V1::Runnable::Barrier
Returns

#barrier=

def barrier=(value) -> ::Google::Cloud::Batch::V1::Runnable::Barrier
Parameter
Returns

#container

def container() -> ::Google::Cloud::Batch::V1::Runnable::Container
Returns

#container=

def container=(value) -> ::Google::Cloud::Batch::V1::Runnable::Container
Parameter
Returns

#display_name

def display_name() -> ::String
Returns
  • (::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.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#environment

def environment() -> ::Google::Cloud::Batch::V1::Environment
Returns

#environment=

def environment=(value) -> ::Google::Cloud::Batch::V1::Environment
Parameter
Returns

#ignore_exit_status

def ignore_exit_status() -> ::Boolean
Returns
  • (::Boolean) — Normally, a non-zero exit status causes the Task to fail. This flag allows execution of other Runnables to continue instead.

#ignore_exit_status=

def ignore_exit_status=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Normally, a non-zero exit status causes the Task to fail. This flag allows execution of other Runnables to continue instead.
Returns
  • (::Boolean) — Normally, a non-zero exit status causes the Task to fail. This flag allows execution of other Runnables to continue instead.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Labels for this Runnable.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Labels for this Runnable.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Labels for this Runnable.

#script

def script() -> ::Google::Cloud::Batch::V1::Runnable::Script
Returns

#script=

def script=(value) -> ::Google::Cloud::Batch::V1::Runnable::Script
Parameter
Returns

#timeout

def timeout() -> ::Google::Protobuf::Duration
Returns

#timeout=

def timeout=(value) -> ::Google::Protobuf::Duration
Parameter
Returns