Package com.google.cloud.batch.v1alpha

Class Runnable.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Runnable.Builder>
com.google.cloud.batch.v1alpha.Runnable.Builder
All Implemented Interfaces:
RunnableOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Runnable
public static final class Runnable.Builder extends com.google.protobuf.GeneratedMessage.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

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<Runnable.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<Runnable.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Runnable.Builder>

    • clear

      public Runnable.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<Runnable.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Runnable.Builder>

    • getDefaultInstanceForType

      public Runnable getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public Runnable build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public Runnable buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public Runnable.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Runnable.Builder>

    • mergeFrom

      public Runnable.Builder mergeFrom(Runnable other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Runnable.Builder>

    • mergeFrom

      public Runnable.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Runnable.Builder>
      Throws:
      IOException

    • getExecutableCase

      public Runnable.ExecutableCase getExecutableCase()
      Specified by:
      getExecutableCase in interface RunnableOrBuilder

    • clearExecutable

      public Runnable.Builder clearExecutable()

    • hasContainer

      public boolean hasContainer()
       Container runnable.
      .google.cloud.batch.v1alpha.Runnable.Container container = 1;
      Specified by:
      hasContainer in interface RunnableOrBuilder
      Returns:
      Whether the container field is set.

    • getContainer

      public Runnable.Container getContainer()
       Container runnable.
      .google.cloud.batch.v1alpha.Runnable.Container container = 1;
      Specified by:
      getContainer in interface RunnableOrBuilder
      Returns:
      The container.

    • setContainer

      public Runnable.Builder setContainer(Runnable.Container value)
       Container runnable.
      .google.cloud.batch.v1alpha.Runnable.Container container = 1;

    • setContainer

      public Runnable.Builder setContainer(Runnable.Container.Builder builderForValue)
       Container runnable.
      .google.cloud.batch.v1alpha.Runnable.Container container = 1;

    • mergeContainer

      public Runnable.Builder mergeContainer(Runnable.Container value)
       Container runnable.
      .google.cloud.batch.v1alpha.Runnable.Container container = 1;

    • clearContainer

      public Runnable.Builder clearContainer()
       Container runnable.
      .google.cloud.batch.v1alpha.Runnable.Container container = 1;

    • getContainerBuilder

      public Runnable.Container.Builder getContainerBuilder()
       Container runnable.
      .google.cloud.batch.v1alpha.Runnable.Container container = 1;

    • getContainerOrBuilder

      public Runnable.ContainerOrBuilder getContainerOrBuilder()
       Container runnable.
      .google.cloud.batch.v1alpha.Runnable.Container container = 1;
      Specified by:
      getContainerOrBuilder in interface RunnableOrBuilder

    • hasScript

      public boolean hasScript()
       Script runnable.
      .google.cloud.batch.v1alpha.Runnable.Script script = 2;
      Specified by:
      hasScript in interface RunnableOrBuilder
      Returns:
      Whether the script field is set.

    • getScript

      public Runnable.Script getScript()
       Script runnable.
      .google.cloud.batch.v1alpha.Runnable.Script script = 2;
      Specified by:
      getScript in interface RunnableOrBuilder
      Returns:
      The script.

    • setScript

      public Runnable.Builder setScript(Runnable.Script value)
       Script runnable.
      .google.cloud.batch.v1alpha.Runnable.Script script = 2;

    • setScript

      public Runnable.Builder setScript(Runnable.Script.Builder builderForValue)
       Script runnable.
      .google.cloud.batch.v1alpha.Runnable.Script script = 2;

    • mergeScript

      public Runnable.Builder mergeScript(Runnable.Script value)
       Script runnable.
      .google.cloud.batch.v1alpha.Runnable.Script script = 2;

    • clearScript

      public Runnable.Builder clearScript()
       Script runnable.
      .google.cloud.batch.v1alpha.Runnable.Script script = 2;

    • getScriptBuilder

      public Runnable.Script.Builder getScriptBuilder()
       Script runnable.
      .google.cloud.batch.v1alpha.Runnable.Script script = 2;

    • getScriptOrBuilder

      public Runnable.ScriptOrBuilder getScriptOrBuilder()
       Script runnable.
      .google.cloud.batch.v1alpha.Runnable.Script script = 2;
      Specified by:
      getScriptOrBuilder in interface RunnableOrBuilder

    • hasBarrier

      public boolean hasBarrier()
       Barrier runnable.
      .google.cloud.batch.v1alpha.Runnable.Barrier barrier = 6;
      Specified by:
      hasBarrier in interface RunnableOrBuilder
      Returns:
      Whether the barrier field is set.

    • getBarrier

      public Runnable.Barrier getBarrier()
       Barrier runnable.
      .google.cloud.batch.v1alpha.Runnable.Barrier barrier = 6;
      Specified by:
      getBarrier in interface RunnableOrBuilder
      Returns:
      The barrier.

    • setBarrier

      public Runnable.Builder setBarrier(Runnable.Barrier value)
       Barrier runnable.
      .google.cloud.batch.v1alpha.Runnable.Barrier barrier = 6;

    • setBarrier

      public Runnable.Builder setBarrier(Runnable.Barrier.Builder builderForValue)
       Barrier runnable.
      .google.cloud.batch.v1alpha.Runnable.Barrier barrier = 6;

    • mergeBarrier

      public Runnable.Builder mergeBarrier(Runnable.Barrier value)
       Barrier runnable.
      .google.cloud.batch.v1alpha.Runnable.Barrier barrier = 6;

    • clearBarrier

      public Runnable.Builder clearBarrier()
       Barrier runnable.
      .google.cloud.batch.v1alpha.Runnable.Barrier barrier = 6;

    • getBarrierBuilder

      public Runnable.Barrier.Builder getBarrierBuilder()
       Barrier runnable.
      .google.cloud.batch.v1alpha.Runnable.Barrier barrier = 6;

    • getBarrierOrBuilder

      public Runnable.BarrierOrBuilder getBarrierOrBuilder()
       Barrier runnable.
      .google.cloud.batch.v1alpha.Runnable.Barrier barrier = 6;
      Specified by:
      getBarrierOrBuilder in interface RunnableOrBuilder

    • 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];
      Specified by:
      getDisplayName in interface RunnableOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public 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];
      Specified by:
      getDisplayNameBytes in interface RunnableOrBuilder
      Returns:
      The bytes for displayName.

    • setDisplayName

      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];
      Parameters:
      value - The displayName to set.
      Returns:
      This builder for chaining.

    • 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:
      This builder for chaining.

    • setDisplayNameBytes

      public Runnable.Builder setDisplayNameBytes(com.google.protobuf.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];
      Parameters:
      value - The bytes for displayName to set.
      Returns:
      This builder for chaining.

    • 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;
      Specified by:
      getIgnoreExitStatus in interface RunnableOrBuilder
      Returns:
      The ignoreExitStatus.

    • setIgnoreExitStatus

      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;
      Parameters:
      value - The ignoreExitStatus to set.
      Returns:
      This builder for chaining.

    • 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:
      This builder for chaining.

    • 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;
      Specified by:
      getBackground in interface RunnableOrBuilder
      Returns:
      The background.

    • setBackground

      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;
      Parameters:
      value - The background to set.
      Returns:
      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:
      This builder for chaining.

    • 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;
      Specified by:
      getAlwaysRun in interface RunnableOrBuilder
      Returns:
      The alwaysRun.

    • setAlwaysRun

      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;
      Parameters:
      value - The alwaysRun to set.
      Returns:
      This builder for chaining.

    • 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:
      This builder for chaining.

    • 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;
      Specified by:
      hasEnvironment in interface RunnableOrBuilder
      Returns:
      Whether the environment field is set.

    • 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;
      Specified by:
      getEnvironment in interface RunnableOrBuilder
      Returns:
      The environment.

    • setEnvironment

      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;

    • setEnvironment

      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;

    • mergeEnvironment

      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;

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

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

    • 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;
      Specified by:
      getEnvironmentOrBuilder in interface RunnableOrBuilder

    • hasTimeout

      public boolean hasTimeout()
       Timeout for this Runnable.
      .google.protobuf.Duration timeout = 8;
      Specified by:
      hasTimeout in interface RunnableOrBuilder
      Returns:
      Whether the timeout field is set.

    • getTimeout

      public com.google.protobuf.Duration getTimeout()
       Timeout for this Runnable.
      .google.protobuf.Duration timeout = 8;
      Specified by:
      getTimeout in interface RunnableOrBuilder
      Returns:
      The timeout.

    • setTimeout

      public Runnable.Builder setTimeout(com.google.protobuf.Duration value)
       Timeout for this Runnable.
      .google.protobuf.Duration timeout = 8;

    • setTimeout

      public Runnable.Builder setTimeout(com.google.protobuf.Duration.Builder builderForValue)
       Timeout for this Runnable.
      .google.protobuf.Duration timeout = 8;

    • mergeTimeout

      public Runnable.Builder mergeTimeout(com.google.protobuf.Duration value)
       Timeout for this Runnable.
      .google.protobuf.Duration timeout = 8;

    • clearTimeout

      public Runnable.Builder clearTimeout()
       Timeout for this Runnable.
      .google.protobuf.Duration timeout = 8;

    • getTimeoutBuilder

      public com.google.protobuf.Duration.Builder getTimeoutBuilder()
       Timeout for this Runnable.
      .google.protobuf.Duration timeout = 8;

    • getTimeoutOrBuilder

      public com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder()
       Timeout for this Runnable.
      .google.protobuf.Duration timeout = 8;
      Specified by:
      getTimeoutOrBuilder in interface RunnableOrBuilder

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: RunnableOrBuilder
       Labels for this Runnable.
      map<string, string> labels = 9;
      Specified by:
      getLabelsCount in interface RunnableOrBuilder

    • containsLabels

      public boolean containsLabels(String key)
       Labels for this Runnable.
      map<string, string> labels = 9;
      Specified by:
      containsLabels in interface RunnableOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface RunnableOrBuilder

    • getLabelsMap

      public Map<String,String> getLabelsMap()
       Labels for this Runnable.
      map<string, string> labels = 9;
      Specified by:
      getLabelsMap in interface RunnableOrBuilder

    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       Labels for this Runnable.
      map<string, string> labels = 9;
      Specified by:
      getLabelsOrDefault in interface RunnableOrBuilder

    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       Labels for this Runnable.
      map<string, string> labels = 9;
      Specified by:
      getLabelsOrThrow in interface RunnableOrBuilder

    • clearLabels

      public Runnable.Builder clearLabels()

    • removeLabels

      public Runnable.Builder removeLabels(String key)
       Labels for this Runnable.
      map<string, string> labels = 9;

    • getMutableLabels

      @Deprecated public Map<String,String> getMutableLabels()
      Deprecated.
      Use alternate mutation accessors instead.

    • putLabels

      public Runnable.Builder putLabels(String key, String value)
       Labels for this Runnable.
      map<string, string> labels = 9;

    • putAllLabels

      public Runnable.Builder putAllLabels(Map<String,String> values)
       Labels for this Runnable.
      map<string, string> labels = 9;