Interface RunnableOrBuilder (0.55.0)

Version latest

• 0.55.0 (latest)
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.2
• 0.2.2
• 0.1.1

public interface RunnableOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Labels for this Runnable.

map<string, string> labels = 9;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAlwaysRun()

public abstract boolean 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.

bool always_run = 5;

Returns
Type	Description
boolean	The alwaysRun.

getBackground()

public abstract boolean getBackground()

Normally, a runnable that doesn't exit causes its task to fail. However, you can set this field to true to configure a background runnable. Background runnables are allowed continue running in the background while the task executes subsequent runnables. For example, background runnables are useful for providing services to other runnables or providing debugging-support tools like SSH servers.

Specifically, background runnables are killed automatically (if they have not already exited) a short time after all foreground runnables have completed. Even though this is likely to result in a non-zero exit status for the background runnable, these automatic kills are not treated as task failures.

bool background = 4;

Returns
Type	Description
boolean	The background.

getBarrier()

public abstract Runnable.Barrier getBarrier()

Barrier runnable.

.google.cloud.batch.v1.Runnable.Barrier barrier = 6;

Returns
Type	Description
Runnable.Barrier	The barrier.

getBarrierOrBuilder()

public abstract Runnable.BarrierOrBuilder getBarrierOrBuilder()

Barrier runnable.

.google.cloud.batch.v1.Runnable.Barrier barrier = 6;

Returns
Type	Description
Runnable.BarrierOrBuilder

getContainer()

public abstract Runnable.Container getContainer()

Container runnable.

.google.cloud.batch.v1.Runnable.Container container = 1;

Returns
Type	Description
Runnable.Container	The container.

getContainerOrBuilder()

public abstract Runnable.ContainerOrBuilder getContainerOrBuilder()

Container runnable.

.google.cloud.batch.v1.Runnable.Container container = 1;

Returns
Type	Description
Runnable.ContainerOrBuilder

getDisplayName()

public abstract String getDisplayName()

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.

string display_name = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

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.

string display_name = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for displayName.

getEnvironment()

public abstract Environment getEnvironment()

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

.google.cloud.batch.v1.Environment environment = 7;

Returns
Type	Description
Environment	The environment.

getEnvironmentOrBuilder()

public abstract EnvironmentOrBuilder getEnvironmentOrBuilder()

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

.google.cloud.batch.v1.Environment environment = 7;

Returns
Type	Description
EnvironmentOrBuilder

getExecutableCase()

public abstract Runnable.ExecutableCase getExecutableCase()

Returns
Type	Description
Runnable.ExecutableCase

getIgnoreExitStatus()

public abstract boolean getIgnoreExitStatus()

Normally, a runnable that returns a non-zero exit status fails and causes the task to fail. However, you can set this field to true to allow the task to continue executing its other runnables even if this runnable fails.

bool ignore_exit_status = 3;

Returns
Type	Description
boolean	The ignoreExitStatus.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Labels for this Runnable.

map<string, string> labels = 9;

Returns
Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Labels for this Runnable.

map<string, string> labels = 9;

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Labels for this Runnable.

map<string, string> labels = 9;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Labels for this Runnable.

map<string, string> labels = 9;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getScript()

public abstract Runnable.Script getScript()

Script runnable.

.google.cloud.batch.v1.Runnable.Script script = 2;

Returns
Type	Description
Runnable.Script	The script.

getScriptOrBuilder()

public abstract Runnable.ScriptOrBuilder getScriptOrBuilder()

Script runnable.

.google.cloud.batch.v1.Runnable.Script script = 2;

Returns
Type	Description
Runnable.ScriptOrBuilder

getTimeout()

public abstract Duration getTimeout()

Timeout for this Runnable.

.google.protobuf.Duration timeout = 8;

Returns
Type	Description
Duration	The timeout.

getTimeoutOrBuilder()

public abstract DurationOrBuilder getTimeoutOrBuilder()

Timeout for this Runnable.

.google.protobuf.Duration timeout = 8;

Returns
Type	Description
DurationOrBuilder

hasBarrier()

public abstract boolean hasBarrier()

Barrier runnable.

.google.cloud.batch.v1.Runnable.Barrier barrier = 6;

Returns
Type	Description
boolean	Whether the barrier field is set.

hasContainer()

public abstract boolean hasContainer()

Container runnable.

.google.cloud.batch.v1.Runnable.Container container = 1;

Returns
Type	Description
boolean	Whether the container field is set.

hasEnvironment()

public abstract boolean hasEnvironment()

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

.google.cloud.batch.v1.Environment environment = 7;

Returns
Type	Description
boolean	Whether the environment field is set.

hasScript()

public abstract boolean hasScript()

Script runnable.

.google.cloud.batch.v1.Runnable.Script script = 2;

Returns
Type	Description
boolean	Whether the script field is set.

hasTimeout()

public abstract boolean hasTimeout()

Timeout for this Runnable.

.google.protobuf.Duration timeout = 8;

Returns
Type	Description
boolean	Whether the timeout field is set.