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}) — Output only. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.
#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
- (::Array< ::Google::Cloud::Run::V2::Container >) — Holds the single container that defines the unit of execution for this task.
#containers=
def
containers=
(
value
)
-
>
::
Array
< ::
Google
::
Cloud
::
Run
::
V2
::
Container
>
Parameter
- value(::Array< ::Google::Cloud::Run::V2::Container >) — Holds the single container that defines the unit of execution for this task.
Returns
- (::Array< ::Google::Cloud::Run::V2::Container >) — Holds the single container that defines the unit of execution for this task.
#create_time
def
create_time
()
-
>
::
Google
::
Protobuf
::
Timestamp
Returns
- ( ::Google::Protobuf::Timestamp ) — Output only. Represents time when the task was created by the system. 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
- ( ::Google::Cloud::Run::V2::ExecutionEnvironment ) — The execution environment being used to host this Task.
#execution_environment=
def
execution_environment=
(
value
)
-
>
::
Google
::
Cloud
::
Run
::
V2
::
ExecutionEnvironment
Parameter
- value( ::Google::Cloud::Run::V2::ExecutionEnvironment ) — The execution environment being used to host this Task.
Returns
- ( ::Google::Cloud::Run::V2::ExecutionEnvironment ) — The execution environment being used to host this Task.
#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}) — Output only. Unstructured key value map that can be used to organize and categorize objects. 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
#last_attempt_result
def
last_attempt_result
()
-
>
::
Google
::
Cloud
::
Run
::
V2
::
TaskAttemptResult
Returns
- ( ::Google::Cloud::Run::V2::TaskAttemptResult ) — Output only. Result of the last attempt of this Task.
#log_uri
def
log_uri
()
-
>
::
String
Returns
- (::String) — Output only. URI where logs for this execution can be found in Cloud Console.
#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.reconcilingfor 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.reconcilingfor 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.
#satisfies_pzs
def
satisfies_pzs
()
-
>
::
Boolean
Returns
- (::Boolean) — Output only. Reserved for future use.
#scheduled_time
def
scheduled_time
()
-
>
::
Google
::
Protobuf
::
Timestamp
Returns
- ( ::Google::Protobuf::Timestamp ) — Output only. Represents time when the task was scheduled to run by the system. It is not guaranteed to be set in happens-before order across separate operations.
#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
- ( ::Google::Protobuf::Timestamp ) — Output only. The last-modified time.
#volumes
def
volumes
()
-
>
::
Array
< ::
Google
::
Cloud
::
Run
::
V2
::
Volume
>
Returns
- (::Array< ::Google::Cloud::Run::V2::Volume >) — A list of Volumes to make available to containers.
#volumes=
def
volumes=
(
value
)
-
>
::
Array
< ::
Google
::
Cloud
::
Run
::
V2
::
Volume
>
Parameter
- value(::Array< ::Google::Cloud::Run::V2::Volume >) — A list of Volumes to make available to containers.
Returns
- (::Array< ::Google::Cloud::Run::V2::Volume >) — A list of Volumes to make available to containers.
#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.
