Package com.google.cloud.batch.v1alpha

Interface TaskSpecOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
TaskSpec, TaskSpec.Builder
@Generated public interface TaskSpecOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getRunnablesList

      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;

    • getRunnables

      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;

    • getRunnablesCount

      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;

    • getRunnablesOrBuilderList

      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;

    • getRunnablesOrBuilder

      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;

    • hasComputeResource

      boolean hasComputeResource()
       ComputeResource requirements.
      .google.cloud.batch.v1alpha.ComputeResource compute_resource = 3;
      Returns:
      Whether the computeResource field is set.

    • getComputeResource

      ComputeResource getComputeResource()
       ComputeResource requirements.
      .google.cloud.batch.v1alpha.ComputeResource compute_resource = 3;
      Returns:
      The computeResource.

    • getComputeResourceOrBuilder

      ComputeResourceOrBuilder getComputeResourceOrBuilder()
       ComputeResource requirements.
      .google.cloud.batch.v1alpha.ComputeResource compute_resource = 3;

    • hasMaxRunDuration

      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;
      Returns:
      Whether the maxRunDuration field is set.

    • getMaxRunDuration

      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;
      Returns:
      The maxRunDuration.

    • getMaxRunDurationOrBuilder

      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;

    • getMaxRetryCount

      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;
      Returns:
      The maxRetryCount.

    • getLifecyclePoliciesList

      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;

    • getLifecyclePolicies

      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;

    • getLifecyclePoliciesCount

      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;

    • getLifecyclePoliciesOrBuilderList

      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;

    • getLifecyclePoliciesOrBuilder

      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;

    • getEnvironmentsCount

      @Deprecated int getEnvironmentsCount()
      Deprecated.
       Deprecated: please use environment(non-plural) instead.
      map<string, string> environments = 6 [deprecated = true];

    • containsEnvironments

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

    • getEnvironments

      @Deprecated Map<String,String> getEnvironments()
      Deprecated.
      Use getEnvironmentsMap() instead.

    • getEnvironmentsMap

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

    • getEnvironmentsOrDefault

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

    • getEnvironmentsOrThrow

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

    • getVolumesList

      List<Volume> getVolumesList()
       Volumes to mount before running Tasks using this TaskSpec.
      repeated .google.cloud.batch.v1alpha.Volume volumes = 7;

    • getVolumes

      Volume getVolumes(int index)
       Volumes to mount before running Tasks using this TaskSpec.
      repeated .google.cloud.batch.v1alpha.Volume volumes = 7;

    • getVolumesCount

      int getVolumesCount()
       Volumes to mount before running Tasks using this TaskSpec.
      repeated .google.cloud.batch.v1alpha.Volume volumes = 7;

    • getVolumesOrBuilderList

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

    • getVolumesOrBuilder

      VolumeOrBuilder getVolumesOrBuilder(int index)
       Volumes to mount before running Tasks using this TaskSpec.
      repeated .google.cloud.batch.v1alpha.Volume volumes = 7;

    • hasEnvironment

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

    • getEnvironment

      Environment getEnvironment()
       Environment variables to set before running the Task.
      .google.cloud.batch.v1alpha.Environment environment = 10;
      Returns:
      The environment.

    • getEnvironmentOrBuilder

      EnvironmentOrBuilder getEnvironmentOrBuilder()
       Environment variables to set before running the Task.
      .google.cloud.batch.v1alpha.Environment environment = 10;