RunnableOrBuilder (proto-google-cloud-batch-v1 0.81.0 API)

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Runnable, Runnable.Builder
```
public interface RunnableOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsLabels(String key)` Labels for this Runnable.
`boolean`	`getAlwaysRun()` By default, after a Runnable fails, no further Runnable are executed.
`boolean`	`getBackground()` Normally, a runnable that doesn't exit causes its task to fail.
`Runnable.Barrier`	`getBarrier()` Barrier runnable.
`Runnable.BarrierOrBuilder`	`getBarrierOrBuilder()` Barrier runnable.
`Runnable.Container`	`getContainer()` Container runnable.
`Runnable.ContainerOrBuilder`	`getContainerOrBuilder()` Container runnable.
`String`	`getDisplayName()` Optional.
`com.google.protobuf.ByteString`	`getDisplayNameBytes()` Optional.
`Environment`	`getEnvironment()` Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup).
`EnvironmentOrBuilder`	`getEnvironmentOrBuilder()` Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup).
`Runnable.ExecutableCase`	`getExecutableCase()`
`boolean`	`getIgnoreExitStatus()` Normally, a runnable that returns a non-zero exit status fails and causes the task to fail.
`Map<String,String>`	`getLabels()` Deprecated.
`int`	`getLabelsCount()` Labels for this Runnable.
`Map<String,String>`	`getLabelsMap()` Labels for this Runnable.
`String`	`getLabelsOrDefault(String key, String defaultValue)` Labels for this Runnable.
`String`	`getLabelsOrThrow(String key)` Labels for this Runnable.
`Runnable.Script`	`getScript()` Script runnable.
`Runnable.ScriptOrBuilder`	`getScriptOrBuilder()` Script runnable.
`com.google.protobuf.Duration`	`getTimeout()` Timeout for this Runnable.
`com.google.protobuf.DurationOrBuilder`	`getTimeoutOrBuilder()` Timeout for this Runnable.
`boolean`	`hasBarrier()` Barrier runnable.
`boolean`	`hasContainer()` Container runnable.
`boolean`	`hasEnvironment()` Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup).
`boolean`	`hasScript()` Script runnable.
`boolean`	`hasTimeout()` Timeout for this Runnable.

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Method Detail

hasContainer
```
boolean hasContainer()
```
```
 Container runnable.
 
```
.google.cloud.batch.v1.Runnable.Container container = 1;
Returns:

Whether the container field is set.

getContainer
```
Runnable.Container getContainer()
```
```
 Container runnable.
 
```
.google.cloud.batch.v1.Runnable.Container container = 1;
Returns:

The container.

getContainerOrBuilder

Runnable.ContainerOrBuilder getContainerOrBuilder()

 Container runnable.

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

hasScript
```
boolean hasScript()
```
```
 Script runnable.
 
```
.google.cloud.batch.v1.Runnable.Script script = 2;
Returns:

Whether the script field is set.

getScript
```
Runnable.Script getScript()
```
```
 Script runnable.
 
```
.google.cloud.batch.v1.Runnable.Script script = 2;
Returns:

The script.

getScriptOrBuilder

Runnable.ScriptOrBuilder getScriptOrBuilder()

 Script runnable.

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

hasBarrier
```
boolean hasBarrier()
```
```
 Barrier runnable.
 
```
.google.cloud.batch.v1.Runnable.Barrier barrier = 6;
Returns:

Whether the barrier field is set.

getBarrier
```
Runnable.Barrier getBarrier()
```
```
 Barrier runnable.
 
```
.google.cloud.batch.v1.Runnable.Barrier barrier = 6;
Returns:

The barrier.

getBarrierOrBuilder

Runnable.BarrierOrBuilder getBarrierOrBuilder()

 Barrier runnable.

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

getDisplayName

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:: The displayName.

getDisplayNameBytes

com.google.protobuf.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:: The bytes for displayName.

getIgnoreExitStatus

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:: The ignoreExitStatus.

getBackground

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:: The background.

getAlwaysRun

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:: The alwaysRun.

hasEnvironment

boolean hasEnvironment()

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

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

Returns:: Whether the environment field is set.

getEnvironment

Environment getEnvironment()

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

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

Returns:: The environment.

getEnvironmentOrBuilder

EnvironmentOrBuilder getEnvironmentOrBuilder()

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

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

hasTimeout
```
boolean hasTimeout()
```
```
 Timeout for this Runnable.
 
```
.google.protobuf.Duration timeout = 8;
Returns:

Whether the timeout field is set.

getTimeout

com.google.protobuf.Duration getTimeout()

 Timeout for this Runnable.

.google.protobuf.Duration timeout = 8;

Returns:: The timeout.

getTimeoutOrBuilder

com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder()

 Timeout for this Runnable.

.google.protobuf.Duration timeout = 8;