public final class TaskSpec extends GeneratedMessageV3 implements TaskSpecOrBuilder
Spec of a task
Protobuf type google.cloud.batch.v1.TaskSpec
Static Fields
COMPUTE_RESOURCE_FIELD_NUMBER
public static final int COMPUTE_RESOURCE_FIELD_NUMBER
Field Value
ENVIRONMENTS_FIELD_NUMBER
public static final int ENVIRONMENTS_FIELD_NUMBER
Field Value
LIFECYCLE_POLICIES_FIELD_NUMBER
public static final int LIFECYCLE_POLICIES_FIELD_NUMBER
Field Value
MAX_RETRY_COUNT_FIELD_NUMBER
public static final int MAX_RETRY_COUNT_FIELD_NUMBER
Field Value
MAX_RUN_DURATION_FIELD_NUMBER
public static final int MAX_RUN_DURATION_FIELD_NUMBER
Field Value
RUNNABLES_FIELD_NUMBER
public static final int RUNNABLES_FIELD_NUMBER
Field Value
VOLUMES_FIELD_NUMBER
public static final int VOLUMES_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static TaskSpec getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static TaskSpec.Builder newBuilder()
Returns
newBuilder(TaskSpec prototype)
public static TaskSpec.Builder newBuilder(TaskSpec prototype)
Parameter
Returns
public static TaskSpec parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static TaskSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static TaskSpec parseFrom(byte[] data)
Parameter
| Name |
Description |
| data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TaskSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static TaskSpec parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TaskSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TaskSpec parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static TaskSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TaskSpec parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static TaskSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static TaskSpec parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TaskSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<TaskSpec> parser()
Returns
Methods
containsEnvironments(String key)
public boolean containsEnvironments(String key)
Environment variables to set before running the Task.
You can set up to 100 environments.
map<string, string> environments = 6;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getComputeResource()
public ComputeResource getComputeResource()
ComputeResource requirements.
.google.cloud.batch.v1.ComputeResource compute_resource = 3;
getComputeResourceOrBuilder()
public ComputeResourceOrBuilder getComputeResourceOrBuilder()
ComputeResource requirements.
.google.cloud.batch.v1.ComputeResource compute_resource = 3;
getDefaultInstanceForType()
public TaskSpec getDefaultInstanceForType()
Returns
getEnvironments()
public Map<String,String> getEnvironments()
Returns
getEnvironmentsCount()
public int getEnvironmentsCount()
Environment variables to set before running the Task.
You can set up to 100 environments.
map<string, string> environments = 6;
getEnvironmentsMap()
public Map<String,String> getEnvironmentsMap()
Environment variables to set before running the Task.
You can set up to 100 environments.
map<string, string> environments = 6;
getEnvironmentsOrDefault(String key, String defaultValue)
public String getEnvironmentsOrDefault(String key, String defaultValue)
Environment variables to set before running the Task.
You can set up to 100 environments.
map<string, string> environments = 6;
getEnvironmentsOrThrow(String key)
public String getEnvironmentsOrThrow(String key)
Environment variables to set before running the Task.
You can set up to 100 environments.
map<string, string> environments = 6;
getLifecyclePolicies(int index)
public LifecyclePolicy getLifecyclePolicies(int index)
Lifecycle management schema when any task in a task group is failed.
The valid size of lifecycle policies are [0, 10].
For each lifecycle policy, when the condition is met,
the action in that policy will be executed.
If there are multiple policies that the task execution result matches,
we use the action from the first matched policy. If task execution result
does not meet with any of 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;
| Name |
Description |
| index |
int
|
Returns
getLifecyclePoliciesCount()
public int getLifecyclePoliciesCount()
Lifecycle management schema when any task in a task group is failed.
The valid size of lifecycle policies are [0, 10].
For each lifecycle policy, when the condition is met,
the action in that policy will be executed.
If there are multiple policies that the task execution result matches,
we use the action from the first matched policy. If task execution result
does not meet with any of 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;
getLifecyclePoliciesList()
public List<LifecyclePolicy> getLifecyclePoliciesList()
Lifecycle management schema when any task in a task group is failed.
The valid size of lifecycle policies are [0, 10].
For each lifecycle policy, when the condition is met,
the action in that policy will be executed.
If there are multiple policies that the task execution result matches,
we use the action from the first matched policy. If task execution result
does not meet with any of 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;
getLifecyclePoliciesOrBuilder(int index)
public LifecyclePolicyOrBuilder getLifecyclePoliciesOrBuilder(int index)
Lifecycle management schema when any task in a task group is failed.
The valid size of lifecycle policies are [0, 10].
For each lifecycle policy, when the condition is met,
the action in that policy will be executed.
If there are multiple policies that the task execution result matches,
we use the action from the first matched policy. If task execution result
does not meet with any of 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;
| Name |
Description |
| index |
int
|
Returns
getLifecyclePoliciesOrBuilderList()
public List<? extends LifecyclePolicyOrBuilder> getLifecyclePoliciesOrBuilderList()
Lifecycle management schema when any task in a task group is failed.
The valid size of lifecycle policies are [0, 10].
For each lifecycle policy, when the condition is met,
the action in that policy will be executed.
If there are multiple policies that the task execution result matches,
we use the action from the first matched policy. If task execution result
does not meet with any of 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;
| Type |
Description |
| List<? extends com.google.cloud.batch.v1.LifecyclePolicyOrBuilder> |
|
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;
| Type |
Description |
| int |
The maxRetryCount.
|
getMaxRunDuration()
public 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;
| Type |
Description |
| Duration |
The maxRunDuration.
|
getMaxRunDurationOrBuilder()
public 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;
getParserForType()
public Parser<TaskSpec> getParserForType()
Returns
Overrides
getRunnables(int index)
public 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;
| Name |
Description |
| index |
int
|
Returns
getRunnablesCount()
public 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;
getRunnablesList()
public 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;
getRunnablesOrBuilder(int index)
public 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;
| Name |
Description |
| index |
int
|
Returns
getRunnablesOrBuilderList()
public 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;
| Type |
Description |
| List<? extends com.google.cloud.batch.v1.RunnableOrBuilder> |
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getVolumes(int index)
public Volume getVolumes(int index)
Volumes to mount before running Tasks using this TaskSpec.
repeated .google.cloud.batch.v1.Volume volumes = 7;
| Name |
Description |
| index |
int
|
Returns
getVolumesCount()
public int getVolumesCount()
Volumes to mount before running Tasks using this TaskSpec.
repeated .google.cloud.batch.v1.Volume volumes = 7;
getVolumesList()
public List<Volume> getVolumesList()
Volumes to mount before running Tasks using this TaskSpec.
repeated .google.cloud.batch.v1.Volume volumes = 7;
getVolumesOrBuilder(int index)
public VolumeOrBuilder getVolumesOrBuilder(int index)
Volumes to mount before running Tasks using this TaskSpec.
repeated .google.cloud.batch.v1.Volume volumes = 7;
| Name |
Description |
| index |
int
|
Returns
getVolumesOrBuilderList()
public List<? extends VolumeOrBuilder> getVolumesOrBuilderList()
Volumes to mount before running Tasks using this TaskSpec.
repeated .google.cloud.batch.v1.Volume volumes = 7;
| Type |
Description |
| List<? extends com.google.cloud.batch.v1.VolumeOrBuilder> |
|
hasComputeResource()
public boolean hasComputeResource()
ComputeResource requirements.
.google.cloud.batch.v1.ComputeResource compute_resource = 3;
| Type |
Description |
| boolean |
Whether the computeResource field is set.
|
hasMaxRunDuration()
public 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;
| Type |
Description |
| boolean |
Whether the maxRunDuration field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
| Name |
Description |
| number |
int
|
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public TaskSpec.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TaskSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public TaskSpec.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
