Cloud Run V2 API - Class Google::Cloud::Run::V2::Task (v0.5.0)

Reference documentation and code samples for the Cloud Run V2 API class Google::Cloud::Run::V2::Task.

Task represents a single run of a container to completion.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#annotations

def annotations() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — KRM-style annotations for the resource.

#annotations=

def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — KRM-style annotations for the resource.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — KRM-style annotations for the resource.

#completion_time

def completion_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — Output only. Represents time when the Task was completed. It is not guaranteed to be set in happens-before order across separate operations.

#conditions

def conditions() -> ::Array<::Google::Cloud::Run::V2::Condition>
Returns
  • (::Array<::Google::Cloud::Run::V2::Condition>) — Output only. The Condition of this Task, containing its readiness status, and detailed error information in case it did not reach the desired state.

#containers

def containers() -> ::Array<::Google::Cloud::Run::V2::Container>
Returns

#containers=

def containers=(value) -> ::Array<::Google::Cloud::Run::V2::Container>
Parameter
Returns

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — Output only. Represents time when the task was created by the job controller. It is not guaranteed to be set in happens-before order across separate operations.

#delete_time

def delete_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request.

#encryption_key

def encryption_key() -> ::String
Returns
  • (::String) — Output only. A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek

#etag

def etag() -> ::String
Returns
  • (::String) — Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.

#execution

def execution() -> ::String
Returns
  • (::String) — Output only. The name of the parent Execution.

#execution_environment

def execution_environment() -> ::Google::Cloud::Run::V2::ExecutionEnvironment
Returns

#execution_environment=

def execution_environment=(value) -> ::Google::Cloud::Run::V2::ExecutionEnvironment
Parameter
Returns

#expire_time

def expire_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — Output only. For a deleted resource, the time after which it will be permamently deleted. It is only populated as a response to a Delete request.

#generation

def generation() -> ::Integer
Returns
  • (::Integer) — Output only. A number that monotonically increases every time the user modifies the desired state.

#index

def index() -> ::Integer
Returns
  • (::Integer) — Output only. Index of the Task, unique per execution, and beginning at 0.

#job

def job() -> ::String
Returns
  • (::String) — Output only. The name of the parent Job.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — KRM-style labels for the resource. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels Cloud Run will populate some labels with 'run.googleapis.com' or 'serving.knative.dev' namespaces. Those labels are read-only, and user changes will not be preserved.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — KRM-style labels for the resource. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels Cloud Run will populate some labels with 'run.googleapis.com' or 'serving.knative.dev' namespaces. Those labels are read-only, and user changes will not be preserved.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — KRM-style labels for the resource. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels Cloud Run will populate some labels with 'run.googleapis.com' or 'serving.knative.dev' namespaces. Those labels are read-only, and user changes will not be preserved.

#last_attempt_result

def last_attempt_result() -> ::Google::Cloud::Run::V2::TaskAttemptResult
Returns

#max_retries

def max_retries() -> ::Integer
Returns
  • (::Integer) — Number of retries allowed per Task, before marking this Task failed.

#max_retries=

def max_retries=(value) -> ::Integer
Parameter
  • value (::Integer) — Number of retries allowed per Task, before marking this Task failed.
Returns
  • (::Integer) — Number of retries allowed per Task, before marking this Task failed.

#name

def name() -> ::String
Returns
  • (::String) — Output only. The unique name of this Task.

#observed_generation

def observed_generation() -> ::Integer
Returns
  • (::Integer) — Output only. The generation of this Task. See comments in Job.reconciling for additional information on reconciliation process in Cloud Run.

#reconciling

def reconciling() -> ::Boolean
Returns
  • (::Boolean) — Output only. Indicates whether the resource's reconciliation is still in progress. See comments in Job.reconciling for additional information on reconciliation process in Cloud Run.

#retried

def retried() -> ::Integer
Returns
  • (::Integer) — Output only. The number of times this Task was retried. Tasks are retried when they fail up to the maxRetries limit.

#service_account

def service_account() -> ::String
Returns
  • (::String) — Email address of the IAM service account associated with the Task of a Job. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account.

#service_account=

def service_account=(value) -> ::String
Parameter
  • value (::String) — Email address of the IAM service account associated with the Task of a Job. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account.
Returns
  • (::String) — Email address of the IAM service account associated with the Task of a Job. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account.

#start_time

def start_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — Output only. Represents time when the task started to run. It is not guaranteed to be set in happens-before order across separate operations.

#timeout

def timeout() -> ::Google::Protobuf::Duration
Returns
  • (::Google::Protobuf::Duration) — Max allowed time duration the Task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout.

#timeout=

def timeout=(value) -> ::Google::Protobuf::Duration
Parameter
  • value (::Google::Protobuf::Duration) — Max allowed time duration the Task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout.
Returns
  • (::Google::Protobuf::Duration) — Max allowed time duration the Task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout.

#uid

def uid() -> ::String
Returns
  • (::String) — Output only. Server assigned unique identifier for the Task. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns

#volumes

def volumes() -> ::Array<::Google::Cloud::Run::V2::Volume>
Returns

#volumes=

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

#vpc_access

def vpc_access() -> ::Google::Cloud::Run::V2::VpcAccess
Returns
  • (::Google::Cloud::Run::V2::VpcAccess) — Output only. VPC Access configuration to use for this Task. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.