Cloud Tasks V2 API - Class Google::Cloud::Tasks::V2::Task (v0.7.0)

Reference documentation and code samples for the Cloud Tasks V2 API class Google::Cloud::Tasks::V2::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::V2::AppEngineHttpRequest
Returns

#app_engine_http_request=

def app_engine_http_request=(value) -> ::Google::Cloud::Tasks::V2::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

#dispatch_count

def dispatch_count() -> ::Integer
Returns
  • (::Integer) — Output only. The number of attempts dispatched.

    This count includes attempts which have been dispatched but haven't received a response.

#dispatch_count=

def dispatch_count=(value) -> ::Integer
Parameter
  • value (::Integer) — Output only. The number of attempts dispatched.

    This count includes attempts which have been dispatched but haven't received a response.

Returns
  • (::Integer) — Output only. The number of attempts dispatched.

    This count includes attempts which have been dispatched but haven't received a response.

#dispatch_deadline

def dispatch_deadline() -> ::Google::Protobuf::Duration
Returns
  • (::Google::Protobuf::Duration) — The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. Cloud Tasks will retry the task according to the RetryConfig.

    Note that when the request is cancelled, Cloud Tasks will stop listing for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests.

    The default and maximum values depend on the type of request:

    • For HTTP tasks, the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes].

    • For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. Regardless of the task's dispatch_deadline, the app handler will not run for longer than than the service's timeout. We recommend setting the dispatch_deadline to at most a few seconds more than the app handler's timeout. For more information see Timeouts.

    dispatch_deadline will be truncated to the nearest millisecond. The deadline is an approximate deadline.

#dispatch_deadline=

def dispatch_deadline=(value) -> ::Google::Protobuf::Duration
Parameter
  • value (::Google::Protobuf::Duration) — The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. Cloud Tasks will retry the task according to the RetryConfig.

    Note that when the request is cancelled, Cloud Tasks will stop listing for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests.

    The default and maximum values depend on the type of request:

    • For HTTP tasks, the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes].

    • For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. Regardless of the task's dispatch_deadline, the app handler will not run for longer than than the service's timeout. We recommend setting the dispatch_deadline to at most a few seconds more than the app handler's timeout. For more information see Timeouts.

    dispatch_deadline will be truncated to the nearest millisecond. The deadline is an approximate deadline.

Returns
  • (::Google::Protobuf::Duration) — The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a DEADLINE_EXCEEDED failure. Cloud Tasks will retry the task according to the RetryConfig.

    Note that when the request is cancelled, Cloud Tasks will stop listing for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests.

    The default and maximum values depend on the type of request:

    • For HTTP tasks, the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes].

    • For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. Regardless of the task's dispatch_deadline, the app handler will not run for longer than than the service's timeout. We recommend setting the dispatch_deadline to at most a few seconds more than the app handler's timeout. For more information see Timeouts.

    dispatch_deadline will be truncated to the nearest millisecond. The deadline is an approximate deadline.

#first_attempt

def first_attempt() -> ::Google::Cloud::Tasks::V2::Attempt
Returns

#first_attempt=

def first_attempt=(value) -> ::Google::Cloud::Tasks::V2::Attempt
Parameter
Returns

#http_request

def http_request() -> ::Google::Cloud::Tasks::V2::HttpRequest
Returns

#http_request=

def http_request=(value) -> ::Google::Cloud::Tasks::V2::HttpRequest
Parameter
Returns

#last_attempt

def last_attempt() -> ::Google::Cloud::Tasks::V2::Attempt
Returns

#last_attempt=

def last_attempt=(value) -> ::Google::Cloud::Tasks::V2::Attempt
Parameter
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.

#response_count

def response_count() -> ::Integer
Returns
  • (::Integer) — Output only. The number of attempts which have received a response.

#response_count=

def response_count=(value) -> ::Integer
Parameter
  • value (::Integer) — Output only. The number of attempts which have received a response.
Returns
  • (::Integer) — Output only. The number of attempts which have received a response.

#schedule_time

def schedule_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — The time when the task is scheduled to be attempted or retried.

    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 or retried.

    schedule_time will be truncated to the nearest microsecond.

Returns
  • (::Google::Protobuf::Timestamp) — The time when the task is scheduled to be attempted or retried.

    schedule_time will be truncated to the nearest microsecond.

#view

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

#view=

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