Batch v1 API - Class Runnable (2.10.0)

public sealed class Runnable : IMessage<Runnable>, IEquatable<Runnable>, IDeepCloneable<Runnable>, IBufferMessage, IMessage

Reference documentation and code samples for the Batch v1 API class Runnable.

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

Inheritance

object > Runnable

Namespace

Google.Cloud.Batch.V1

Assembly

Google.Cloud.Batch.V1.dll

Constructors

Runnable()

public Runnable()

Runnable(Runnable)

public Runnable(Runnable other)
Parameter
Name Description
other Runnable

Properties

AlwaysRun

public bool AlwaysRun { get; set; }

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.

Property Value
Type Description
bool

Background

public bool Background { get; set; }

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

Property Value
Type Description
bool

Barrier

public Runnable.Types.Barrier Barrier { get; set; }

Barrier runnable.

Property Value
Type Description
RunnableTypesBarrier

Container

public Runnable.Types.Container Container { get; set; }

Container runnable.

Property Value
Type Description
RunnableTypesContainer

DisplayName

public string DisplayName { get; set; }

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.

Property Value
Type Description
string

Environment

public Environment Environment { get; set; }

Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup).

Property Value
Type Description
Environment

ExecutableCase

public Runnable.ExecutableOneofCase ExecutableCase { get; }
Property Value
Type Description
RunnableExecutableOneofCase

IgnoreExitStatus

public bool IgnoreExitStatus { get; set; }

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

Property Value
Type Description
bool

Labels

public MapField<string, string> Labels { get; }

Labels for this Runnable.

Property Value
Type Description
MapFieldstringstring

Script

public Runnable.Types.Script Script { get; set; }

Script runnable.

Property Value
Type Description
RunnableTypesScript

Timeout

public Duration Timeout { get; set; }

Timeout for this Runnable.

Property Value
Type Description
Duration