Class Runnable.Builder (0.37.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.v1.Runnable

Implements

RunnableOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Runnable.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Runnable.Builder
Overrides

build()

public Runnable build()
Returns
TypeDescription
Runnable

buildPartial()

public Runnable buildPartial()
Returns
TypeDescription
Runnable

clear()

public Runnable.Builder clear()
Returns
TypeDescription
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
TypeDescription
Runnable.Builder

This builder for chaining.

clearBackground()

public Runnable.Builder clearBackground()

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

bool background = 4;

Returns
TypeDescription
Runnable.Builder

This builder for chaining.

clearBarrier()

public Runnable.Builder clearBarrier()

Barrier runnable.

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

Returns
TypeDescription
Runnable.Builder

clearContainer()

public Runnable.Builder clearContainer()

Container runnable.

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

Returns
TypeDescription
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
TypeDescription
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.v1.Environment environment = 7;

Returns
TypeDescription
Runnable.Builder

clearExecutable()

public Runnable.Builder clearExecutable()
Returns
TypeDescription
Runnable.Builder

clearField(Descriptors.FieldDescriptor field)

public Runnable.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Runnable.Builder
Overrides

clearIgnoreExitStatus()

public Runnable.Builder clearIgnoreExitStatus()

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

bool ignore_exit_status = 3;

Returns
TypeDescription
Runnable.Builder

This builder for chaining.

clearLabels()

public Runnable.Builder clearLabels()
Returns
TypeDescription
Runnable.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Runnable.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Runnable.Builder
Overrides

clearScript()

public Runnable.Builder clearScript()

Script runnable.

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

Returns
TypeDescription
Runnable.Builder

clearTimeout()

public Runnable.Builder clearTimeout()

Timeout for this Runnable.

.google.protobuf.Duration timeout = 8;

Returns
TypeDescription
Runnable.Builder

clone()

public Runnable.Builder clone()
Returns
TypeDescription
Runnable.Builder
Overrides

containsLabels(String key)

public boolean containsLabels(String key)

Labels for this Runnable.

map<string, string> labels = 9;

Parameter
NameDescription
keyString
Returns
TypeDescription
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
TypeDescription
boolean

The alwaysRun.

getBackground()

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

bool background = 4;

Returns
TypeDescription
boolean

The background.

getBarrier()

public Runnable.Barrier getBarrier()

Barrier runnable.

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

Returns
TypeDescription
Runnable.Barrier

The barrier.

getBarrierBuilder()

public Runnable.Barrier.Builder getBarrierBuilder()

Barrier runnable.

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

Returns
TypeDescription
Runnable.Barrier.Builder

getBarrierOrBuilder()

public Runnable.BarrierOrBuilder getBarrierOrBuilder()

Barrier runnable.

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

Returns
TypeDescription
Runnable.BarrierOrBuilder

getContainer()

public Runnable.Container getContainer()

Container runnable.

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

Returns
TypeDescription
Runnable.Container

The container.

getContainerBuilder()

public Runnable.Container.Builder getContainerBuilder()

Container runnable.

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

Returns
TypeDescription
Runnable.Container.Builder

getContainerOrBuilder()

public Runnable.ContainerOrBuilder getContainerOrBuilder()

Container runnable.

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

Returns
TypeDescription
Runnable.ContainerOrBuilder

getDefaultInstanceForType()

public Runnable getDefaultInstanceForType()
Returns
TypeDescription
Runnable

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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.v1.Environment environment = 7;

Returns
TypeDescription
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.v1.Environment environment = 7;

Returns
TypeDescription
Environment.Builder

getEnvironmentOrBuilder()

public EnvironmentOrBuilder getEnvironmentOrBuilder()

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

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

Returns
TypeDescription
EnvironmentOrBuilder

getExecutableCase()

public Runnable.ExecutableCase getExecutableCase()
Returns
TypeDescription
Runnable.ExecutableCase

getIgnoreExitStatus()

public boolean getIgnoreExitStatus()

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

bool ignore_exit_status = 3;

Returns
TypeDescription
boolean

The ignoreExitStatus.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels for this Runnable.

map<string, string> labels = 9;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels for this Runnable.

map<string, string> labels = 9;

Returns
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels for this Runnable.

map<string, string> labels = 9;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getScript()

public Runnable.Script getScript()

Script runnable.

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

Returns
TypeDescription
Runnable.Script

The script.

getScriptBuilder()

public Runnable.Script.Builder getScriptBuilder()

Script runnable.

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

Returns
TypeDescription
Runnable.Script.Builder

getScriptOrBuilder()

public Runnable.ScriptOrBuilder getScriptOrBuilder()

Script runnable.

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

Returns
TypeDescription
Runnable.ScriptOrBuilder

getTimeout()

public Duration getTimeout()

Timeout for this Runnable.

.google.protobuf.Duration timeout = 8;

Returns
TypeDescription
Duration

The timeout.

getTimeoutBuilder()

public Duration.Builder getTimeoutBuilder()

Timeout for this Runnable.

.google.protobuf.Duration timeout = 8;

Returns
TypeDescription
Builder

getTimeoutOrBuilder()

public DurationOrBuilder getTimeoutOrBuilder()

Timeout for this Runnable.

.google.protobuf.Duration timeout = 8;

Returns
TypeDescription
DurationOrBuilder

hasBarrier()

public boolean hasBarrier()

Barrier runnable.

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

Returns
TypeDescription
boolean

Whether the barrier field is set.

hasContainer()

public boolean hasContainer()

Container runnable.

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

Returns
TypeDescription
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.v1.Environment environment = 7;

Returns
TypeDescription
boolean

Whether the environment field is set.

hasScript()

public boolean hasScript()

Script runnable.

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

Returns
TypeDescription
boolean

Whether the script field is set.

hasTimeout()

public boolean hasTimeout()

Timeout for this Runnable.

.google.protobuf.Duration timeout = 8;

Returns
TypeDescription
boolean

Whether the timeout field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeBarrier(Runnable.Barrier value)

public Runnable.Builder mergeBarrier(Runnable.Barrier value)

Barrier runnable.

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

Parameter
NameDescription
valueRunnable.Barrier
Returns
TypeDescription
Runnable.Builder

mergeContainer(Runnable.Container value)

public Runnable.Builder mergeContainer(Runnable.Container value)

Container runnable.

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

Parameter
NameDescription
valueRunnable.Container
Returns
TypeDescription
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.v1.Environment environment = 7;

Parameter
NameDescription
valueEnvironment
Returns
TypeDescription
Runnable.Builder

mergeFrom(Runnable other)

public Runnable.Builder mergeFrom(Runnable other)
Parameter
NameDescription
otherRunnable
Returns
TypeDescription
Runnable.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Runnable.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Runnable.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Runnable.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Runnable.Builder
Overrides

mergeScript(Runnable.Script value)

public Runnable.Builder mergeScript(Runnable.Script value)

Script runnable.

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

Parameter
NameDescription
valueRunnable.Script
Returns
TypeDescription
Runnable.Builder

mergeTimeout(Duration value)

public Runnable.Builder mergeTimeout(Duration value)

Timeout for this Runnable.

.google.protobuf.Duration timeout = 8;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
Runnable.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Runnable.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valuesMap<String,String>
Returns
TypeDescription
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
NameDescription
keyString
valueString
Returns
TypeDescription
Runnable.Builder

removeLabels(String key)

public Runnable.Builder removeLabels(String key)

Labels for this Runnable.

map<string, string> labels = 9;

Parameter
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
valueboolean

The alwaysRun to set.

Returns
TypeDescription
Runnable.Builder

This builder for chaining.

setBackground(boolean value)

public Runnable.Builder setBackground(boolean value)

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

bool background = 4;

Parameter
NameDescription
valueboolean

The background to set.

Returns
TypeDescription
Runnable.Builder

This builder for chaining.

setBarrier(Runnable.Barrier value)

public Runnable.Builder setBarrier(Runnable.Barrier value)

Barrier runnable.

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

Parameter
NameDescription
valueRunnable.Barrier
Returns
TypeDescription
Runnable.Builder

setBarrier(Runnable.Barrier.Builder builderForValue)

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

Barrier runnable.

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

Parameter
NameDescription
builderForValueRunnable.Barrier.Builder
Returns
TypeDescription
Runnable.Builder

setContainer(Runnable.Container value)

public Runnable.Builder setContainer(Runnable.Container value)

Container runnable.

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

Parameter
NameDescription
valueRunnable.Container
Returns
TypeDescription
Runnable.Builder

setContainer(Runnable.Container.Builder builderForValue)

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

Container runnable.

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

Parameter
NameDescription
builderForValueRunnable.Container.Builder
Returns
TypeDescription
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
NameDescription
valueString

The displayName to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for displayName to set.

Returns
TypeDescription
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.v1.Environment environment = 7;

Parameter
NameDescription
valueEnvironment
Returns
TypeDescription
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.v1.Environment environment = 7;

Parameter
NameDescription
builderForValueEnvironment.Builder
Returns
TypeDescription
Runnable.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Runnable.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Runnable.Builder
Overrides

setIgnoreExitStatus(boolean value)

public Runnable.Builder setIgnoreExitStatus(boolean value)

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

bool ignore_exit_status = 3;

Parameter
NameDescription
valueboolean

The ignoreExitStatus to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Runnable.Builder
Overrides

setScript(Runnable.Script value)

public Runnable.Builder setScript(Runnable.Script value)

Script runnable.

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

Parameter
NameDescription
valueRunnable.Script
Returns
TypeDescription
Runnable.Builder

setScript(Runnable.Script.Builder builderForValue)

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

Script runnable.

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

Parameter
NameDescription
builderForValueRunnable.Script.Builder
Returns
TypeDescription
Runnable.Builder

setTimeout(Duration value)

public Runnable.Builder setTimeout(Duration value)

Timeout for this Runnable.

.google.protobuf.Duration timeout = 8;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
Runnable.Builder

setTimeout(Duration.Builder builderForValue)

public Runnable.Builder setTimeout(Duration.Builder builderForValue)

Timeout for this Runnable.

.google.protobuf.Duration timeout = 8;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Runnable.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Runnable.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Runnable.Builder
Overrides