Cloud Tasks V2beta2 API - Class Google::Cloud::Tasks::V2beta2::Task (v0.6.0)

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
Returns

#app_engine_http_request=

def app_engine_http_request=(value) -> ::Google::Cloud::Tasks::V2beta2::AppEngineHttpRequest
Parameter
Returns

#create_time

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

#create_time=

def create_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::Google::Protobuf::Timestamp) — Output only. The time that the task was created.

    create_time will be truncated to the nearest second.

Returns

#name

def name() -> ::String
Returns
  • (::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 projects
    • LOCATION_ID is the canonical ID for the task's location. The list of available locations can be obtained by calling [ListLocations][google.cloud.location.Locations.ListLocations]. 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
Parameter
  • 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 projects
    • LOCATION_ID is the canonical ID for the task's location. The list of available locations can be obtained by calling [ListLocations][google.cloud.location.Locations.ListLocations]. 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.
Returns
  • (::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 projects
    • LOCATION_ID is the canonical ID for the task's location. The list of available locations can be obtained by calling [ListLocations][google.cloud.location.Locations.ListLocations]. 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
Returns

#pull_message=

def pull_message=(value) -> ::Google::Cloud::Tasks::V2beta2::PullMessage
Parameter
Returns

#schedule_time

def schedule_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::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
Parameter
  • 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.

Returns
  • (::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
Returns

#status=

def status=(value) -> ::Google::Cloud::Tasks::V2beta2::TaskStatus
Parameter
Returns

#view

def view() -> ::Google::Cloud::Tasks::V2beta2::Task::View
Returns

#view=

def view=(value) -> ::Google::Cloud::Tasks::V2beta2::Task::View
Parameter
Returns