Google Cloud Batch V1 Client - Class Runnable (0.7.0)

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

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

Generated from protobuf message google.cloud.batch.v1.Runnable

Namespace

Google \ Cloud \ Batch \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ container
↳ script
↳ barrier
↳ ignore_exit_status
bool

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

↳ background
bool

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

↳ always_run
bool

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.

↳ environment
Google\Cloud\Batch\V1\Environment

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

↳ timeout
Google\Protobuf\Duration

Timeout for this Runnable.

↳ labels
array| Google\Protobuf\Internal\MapField

Labels for this Runnable.

getContainer

Container runnable.

Returns
Type
Description

hasContainer

setContainer

Container runnable.

Parameter
Name
Description
Returns
Type
Description
$this

getScript

Script runnable.

Returns
Type
Description

hasScript

setScript

Script runnable.

Parameter
Name
Description
Returns
Type
Description
$this

getBarrier

Barrier runnable.

Returns
Type
Description

hasBarrier

setBarrier

Barrier runnable.

Parameter
Name
Description
Returns
Type
Description
$this

getIgnoreExitStatus

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

Returns
Type
Description
bool

setIgnoreExitStatus

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

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getBackground

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
Type
Description
bool

setBackground

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

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getAlwaysRun

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
Type
Description
bool

setAlwaysRun

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.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getEnvironment

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

Returns
Type
Description

hasEnvironment

clearEnvironment

setEnvironment

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

Parameter
Name
Description
Returns
Type
Description
$this

getTimeout

Timeout for this Runnable.

Returns
Type
Description

hasTimeout

clearTimeout

setTimeout

Timeout for this Runnable.

Parameter
Name
Description
Returns
Type
Description
$this

getLabels

Labels for this Runnable.

Returns
Type
Description

setLabels

Labels for this Runnable.

Parameter
Name
Description
Returns
Type
Description
$this

getExecutable

Returns
Type
Description
string
Create a Mobile Website
View Site in Mobile | Classic
Share by: