class Google::Apis::CloudtasksV2::Task

A unit of scheduled work.

Attributes

app_engine_http_request[RW]

App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. Using AppEngineHttpRequest requires [`appengine.applications.get`](cloud.google.com/appengine/ docs/admin-api/access-control) Google IAM permission for the project and the following scope: `www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see [How Requests are Routed](cloud. google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](cloud.google.com/appengine/ docs/python/config/dispatchref). Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If app_engine_routing_override is set on the queue, this value is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The `url` that the task will be sent to is:

  • `url =` host `+` relative_uri Tasks can be dispatched to secure app handlers,

unsecure app handlers, and URIs restricted with [`login: admin`](https:// cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [` login: required`](cloud.google.com/appengine/docs/standard/python/ config/appref) Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the deadline. Failed tasks will be retried according to the retry configuration. `503` (Service Unavailable) is considered an App Engine system error instead of an application error and will cause Cloud Tasks' traffic congestion control to temporarily throttle the queue's dispatches. Unlike other types of task targets, a `429` (Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue. Corresponds to the JSON property `appEngineHttpRequest` @return [Google::Apis::CloudtasksV2::AppEngineHttpRequest]

create_time[RW]

Output only. The time that the task was created. `create_time` will be truncated to the nearest second. Corresponds to the JSON property `createTime` @return [String]

dispatch_count[RW]

Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response. Corresponds to the JSON property `dispatchCount` @return [Fixnum]

dispatch_deadline[RW]

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 listening 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]( cloud.google.com/appengine/docs/standard/go/how-instances-are-managed# instance_scaling) 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](cloud.google.com/tasks/docs/creating-appengine-handlers# timeouts). `dispatch_deadline` will be truncated to the nearest millisecond. The deadline is an approximate deadline. Corresponds to the JSON property `dispatchDeadline` @return [String]

first_attempt[RW]

The status of a task attempt. Corresponds to the JSON property `firstAttempt` @return [Google::Apis::CloudtasksV2::Attempt]

http_request[RW]

HTTP request. The task will be pushed to the worker as an HTTP request. If the worker or the redirected worker acknowledges the task by returning a successful HTTP response code ([`200` - `299`]), the task will be removed from the queue. If any other HTTP response code is returned or no response is received, the task will be retried according to the following: * User- specified throttling: retry configuration, rate limits, and the queue's state.

  • System throttling: To prevent the worker from overloading, Cloud Tasks may

temporarily reduce the queue's effective rate. User-specified settings will not be changed. System throttling happens because: * Cloud Tasks backs off on all errors. Normally the backoff specified in rate limits will be used. But if the worker returns `429` (Too Many Requests), `503` (Service Unavailable), or the rate of errors is high, Cloud Tasks will use a higher backoff rate. The retry specified in the `Retry-After` HTTP response header is considered. * To prevent traffic spikes and to smooth sudden increases in traffic, dispatches ramp up slowly when the queue is newly created or idle and if large numbers of tasks suddenly become available to dispatch (due to spikes in create task rates, the queue being unpaused, or many tasks that are scheduled at the same time). Corresponds to the JSON property `httpRequest` @return [Google::Apis::CloudtasksV2::HttpRequest]

last_attempt[RW]

The status of a task attempt. Corresponds to the JSON property `lastAttempt` @return [Google::Apis::CloudtasksV2::Attempt]

name[RW]

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](cloud.google.com/resource-manager/docs/creating- managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the task's location. The list of available locations can be obtained by calling ListLocations. For more information, see 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. Corresponds to the JSON property `name` @return [String]

response_count[RW]

Output only. The number of attempts which have received a response. Corresponds to the JSON property `responseCount` @return [Fixnum]

schedule_time[RW]

The time when the task is scheduled to be attempted or retried. `schedule_time` will be truncated to the nearest microsecond. Corresponds to the JSON property `scheduleTime` @return [String]

view[RW]

Output only. The view specifies which subset of the Task has been returned. Corresponds to the JSON property `view` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/cloudtasks_v2/classes.rb, line 1383
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/cloudtasks_v2/classes.rb, line 1388
def update!(**args)
  @app_engine_http_request = args[:app_engine_http_request] if args.key?(:app_engine_http_request)
  @create_time = args[:create_time] if args.key?(:create_time)
  @dispatch_count = args[:dispatch_count] if args.key?(:dispatch_count)
  @dispatch_deadline = args[:dispatch_deadline] if args.key?(:dispatch_deadline)
  @first_attempt = args[:first_attempt] if args.key?(:first_attempt)
  @http_request = args[:http_request] if args.key?(:http_request)
  @last_attempt = args[:last_attempt] if args.key?(:last_attempt)
  @name = args[:name] if args.key?(:name)
  @response_count = args[:response_count] if args.key?(:response_count)
  @schedule_time = args[:schedule_time] if args.key?(:schedule_time)
  @view = args[:view] if args.key?(:view)
end