- 0.55.0 (latest)
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.2
- 0.2.2
- 0.1.1
public interface TaskSpecOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
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. The task will be killed and marked as FAILED if over this limit.
.google.protobuf.Duration max_run_duration = 4;
| Returns | |
|---|---|
| Type | Description |
Duration |
The maxRunDuration. |
getMaxRunDurationOrBuilder()
public abstract DurationOrBuilder getMaxRunDurationOrBuilder()Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit.
.google.protobuf.Duration max_run_duration = 4;
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getRunnables(int index)
public abstract Runnable getRunnables(int index)The sequence of scripts or containers to run for this Task. Each Task using this TaskSpec executes its list of runnables in order. The Task succeeds if all of its runnables either exit with a zero status or any that exit with a non-zero status have the ignore_exit_status flag.
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.
repeated .google.cloud.batch.v1.Runnable runnables = 8;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Runnable |
|
getRunnablesCount()
public abstract int getRunnablesCount()The sequence of scripts or containers to run for this Task. Each Task using this TaskSpec executes its list of runnables in order. The Task succeeds if all of its runnables either exit with a zero status or any that exit with a non-zero status have the ignore_exit_status flag.
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.
repeated .google.cloud.batch.v1.Runnable runnables = 8;
| Returns | |
|---|---|
| Type | Description |
int |
|
getRunnablesList()
public abstract List<Runnable> getRunnablesList()The sequence of scripts or containers to run for this Task. Each Task using this TaskSpec executes its list of runnables in order. The Task succeeds if all of its runnables either exit with a zero status or any that exit with a non-zero status have the ignore_exit_status flag.
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.
repeated .google.cloud.batch.v1.Runnable runnables = 8;
| Returns | |
|---|---|
| Type | Description |
List<Runnable> |
|
getRunnablesOrBuilder(int index)
public abstract RunnableOrBuilder getRunnablesOrBuilder(int index)The sequence of scripts or containers to run for this Task. Each Task using this TaskSpec executes its list of runnables in order. The Task succeeds if all of its runnables either exit with a zero status or any that exit with a non-zero status have the ignore_exit_status flag.
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.
repeated .google.cloud.batch.v1.Runnable runnables = 8;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
RunnableOrBuilder |
|
getRunnablesOrBuilderList()
public abstract List<? extends RunnableOrBuilder> getRunnablesOrBuilderList()The sequence of scripts or containers to run for this Task. Each Task using this TaskSpec executes its list of runnables in order. The Task succeeds if all of its runnables either exit with a zero status or any that exit with a non-zero status have the ignore_exit_status flag.
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.
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. The task will be killed and marked as FAILED if over this limit.
.google.protobuf.Duration max_run_duration = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the maxRunDuration field is set. |