Batch V1 API - Class Google::Cloud::Batch::V1::TaskSpec (v0.4.1)

Reference documentation and code samples for the Batch V1 API class Google::Cloud::Batch::V1::TaskSpec.

Spec of a task

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#compute_resource

def compute_resource() -> ::Google::Cloud::Batch::V1::ComputeResource
Returns

#compute_resource=

def compute_resource=(value) -> ::Google::Cloud::Batch::V1::ComputeResource
Parameter
Returns

#environment

def environment() -> ::Google::Cloud::Batch::V1::Environment
Returns

#environment=

def environment=(value) -> ::Google::Cloud::Batch::V1::Environment
Parameter
Returns

#environments

def environments() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Environment variables to set before running the Task. You can set up to 100 environments.

#environments=

def environments=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Environment variables to set before running the Task. You can set up to 100 environments.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Environment variables to set before running the Task. You can set up to 100 environments.

#lifecycle_policies

def lifecycle_policies() -> ::Array<::Google::Cloud::Batch::V1::LifecyclePolicy>
Returns
  • (::Array<::Google::Cloud::Batch::V1::LifecyclePolicy>) — 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 execute. 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.

#lifecycle_policies=

def lifecycle_policies=(value) -> ::Array<::Google::Cloud::Batch::V1::LifecyclePolicy>
Parameter
  • value (::Array<::Google::Cloud::Batch::V1::LifecyclePolicy>) — 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 execute. 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.
Returns
  • (::Array<::Google::Cloud::Batch::V1::LifecyclePolicy>) — 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 execute. 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.

#max_retry_count

def max_retry_count() -> ::Integer
Returns
  • (::Integer) — Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10].

#max_retry_count=

def max_retry_count=(value) -> ::Integer
Parameter
  • value (::Integer) — Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10].
Returns
  • (::Integer) — Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10].

#max_run_duration

def max_run_duration() -> ::Google::Protobuf::Duration
Returns

#max_run_duration=

def max_run_duration=(value) -> ::Google::Protobuf::Duration
Parameter
  • value (::Google::Protobuf::Duration) — Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit.
Returns

#runnables

def runnables() -> ::Array<::Google::Cloud::Batch::V1::Runnable>
Returns
  • (::Array<::Google::Cloud::Batch::V1::Runnable>) — 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.

#runnables=

def runnables=(value) -> ::Array<::Google::Cloud::Batch::V1::Runnable>
Parameter
  • value (::Array<::Google::Cloud::Batch::V1::Runnable>) — 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.

Returns
  • (::Array<::Google::Cloud::Batch::V1::Runnable>) — 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.

#volumes

def volumes() -> ::Array<::Google::Cloud::Batch::V1::Volume>
Returns

#volumes=

def volumes=(value) -> ::Array<::Google::Cloud::Batch::V1::Volume>
Parameter
Returns