Interface TaskSpecOrBuilder (0.48.0) 

public interface TaskSpecOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsEnvironments(String key) (deprecated)

public abstract boolean containsEnvironments(String key)

Deprecated: please use environment(non-plural) instead.

map<string, string> environments = 6 [deprecated = true];

Parameter
Name Description
key String
Returns
Type Description
boolean

getComputeResource()

public abstract ComputeResource getComputeResource()

ComputeResource requirements.

.google.cloud.batch.v1.ComputeResource compute_resource = 3;

Returns
Type Description
ComputeResource

The computeResource.

getComputeResourceOrBuilder()

public abstract ComputeResourceOrBuilder getComputeResourceOrBuilder()

ComputeResource requirements.

.google.cloud.batch.v1.ComputeResource compute_resource = 3;

Returns
Type Description
ComputeResourceOrBuilder

getEnvironment()

public abstract Environment getEnvironment()

Environment variables to set before running the Task.

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

Returns
Type Description
Environment

The environment.

getEnvironmentOrBuilder()

public abstract EnvironmentOrBuilder getEnvironmentOrBuilder()

Environment variables to set before running the Task.

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

Returns
Type Description
EnvironmentOrBuilder

getEnvironments() (deprecated)

public abstract Map<String,String> getEnvironments()

Use #getEnvironmentsMap() instead.

Returns
Type Description
Map<String,String>

getEnvironmentsCount() (deprecated)

public abstract int getEnvironmentsCount()

Deprecated: please use environment(non-plural) instead.

map<string, string> environments = 6 [deprecated = true];

Returns
Type Description
int

getEnvironmentsMap() (deprecated)

public abstract Map<String,String> getEnvironmentsMap()

Deprecated: please use environment(non-plural) instead.

map<string, string> environments = 6 [deprecated = true];

Returns
Type Description
Map<String,String>

getEnvironmentsOrDefault(String key, String defaultValue) (deprecated)

public abstract String getEnvironmentsOrDefault(String key, String defaultValue)

Deprecated: please use environment(non-plural) instead.

map<string, string> environments = 6 [deprecated = true];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getEnvironmentsOrThrow(String key) (deprecated)

public abstract String getEnvironmentsOrThrow(String key)

Deprecated: please use environment(non-plural) instead.

map<string, string> environments = 6 [deprecated = true];

Parameter
Name Description
key String
Returns
Type Description
String

getLifecyclePolicies(int index)

public abstract 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.v1.LifecyclePolicy lifecycle_policies = 9;

Parameter
Name Description
index int
Returns
Type Description
LifecyclePolicy

getLifecyclePoliciesCount()

public abstract 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.v1.LifecyclePolicy lifecycle_policies = 9;

Returns
Type Description
int

getLifecyclePoliciesList()

public abstract 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.v1.LifecyclePolicy lifecycle_policies = 9;

Returns
Type Description
List<LifecyclePolicy>

getLifecyclePoliciesOrBuilder(int index)

public abstract 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.v1.LifecyclePolicy lifecycle_policies = 9;

Parameter
Name Description
index int
Returns
Type Description
LifecyclePolicyOrBuilder

getLifecyclePoliciesOrBuilderList()

public abstract 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.v1.LifecyclePolicy lifecycle_policies = 9;

Returns
Type Description
List<? extends com.google.cloud.batch.v1.LifecyclePolicyOrBuilder>

getMaxRetryCount()

public abstract 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
Type Description
int

The maxRetryCount.

getMaxRunDuration()

public abstract 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
Type Description
Duration

The maxRunDuration.

getMaxRunDurationOrBuilder()

public abstract 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;

Returns
Type Description
DurationOrBuilder

getRunnables(int index)

public abstract 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.v1.Runnable runnables = 8;

Parameter
Name Description
index int
Returns
Type Description
Runnable

getRunnablesCount()

public abstract 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.v1.Runnable runnables = 8;

Returns
Type Description
int

getRunnablesList()

public abstract 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.v1.Runnable runnables = 8;

Returns
Type Description
List<Runnable>

getRunnablesOrBuilder(int index)

public abstract 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.v1.Runnable runnables = 8;

Parameter
Name Description
index int
Returns
Type Description
RunnableOrBuilder

getRunnablesOrBuilderList()

public abstract 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.v1.Runnable runnables = 8;

Returns
Type Description
List<? extends com.google.cloud.batch.v1.RunnableOrBuilder>

getVolumes(int index)

public abstract Volume getVolumes(int index)

Volumes to mount before running Tasks using this TaskSpec.

repeated .google.cloud.batch.v1.Volume volumes = 7;

Parameter
Name Description
index int
Returns
Type Description
Volume

getVolumesCount()

public abstract int getVolumesCount()

Volumes to mount before running Tasks using this TaskSpec.

repeated .google.cloud.batch.v1.Volume volumes = 7;

Returns
Type Description
int

getVolumesList()

public abstract List<Volume> getVolumesList()

Volumes to mount before running Tasks using this TaskSpec.

repeated .google.cloud.batch.v1.Volume volumes = 7;

Returns
Type Description
List<Volume>

getVolumesOrBuilder(int index)

public abstract VolumeOrBuilder getVolumesOrBuilder(int index)

Volumes to mount before running Tasks using this TaskSpec.

repeated .google.cloud.batch.v1.Volume volumes = 7;

Parameter
Name Description
index int
Returns
Type Description
VolumeOrBuilder

getVolumesOrBuilderList()

public abstract List<? extends VolumeOrBuilder> getVolumesOrBuilderList()

Volumes to mount before running Tasks using this TaskSpec.

repeated .google.cloud.batch.v1.Volume volumes = 7;

Returns
Type Description
List<? extends com.google.cloud.batch.v1.VolumeOrBuilder>

hasComputeResource()

public abstract boolean hasComputeResource()

ComputeResource requirements.

.google.cloud.batch.v1.ComputeResource compute_resource = 3;

Returns
Type Description
boolean

Whether the computeResource field is set.

hasEnvironment()

public abstract boolean hasEnvironment()

Environment variables to set before running the Task.

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

Returns
Type Description
boolean

Whether the environment field is set.

hasMaxRunDuration()

public abstract 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
Type Description
boolean

Whether the maxRunDuration field is set.