Class Runnable.Builder (0.54.0) 

public static final class Runnable.Builder extends GeneratedMessageV3.Builder<Runnable.Builder> implements RunnableOrBuilder

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

Protobuf type google.cloud.batch.v1alpha.Runnable

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Runnable.Builder

Implements

RunnableOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Runnable.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Runnable.Builder
Overrides

build()

public Runnable build()
Returns
Type Description
Runnable

buildPartial()

public Runnable buildPartial()
Returns
Type Description
Runnable

clear()

public Runnable.Builder clear()
Returns
Type Description
Runnable.Builder
Overrides

clearAlwaysRun()

public Runnable.Builder clearAlwaysRun()

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
Runnable.Builder

This builder for chaining.

clearBackground()

public Runnable.Builder clearBackground()

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
Runnable.Builder

This builder for chaining.

clearBarrier()

public Runnable.Builder clearBarrier()

Barrier runnable.

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

Returns
Type Description
Runnable.Builder

clearContainer()

public Runnable.Builder clearContainer()

Container runnable.

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

Returns
Type Description
Runnable.Builder

clearDisplayName()

public Runnable.Builder clearDisplayName()

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
Runnable.Builder

This builder for chaining.

clearEnvironment()

public Runnable.Builder clearEnvironment()

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

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

Returns
Type Description
Runnable.Builder

clearExecutable()

public Runnable.Builder clearExecutable()
Returns
Type Description
Runnable.Builder

clearField(Descriptors.FieldDescriptor field)

public Runnable.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Runnable.Builder
Overrides

clearIgnoreExitStatus()

public Runnable.Builder clearIgnoreExitStatus()

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
Runnable.Builder

This builder for chaining.

clearLabels()

public Runnable.Builder clearLabels()
Returns
Type Description
Runnable.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Runnable.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Runnable.Builder
Overrides

clearScript()

public Runnable.Builder clearScript()

Script runnable.

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

Returns
Type Description
Runnable.Builder

clearTimeout()

public Runnable.Builder clearTimeout()

Timeout for this Runnable.

.google.protobuf.Duration timeout = 8;

Returns
Type Description
Runnable.Builder

clone()

public Runnable.Builder clone()
Returns
Type Description
Runnable.Builder
Overrides

containsLabels(String key)

public boolean containsLabels(String key)

Labels for this Runnable.

map<string, string> labels = 9;

Parameter
Name Description
key String
Returns
Type Description
boolean

getAlwaysRun()

public 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 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 Runnable.Barrier getBarrier()

Barrier runnable.

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

Returns
Type Description
Runnable.Barrier

The barrier.

getBarrierBuilder()

public Runnable.Barrier.Builder getBarrierBuilder()

Barrier runnable.

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

Returns
Type Description
Runnable.Barrier.Builder

getBarrierOrBuilder()

public Runnable.BarrierOrBuilder getBarrierOrBuilder()

Barrier runnable.

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

Returns
Type Description
Runnable.BarrierOrBuilder

getContainer()

public Runnable.Container getContainer()

Container runnable.

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

Returns
Type Description
Runnable.Container

The container.

getContainerBuilder()

public Runnable.Container.Builder getContainerBuilder()

Container runnable.

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

Returns
Type Description
Runnable.Container.Builder

getContainerOrBuilder()

public Runnable.ContainerOrBuilder getContainerOrBuilder()

Container runnable.

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

Returns
Type Description
Runnable.ContainerOrBuilder

getDefaultInstanceForType()

public Runnable getDefaultInstanceForType()
Returns
Type Description
Runnable

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

public 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 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 Environment getEnvironment()

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

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

Returns
Type Description
Environment

The environment.

getEnvironmentBuilder()

public Environment.Builder getEnvironmentBuilder()

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

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

Returns
Type Description
Environment.Builder

getEnvironmentOrBuilder()

public EnvironmentOrBuilder getEnvironmentOrBuilder()

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

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

Returns
Type Description
EnvironmentOrBuilder

getExecutableCase()

public Runnable.ExecutableCase getExecutableCase()
Returns
Type Description
Runnable.ExecutableCase

getIgnoreExitStatus()

public 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 Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels for this Runnable.

map<string, string> labels = 9;

Returns
Type Description
int

getLabelsMap()

public 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 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 String getLabelsOrThrow(String key)

Labels for this Runnable.

map<string, string> labels = 9;

Parameter
Name Description
key String
Returns
Type Description
String

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getScript()

public Runnable.Script getScript()

Script runnable.

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

Returns
Type Description
Runnable.Script

The script.

getScriptBuilder()

public Runnable.Script.Builder getScriptBuilder()

Script runnable.

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

Returns
Type Description
Runnable.Script.Builder

getScriptOrBuilder()

public Runnable.ScriptOrBuilder getScriptOrBuilder()

Script runnable.

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

Returns
Type Description
Runnable.ScriptOrBuilder

getTimeout()

public Duration getTimeout()

Timeout for this Runnable.

.google.protobuf.Duration timeout = 8;

Returns
Type Description
Duration

The timeout.

getTimeoutBuilder()

public Duration.Builder getTimeoutBuilder()

Timeout for this Runnable.

.google.protobuf.Duration timeout = 8;

Returns
Type Description
Builder

getTimeoutOrBuilder()

public DurationOrBuilder getTimeoutOrBuilder()

Timeout for this Runnable.

.google.protobuf.Duration timeout = 8;

Returns
Type Description
DurationOrBuilder

hasBarrier()

public boolean hasBarrier()

Barrier runnable.

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

Returns
Type Description
boolean

Whether the barrier field is set.

hasContainer()

public boolean hasContainer()

Container runnable.

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

Returns
Type Description
boolean

Whether the container field is set.

hasEnvironment()

public boolean hasEnvironment()

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

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

Returns
Type Description
boolean

Whether the environment field is set.

hasScript()

public boolean hasScript()

Script runnable.

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

Returns
Type Description
boolean

Whether the script field is set.

hasTimeout()

public boolean hasTimeout()

Timeout for this Runnable.

.google.protobuf.Duration timeout = 8;

Returns
Type Description
boolean

Whether the timeout field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBarrier(Runnable.Barrier value)

public Runnable.Builder mergeBarrier(Runnable.Barrier value)

Barrier runnable.

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

Parameter
Name Description
value Runnable.Barrier
Returns
Type Description
Runnable.Builder

mergeContainer(Runnable.Container value)

public Runnable.Builder mergeContainer(Runnable.Container value)

Container runnable.

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

Parameter
Name Description
value Runnable.Container
Returns
Type Description
Runnable.Builder

mergeEnvironment(Environment value)

public Runnable.Builder mergeEnvironment(Environment value)

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

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

Parameter
Name Description
value Environment
Returns
Type Description
Runnable.Builder

mergeFrom(Runnable other)

public Runnable.Builder mergeFrom(Runnable other)
Parameter
Name Description
other Runnable
Returns
Type Description
Runnable.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Runnable.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Runnable.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Runnable.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Runnable.Builder
Overrides

mergeScript(Runnable.Script value)

public Runnable.Builder mergeScript(Runnable.Script value)

Script runnable.

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

Parameter
Name Description
value Runnable.Script
Returns
Type Description
Runnable.Builder

mergeTimeout(Duration value)

public Runnable.Builder mergeTimeout(Duration value)

Timeout for this Runnable.

.google.protobuf.Duration timeout = 8;

Parameter
Name Description
value Duration
Returns
Type Description
Runnable.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Runnable.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Runnable.Builder
Overrides

putAllLabels(Map<String,String> values)

public Runnable.Builder putAllLabels(Map<String,String> values)

Labels for this Runnable.

map<string, string> labels = 9;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Runnable.Builder

putLabels(String key, String value)

public Runnable.Builder putLabels(String key, String value)

Labels for this Runnable.

map<string, string> labels = 9;

Parameters
Name Description
key String
value String
Returns
Type Description
Runnable.Builder

removeLabels(String key)

public Runnable.Builder removeLabels(String key)

Labels for this Runnable.

map<string, string> labels = 9;

Parameter
Name Description
key String
Returns
Type Description
Runnable.Builder

setAlwaysRun(boolean value)

public Runnable.Builder setAlwaysRun(boolean value)

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;

Parameter
Name Description
value boolean

The alwaysRun to set.
Returns
Type Description
Runnable.Builder

This builder for chaining.

setBackground(boolean value)

public Runnable.Builder setBackground(boolean value)

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;

Parameter
Name Description
value boolean

The background to set.
Returns
Type Description
Runnable.Builder

This builder for chaining.

setBarrier(Runnable.Barrier value)

public Runnable.Builder setBarrier(Runnable.Barrier value)

Barrier runnable.

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

Parameter
Name Description
value Runnable.Barrier
Returns
Type Description
Runnable.Builder

setBarrier(Runnable.Barrier.Builder builderForValue)

public Runnable.Builder setBarrier(Runnable.Barrier.Builder builderForValue)

Barrier runnable.

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

Parameter
Name Description
builderForValue Runnable.Barrier.Builder
Returns
Type Description
Runnable.Builder

setContainer(Runnable.Container value)

public Runnable.Builder setContainer(Runnable.Container value)

Container runnable.

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

Parameter
Name Description
value Runnable.Container
Returns
Type Description
Runnable.Builder

setContainer(Runnable.Container.Builder builderForValue)

public Runnable.Builder setContainer(Runnable.Container.Builder builderForValue)

Container runnable.

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

Parameter
Name Description
builderForValue Runnable.Container.Builder
Returns
Type Description
Runnable.Builder

setDisplayName(String value)

public Runnable.Builder setDisplayName(String value)

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];

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
Runnable.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Runnable.Builder setDisplayNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
Runnable.Builder

This builder for chaining.

setEnvironment(Environment value)

public Runnable.Builder setEnvironment(Environment value)

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

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

Parameter
Name Description
value Environment
Returns
Type Description
Runnable.Builder

setEnvironment(Environment.Builder builderForValue)

public Runnable.Builder setEnvironment(Environment.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Environment.Builder
Returns
Type Description
Runnable.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Runnable.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Runnable.Builder
Overrides

setIgnoreExitStatus(boolean value)

public Runnable.Builder setIgnoreExitStatus(boolean value)

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;

Parameter
Name Description
value boolean

The ignoreExitStatus to set.
Returns
Type Description
Runnable.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Runnable.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Runnable.Builder
Overrides

setScript(Runnable.Script value)

public Runnable.Builder setScript(Runnable.Script value)

Script runnable.

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

Parameter
Name Description
value Runnable.Script
Returns
Type Description
Runnable.Builder

setScript(Runnable.Script.Builder builderForValue)

public Runnable.Builder setScript(Runnable.Script.Builder builderForValue)

Script runnable.

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

Parameter
Name Description
builderForValue Runnable.Script.Builder
Returns
Type Description
Runnable.Builder

setTimeout(Duration value)

public Runnable.Builder setTimeout(Duration value)

Timeout for this Runnable.

.google.protobuf.Duration timeout = 8;

Parameter
Name Description
value Duration
Returns
Type Description
Runnable.Builder

setTimeout(Duration.Builder builderForValue)

public Runnable.Builder setTimeout(Duration.Builder builderForValue)

Timeout for this Runnable.

.google.protobuf.Duration timeout = 8;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Runnable.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Runnable.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Runnable.Builder
Overrides