Package com.google.cloud.batch.v1alpha

Class TaskSpec

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.batch.v1alpha.TaskSpec
All Implemented Interfaces:
TaskSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class TaskSpec extends com.google.protobuf.GeneratedMessage implements TaskSpecOrBuilder
 Spec of a task
Protobuf type google.cloud.batch.v1alpha.TaskSpec
See Also:

  • Field Details

    • RUNNABLES_FIELD_NUMBER

      public static final int RUNNABLES_FIELD_NUMBER
      See Also:

    • COMPUTE_RESOURCE_FIELD_NUMBER

      public static final int COMPUTE_RESOURCE_FIELD_NUMBER
      See Also:

    • MAX_RUN_DURATION_FIELD_NUMBER

      public static final int MAX_RUN_DURATION_FIELD_NUMBER
      See Also:

    • MAX_RETRY_COUNT_FIELD_NUMBER

      public static final int MAX_RETRY_COUNT_FIELD_NUMBER
      See Also:

    • LIFECYCLE_POLICIES_FIELD_NUMBER

      public static final int LIFECYCLE_POLICIES_FIELD_NUMBER
      See Also:

    • ENVIRONMENTS_FIELD_NUMBER

      public static final int ENVIRONMENTS_FIELD_NUMBER
      See Also:

    • VOLUMES_FIELD_NUMBER

      public static final int VOLUMES_FIELD_NUMBER
      See Also:

    • ENVIRONMENT_FIELD_NUMBER

      public static final int ENVIRONMENT_FIELD_NUMBER
      See Also:

  • 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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getRunnablesList

      public List<Runnable> getRunnablesList()
       Required. The sequence of one or more runnables (executable scripts,
 executable containers, and/or barriers) for each task in this task group to
 run. Each task runs this list of runnables in order. For a task to succeed,
 all of its script and container runnables each must meet at least one of
 the following conditions:

 + The runnable exited with a zero status.
 + The runnable didn't finish, but you enabled its `background` subfield.
 + The runnable exited with a non-zero status, but you enabled its
 `ignore_exit_status` subfield.
      repeated .google.cloud.batch.v1alpha.Runnable runnables = 8;
      Specified by:
      getRunnablesList in interface TaskSpecOrBuilder

    • getRunnablesOrBuilderList

      public List<? extends RunnableOrBuilder> getRunnablesOrBuilderList()
       Required. The sequence of one or more runnables (executable scripts,
 executable containers, and/or barriers) for each task in this task group to
 run. Each task runs this list of runnables in order. For a task to succeed,
 all of its script and container runnables each must meet at least one of
 the following conditions:

 + The runnable exited with a zero status.
 + The runnable didn't finish, but you enabled its `background` subfield.
 + The runnable exited with a non-zero status, but you enabled its
 `ignore_exit_status` subfield.
      repeated .google.cloud.batch.v1alpha.Runnable runnables = 8;
      Specified by:
      getRunnablesOrBuilderList in interface TaskSpecOrBuilder

    • getRunnablesCount

      public int getRunnablesCount()
       Required. The sequence of one or more runnables (executable scripts,
 executable containers, and/or barriers) for each task in this task group to
 run. Each task runs this list of runnables in order. For a task to succeed,
 all of its script and container runnables each must meet at least one of
 the following conditions:

 + The runnable exited with a zero status.
 + The runnable didn't finish, but you enabled its `background` subfield.
 + The runnable exited with a non-zero status, but you enabled its
 `ignore_exit_status` subfield.
      repeated .google.cloud.batch.v1alpha.Runnable runnables = 8;
      Specified by:
      getRunnablesCount in interface TaskSpecOrBuilder

    • getRunnables

      public Runnable getRunnables(int index)
       Required. The sequence of one or more runnables (executable scripts,
 executable containers, and/or barriers) for each task in this task group to
 run. Each task runs this list of runnables in order. For a task to succeed,
 all of its script and container runnables each must meet at least one of
 the following conditions:

 + The runnable exited with a zero status.
 + The runnable didn't finish, but you enabled its `background` subfield.
 + The runnable exited with a non-zero status, but you enabled its
 `ignore_exit_status` subfield.
      repeated .google.cloud.batch.v1alpha.Runnable runnables = 8;
      Specified by:
      getRunnables in interface TaskSpecOrBuilder

    • getRunnablesOrBuilder

      public RunnableOrBuilder getRunnablesOrBuilder(int index)
       Required. The sequence of one or more runnables (executable scripts,
 executable containers, and/or barriers) for each task in this task group to
 run. Each task runs this list of runnables in order. For a task to succeed,
 all of its script and container runnables each must meet at least one of
 the following conditions:

 + The runnable exited with a zero status.
 + The runnable didn't finish, but you enabled its `background` subfield.
 + The runnable exited with a non-zero status, but you enabled its
 `ignore_exit_status` subfield.
      repeated .google.cloud.batch.v1alpha.Runnable runnables = 8;
      Specified by:
      getRunnablesOrBuilder in interface TaskSpecOrBuilder

    • hasComputeResource

      public boolean hasComputeResource()
       ComputeResource requirements.
      .google.cloud.batch.v1alpha.ComputeResource compute_resource = 3;
      Specified by:
      hasComputeResource in interface TaskSpecOrBuilder
      Returns:
      Whether the computeResource field is set.

    • getComputeResource

      public ComputeResource getComputeResource()
       ComputeResource requirements.
      .google.cloud.batch.v1alpha.ComputeResource compute_resource = 3;
      Specified by:
      getComputeResource in interface TaskSpecOrBuilder
      Returns:
      The computeResource.

    • getComputeResourceOrBuilder

      public ComputeResourceOrBuilder getComputeResourceOrBuilder()
       ComputeResource requirements.
      .google.cloud.batch.v1alpha.ComputeResource compute_resource = 3;
      Specified by:
      getComputeResourceOrBuilder in interface TaskSpecOrBuilder

    • hasMaxRunDuration

      public boolean hasMaxRunDuration()
       Maximum duration the task should run before being automatically retried
 (if enabled) or automatically failed. Format the value of this field
 as a time limit in seconds followed by `s`&mdash;for example, `3600s`
 for 1 hour. The field accepts any value between 0 and the maximum listed
 for the `Duration` field type at
 https://protobuf.dev/reference/protobuf/google.protobuf/#duration; however,
 the actual maximum run time for a job will be limited to the maximum run
 time for a job listed at
 https://cloud.google.com/batch/quotas#max-job-duration.
      .google.protobuf.Duration max_run_duration = 4;
      Specified by:
      hasMaxRunDuration in interface TaskSpecOrBuilder
      Returns:
      Whether the maxRunDuration field is set.

    • getMaxRunDuration

      public com.google.protobuf.Duration getMaxRunDuration()
       Maximum duration the task should run before being automatically retried
 (if enabled) or automatically failed. Format the value of this field
 as a time limit in seconds followed by `s`&mdash;for example, `3600s`
 for 1 hour. The field accepts any value between 0 and the maximum listed
 for the `Duration` field type at
 https://protobuf.dev/reference/protobuf/google.protobuf/#duration; however,
 the actual maximum run time for a job will be limited to the maximum run
 time for a job listed at
 https://cloud.google.com/batch/quotas#max-job-duration.
      .google.protobuf.Duration max_run_duration = 4;
      Specified by:
      getMaxRunDuration in interface TaskSpecOrBuilder
      Returns:
      The maxRunDuration.

    • getMaxRunDurationOrBuilder

      public com.google.protobuf.DurationOrBuilder getMaxRunDurationOrBuilder()
       Maximum duration the task should run before being automatically retried
 (if enabled) or automatically failed. Format the value of this field
 as a time limit in seconds followed by `s`&mdash;for example, `3600s`
 for 1 hour. The field accepts any value between 0 and the maximum listed
 for the `Duration` field type at
 https://protobuf.dev/reference/protobuf/google.protobuf/#duration; however,
 the actual maximum run time for a job will be limited to the maximum run
 time for a job listed at
 https://cloud.google.com/batch/quotas#max-job-duration.
      .google.protobuf.Duration max_run_duration = 4;
      Specified by:
      getMaxRunDurationOrBuilder in interface TaskSpecOrBuilder

    • getMaxRetryCount

      public int getMaxRetryCount()
       Maximum number of retries on failures.
 The default, 0, which means never retry.
 The valid value range is [0, 10].
      int32 max_retry_count = 5;
      Specified by:
      getMaxRetryCount in interface TaskSpecOrBuilder
      Returns:
      The maxRetryCount.

    • getLifecyclePoliciesList

      public List<LifecyclePolicy> getLifecyclePoliciesList()
       Lifecycle management schema when any task in a task group is failed.
 Currently we only support one lifecycle policy.
 When the lifecycle policy condition is met,
 the action in the policy will execute.
 If task execution result does not meet with the defined lifecycle
 policy, we consider it as the default policy.
 Default policy means if the exit code is 0, exit task.
 If task ends with non-zero exit code, retry the task with max_retry_count.
      repeated .google.cloud.batch.v1alpha.LifecyclePolicy lifecycle_policies = 9;
      Specified by:
      getLifecyclePoliciesList in interface TaskSpecOrBuilder

    • getLifecyclePoliciesOrBuilderList

      public List<? extends LifecyclePolicyOrBuilder> getLifecyclePoliciesOrBuilderList()
       Lifecycle management schema when any task in a task group is failed.
 Currently we only support one lifecycle policy.
 When the lifecycle policy condition is met,
 the action in the policy will execute.
 If task execution result does not meet with the defined lifecycle
 policy, we consider it as the default policy.
 Default policy means if the exit code is 0, exit task.
 If task ends with non-zero exit code, retry the task with max_retry_count.
      repeated .google.cloud.batch.v1alpha.LifecyclePolicy lifecycle_policies = 9;
      Specified by:
      getLifecyclePoliciesOrBuilderList in interface TaskSpecOrBuilder

    • getLifecyclePoliciesCount

      public int getLifecyclePoliciesCount()
       Lifecycle management schema when any task in a task group is failed.
 Currently we only support one lifecycle policy.
 When the lifecycle policy condition is met,
 the action in the policy will execute.
 If task execution result does not meet with the defined lifecycle
 policy, we consider it as the default policy.
 Default policy means if the exit code is 0, exit task.
 If task ends with non-zero exit code, retry the task with max_retry_count.
      repeated .google.cloud.batch.v1alpha.LifecyclePolicy lifecycle_policies = 9;
      Specified by:
      getLifecyclePoliciesCount in interface TaskSpecOrBuilder

    • getLifecyclePolicies

      public LifecyclePolicy getLifecyclePolicies(int index)
       Lifecycle management schema when any task in a task group is failed.
 Currently we only support one lifecycle policy.
 When the lifecycle policy condition is met,
 the action in the policy will execute.
 If task execution result does not meet with the defined lifecycle
 policy, we consider it as the default policy.
 Default policy means if the exit code is 0, exit task.
 If task ends with non-zero exit code, retry the task with max_retry_count.
      repeated .google.cloud.batch.v1alpha.LifecyclePolicy lifecycle_policies = 9;
      Specified by:
      getLifecyclePolicies in interface TaskSpecOrBuilder

    • getLifecyclePoliciesOrBuilder

      public LifecyclePolicyOrBuilder getLifecyclePoliciesOrBuilder(int index)
       Lifecycle management schema when any task in a task group is failed.
 Currently we only support one lifecycle policy.
 When the lifecycle policy condition is met,
 the action in the policy will execute.
 If task execution result does not meet with the defined lifecycle
 policy, we consider it as the default policy.
 Default policy means if the exit code is 0, exit task.
 If task ends with non-zero exit code, retry the task with max_retry_count.
      repeated .google.cloud.batch.v1alpha.LifecyclePolicy lifecycle_policies = 9;
      Specified by:
      getLifecyclePoliciesOrBuilder in interface TaskSpecOrBuilder

    • getEnvironmentsCount

      @Deprecated public int getEnvironmentsCount()
      Deprecated.
      Description copied from interface: TaskSpecOrBuilder
       Deprecated: please use environment(non-plural) instead.
      map<string, string> environments = 6 [deprecated = true];
      Specified by:
      getEnvironmentsCount in interface TaskSpecOrBuilder

    • containsEnvironments

      @Deprecated public boolean containsEnvironments(String key)
      Deprecated.
       Deprecated: please use environment(non-plural) instead.
      map<string, string> environments = 6 [deprecated = true];
      Specified by:
      containsEnvironments in interface TaskSpecOrBuilder

    • getEnvironments

      @Deprecated public Map<String,String> getEnvironments()
      Deprecated.
      Use getEnvironmentsMap() instead.
      Specified by:
      getEnvironments in interface TaskSpecOrBuilder

    • getEnvironmentsMap

      @Deprecated public Map<String,String> getEnvironmentsMap()
      Deprecated.
       Deprecated: please use environment(non-plural) instead.
      map<string, string> environments = 6 [deprecated = true];
      Specified by:
      getEnvironmentsMap in interface TaskSpecOrBuilder

    • getEnvironmentsOrDefault

      @Deprecated public String getEnvironmentsOrDefault(String key, String defaultValue)
      Deprecated.
       Deprecated: please use environment(non-plural) instead.
      map<string, string> environments = 6 [deprecated = true];
      Specified by:
      getEnvironmentsOrDefault in interface TaskSpecOrBuilder

    • getEnvironmentsOrThrow

      @Deprecated public String getEnvironmentsOrThrow(String key)
      Deprecated.
       Deprecated: please use environment(non-plural) instead.
      map<string, string> environments = 6 [deprecated = true];
      Specified by:
      getEnvironmentsOrThrow in interface TaskSpecOrBuilder

    • getVolumesList

      public List<Volume> getVolumesList()
       Volumes to mount before running Tasks using this TaskSpec.
      repeated .google.cloud.batch.v1alpha.Volume volumes = 7;
      Specified by:
      getVolumesList in interface TaskSpecOrBuilder

    • getVolumesOrBuilderList

      public List<? extends VolumeOrBuilder> getVolumesOrBuilderList()
       Volumes to mount before running Tasks using this TaskSpec.
      repeated .google.cloud.batch.v1alpha.Volume volumes = 7;
      Specified by:
      getVolumesOrBuilderList in interface TaskSpecOrBuilder

    • getVolumesCount

      public int getVolumesCount()
       Volumes to mount before running Tasks using this TaskSpec.
      repeated .google.cloud.batch.v1alpha.Volume volumes = 7;
      Specified by:
      getVolumesCount in interface TaskSpecOrBuilder

    • getVolumes

      public Volume getVolumes(int index)
       Volumes to mount before running Tasks using this TaskSpec.
      repeated .google.cloud.batch.v1alpha.Volume volumes = 7;
      Specified by:
      getVolumes in interface TaskSpecOrBuilder

    • getVolumesOrBuilder

      public VolumeOrBuilder getVolumesOrBuilder(int index)
       Volumes to mount before running Tasks using this TaskSpec.
      repeated .google.cloud.batch.v1alpha.Volume volumes = 7;
      Specified by:
      getVolumesOrBuilder in interface TaskSpecOrBuilder

    • hasEnvironment

      public boolean hasEnvironment()
       Environment variables to set before running the Task.
      .google.cloud.batch.v1alpha.Environment environment = 10;
      Specified by:
      hasEnvironment in interface TaskSpecOrBuilder
      Returns:
      Whether the environment field is set.

    • getEnvironment

      public Environment getEnvironment()
       Environment variables to set before running the Task.
      .google.cloud.batch.v1alpha.Environment environment = 10;
      Specified by:
      getEnvironment in interface TaskSpecOrBuilder
      Returns:
      The environment.

    • getEnvironmentOrBuilder

      public EnvironmentOrBuilder getEnvironmentOrBuilder()
       Environment variables to set before running the Task.
      .google.cloud.batch.v1alpha.Environment environment = 10;
      Specified by:
      getEnvironmentOrBuilder in interface TaskSpecOrBuilder

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static TaskSpec parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TaskSpec parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TaskSpec parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TaskSpec parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TaskSpec parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TaskSpec parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TaskSpec parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TaskSpec parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TaskSpec parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TaskSpec parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TaskSpec parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TaskSpec parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public TaskSpec.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static TaskSpec.Builder newBuilder()

    • newBuilder

      public static TaskSpec.Builder newBuilder(TaskSpec prototype)

    • toBuilder

      public TaskSpec.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected TaskSpec.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static TaskSpec getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<TaskSpec> parser()

    • getParserForType

      public com.google.protobuf.Parser<TaskSpec> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

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