Reference documentation and code samples for the Cloud Tasks V2beta2 API class Google::Cloud::Tasks::V2beta2::Task.
A unit of scheduled work.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#app_engine_http_request
def app_engine_http_request() -> ::Google::Cloud::Tasks::V2beta2::AppEngineHttpRequest
-
(::Google::Cloud::Tasks::V2beta2::AppEngineHttpRequest) — App Engine HTTP request that is sent to the task's target. Can
be set only if
app_engine_http_target
is set on the queue.
An App Engine task is a task that has AppEngineHttpRequest set.
#app_engine_http_request=
def app_engine_http_request=(value) -> ::Google::Cloud::Tasks::V2beta2::AppEngineHttpRequest
-
value (::Google::Cloud::Tasks::V2beta2::AppEngineHttpRequest) — App Engine HTTP request that is sent to the task's target. Can
be set only if
app_engine_http_target
is set on the queue.
An App Engine task is a task that has AppEngineHttpRequest set.
-
(::Google::Cloud::Tasks::V2beta2::AppEngineHttpRequest) — App Engine HTTP request that is sent to the task's target. Can
be set only if
app_engine_http_target
is set on the queue.
An App Engine task is a task that has AppEngineHttpRequest set.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
-
(::Google::Protobuf::Timestamp) — Output only. The time that the task was created.
create_time
will be truncated to the nearest second.
#create_time=
def create_time=(value) -> ::Google::Protobuf::Timestamp
-
value (::Google::Protobuf::Timestamp) — Output only. The time that the task was created.
create_time
will be truncated to the nearest second.
-
(::Google::Protobuf::Timestamp) — Output only. The time that the task was created.
create_time
will be truncated to the nearest second.
#http_request
def http_request() -> ::Google::Cloud::Tasks::V2beta2::HttpRequest
-
(::Google::Cloud::Tasks::V2beta2::HttpRequest) — HTTP request that is sent to the task's target.
An HTTP task is a task that has HttpRequest set.
#http_request=
def http_request=(value) -> ::Google::Cloud::Tasks::V2beta2::HttpRequest
-
value (::Google::Cloud::Tasks::V2beta2::HttpRequest) — HTTP request that is sent to the task's target.
An HTTP task is a task that has HttpRequest set.
-
(::Google::Cloud::Tasks::V2beta2::HttpRequest) — HTTP request that is sent to the task's target.
An HTTP task is a task that has HttpRequest set.
#name
def name() -> ::String
-
(::String) —
Optionally caller-specified in CreateTask.
The task name.
The task name must have the following format:
projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID
PROJECT_ID
can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projectsLOCATION_ID
is the canonical ID for the task's location. The list of available locations can be obtained by calling::Google::Cloud::Location::Locations::Client#list_locations
. For more information, see https://cloud.google.com/about/locations/.QUEUE_ID
can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters.TASK_ID
can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
#name=
def name=(value) -> ::String
-
value (::String) —
Optionally caller-specified in CreateTask.
The task name.
The task name must have the following format:
projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID
PROJECT_ID
can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projectsLOCATION_ID
is the canonical ID for the task's location. The list of available locations can be obtained by calling::Google::Cloud::Location::Locations::Client#list_locations
. For more information, see https://cloud.google.com/about/locations/.QUEUE_ID
can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters.TASK_ID
can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
-
(::String) —
Optionally caller-specified in CreateTask.
The task name.
The task name must have the following format:
projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID
PROJECT_ID
can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projectsLOCATION_ID
is the canonical ID for the task's location. The list of available locations can be obtained by calling::Google::Cloud::Location::Locations::Client#list_locations
. For more information, see https://cloud.google.com/about/locations/.QUEUE_ID
can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters.TASK_ID
can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
#pull_message
def pull_message() -> ::Google::Cloud::Tasks::V2beta2::PullMessage
-
(::Google::Cloud::Tasks::V2beta2::PullMessage) — LeaseTasks to process
the task. Can be set only if
pull_target is set on the
queue.
A pull task is a task that has PullMessage set.
#pull_message=
def pull_message=(value) -> ::Google::Cloud::Tasks::V2beta2::PullMessage
-
value (::Google::Cloud::Tasks::V2beta2::PullMessage) — LeaseTasks to process
the task. Can be set only if
pull_target is set on the
queue.
A pull task is a task that has PullMessage set.
-
(::Google::Cloud::Tasks::V2beta2::PullMessage) — LeaseTasks to process
the task. Can be set only if
pull_target is set on the
queue.
A pull task is a task that has PullMessage set.
#schedule_time
def schedule_time() -> ::Google::Protobuf::Timestamp
-
(::Google::Protobuf::Timestamp) — The time when the task is scheduled to be attempted.
For App Engine queues, this is when the task will be attempted or retried.
For pull queues, this is the time when the task is available to be leased; if a task is currently leased, this is the time when the current lease expires, that is, the time that the task was leased plus the lease_duration.
schedule_time
will be truncated to the nearest microsecond.
#schedule_time=
def schedule_time=(value) -> ::Google::Protobuf::Timestamp
-
value (::Google::Protobuf::Timestamp) — The time when the task is scheduled to be attempted.
For App Engine queues, this is when the task will be attempted or retried.
For pull queues, this is the time when the task is available to be leased; if a task is currently leased, this is the time when the current lease expires, that is, the time that the task was leased plus the lease_duration.
schedule_time
will be truncated to the nearest microsecond.
-
(::Google::Protobuf::Timestamp) — The time when the task is scheduled to be attempted.
For App Engine queues, this is when the task will be attempted or retried.
For pull queues, this is the time when the task is available to be leased; if a task is currently leased, this is the time when the current lease expires, that is, the time that the task was leased plus the lease_duration.
schedule_time
will be truncated to the nearest microsecond.
#status
def status() -> ::Google::Cloud::Tasks::V2beta2::TaskStatus
- (::Google::Cloud::Tasks::V2beta2::TaskStatus) — Output only. The task status.
#status=
def status=(value) -> ::Google::Cloud::Tasks::V2beta2::TaskStatus
- value (::Google::Cloud::Tasks::V2beta2::TaskStatus) — Output only. The task status.
- (::Google::Cloud::Tasks::V2beta2::TaskStatus) — Output only. The task status.
#view
def view() -> ::Google::Cloud::Tasks::V2beta2::Task::View
- (::Google::Cloud::Tasks::V2beta2::Task::View) — Output only. The view specifies which subset of the Task has been returned.
#view=
def view=(value) -> ::Google::Cloud::Tasks::V2beta2::Task::View
- value (::Google::Cloud::Tasks::V2beta2::Task::View) — Output only. The view specifies which subset of the Task has been returned.
- (::Google::Cloud::Tasks::V2beta2::Task::View) — Output only. The view specifies which subset of the Task has been returned.