Package Classes (2.16.5)

Summary of entries of Classes for cloudtasks.

Classes

CloudTasksAsyncClient

Cloud Tasks allows developers to manage the execution of background work in their applications.

CloudTasksClient

Cloud Tasks allows developers to manage the execution of background work in their applications.

ListQueuesAsyncPager

A pager for iterating through list_queues requests.

This class thinly wraps an initial ListQueuesResponse object, and provides an __aiter__ method to iterate through its queues field.

If there are more pages, the __aiter__ method will make additional ListQueues requests and continue to iterate through the queues field on the corresponding responses.

All the usual ListQueuesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListQueuesPager

A pager for iterating through list_queues requests.

This class thinly wraps an initial ListQueuesResponse object, and provides an __iter__ method to iterate through its queues field.

If there are more pages, the __iter__ method will make additional ListQueues requests and continue to iterate through the queues field on the corresponding responses.

All the usual ListQueuesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListTasksAsyncPager

A pager for iterating through list_tasks requests.

This class thinly wraps an initial ListTasksResponse object, and provides an __aiter__ method to iterate through its tasks field.

If there are more pages, the __aiter__ method will make additional ListTasks requests and continue to iterate through the tasks field on the corresponding responses.

All the usual ListTasksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListTasksPager

A pager for iterating through list_tasks requests.

This class thinly wraps an initial ListTasksResponse object, and provides an __iter__ method to iterate through its tasks field.

If there are more pages, the __iter__ method will make additional ListTasks requests and continue to iterate through the tasks field on the corresponding responses.

All the usual ListTasksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

AppEngineHttpRequest

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 https://cloud.google.com/appengine/docs/admin-api/access-control`__ Google IAM permission for the project and the following scope:

https://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 <https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed> and how routing is affected by dispatch files <https://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][google.cloud.tasks.v2.Queue.app_engine_routing_override], this value is used for all tasks in the queue, no matter what the setting is for the [task-level app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.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 withlogin: required` <https://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][google.cloud.tasks.v2.Queue.retry_config]. 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.

HeadersEntry

The abstract base class for a message.

AppEngineRouting

App Engine Routing.

Defines routing characteristics specific to App Engine - service, version, and instance.

For more information about services, versions, and instances see An Overview of App Engine <https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine>, Microservices Architecture on Google App Engine <https://cloud.google.com/appengine/docs/python/microservices-on-app-engine>, App Engine Standard request routing <https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed>, and App Engine Flex request routing <https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed>.

Using AppEngineRouting requires `appengine.applications.get https://cloud.google.com/appengine/docs/admin-api/access-control`__ Google IAM permission for the project and the following scope:

https://www.googleapis.com/auth/cloud-platform

Attempt

The status of a task attempt.

CreateQueueRequest

Request message for CreateQueue.

CreateTaskRequest

Request message for CreateTask.

DeleteQueueRequest

Request message for DeleteQueue.

DeleteTaskRequest

Request message for deleting a task using DeleteTask.

GetQueueRequest

Request message for GetQueue.

GetTaskRequest

Request message for getting a task using GetTask.

HttpMethod

The HTTP method used to deliver the task.

HttpRequest

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][google.cloud.tasks.v2.Queue.retry_config], [rate limits][google.cloud.tasks.v2.Queue.rate_limits], and the [queue's state][google.cloud.tasks.v2.Queue.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][google.cloud.tasks.v2.Queue.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).

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

HeadersEntry

The abstract base class for a message.

ListQueuesRequest

Request message for ListQueues.

ListQueuesResponse

Response message for ListQueues.

ListTasksRequest

Request message for listing tasks using ListTasks.

ListTasksResponse

Response message for listing tasks using ListTasks.

OAuthToken

Contains information needed for generating an OAuth token <https://developers.google.com/identity/protocols/OAuth2>__. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.

OidcToken

Contains information needed for generating an OpenID Connect token <https://developers.google.com/identity/protocols/OpenIDConnect>__. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.

PauseQueueRequest

Request message for PauseQueue.

PurgeQueueRequest

Request message for PurgeQueue.

Queue

A queue is a container of related tasks. Queues are configured to manage how those tasks are dispatched. Configurable properties include rate limits, retry options, queue types, and others.

State

State of the queue.

    If the queue was created using Cloud Tasks and the queue has
    had no activity (method calls or task dispatches) for 30
    days, the queue may take a few minutes to re-activate. Some
    method calls may return
    `NOT_FOUND][google.rpc.Code.NOT_FOUND]` and tasks may not be
    dispatched for a few minutes until the queue has been
    re-activated.
PAUSED (2):
    Tasks are paused by the user. If the queue is
    paused then Cloud Tasks will stop delivering
    tasks from it, but more tasks can still be added
    to it by the user.
DISABLED (3):
    The queue is disabled.

    A queue becomes `DISABLED` when
    `queue.yaml <https://cloud.google.com/appengine/docs/python/config/queueref>`__
    or
    `queue.xml <https://cloud.google.com/appengine/docs/standard/java/config/queueref>`__
    is uploaded which does not contain the queue. You cannot
    directly disable a queue.

    When a queue is disabled, tasks can still be added to a
    queue but the tasks are not dispatched.

    To permanently delete this queue and all of its tasks, call
    <xref uid="google.cloud.tasks.v2.CloudTasks.DeleteQueue">DeleteQueue</xref>.

RateLimits

Rate limits.

This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry.

Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits.

ResumeQueueRequest

Request message for ResumeQueue.

RetryConfig

Retry config.

These settings determine when a failed task attempt is retried.

RunTaskRequest

Request message for forcing a task to run now using RunTask.

StackdriverLoggingConfig

Configuration options for writing logs to Stackdriver Logging <https://cloud.google.com/logging/docs/>__.

Task

A unit of scheduled work.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

View

The view specifies a subset of Task data.

When a task is returned in a response, not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains.

    This view does not include the [body in
    AppEngineHttpRequest][google.cloud.tasks.v2.AppEngineHttpRequest.body].
    Bodies are desirable to return only when needed, because
    they can be large and because of the sensitivity of the data
    that you choose to store in it.
FULL (2):
    All information is returned.

    Authorization for
    <xref uid="google.cloud.tasks.v2.Task.View.FULL">FULL</xref> requires
    `cloudtasks.tasks.fullView` `Google
    IAM <https://cloud.google.com/iam/>`__ permission on the
    <xref uid="google.cloud.tasks.v2.Queue">Queue</xref> resource.

UpdateQueueRequest

Request message for UpdateQueue.

CloudTasksAsyncClient

Cloud Tasks allows developers to manage the execution of background work in their applications.

CloudTasksClient

Cloud Tasks allows developers to manage the execution of background work in their applications.

ListQueuesAsyncPager

A pager for iterating through list_queues requests.

This class thinly wraps an initial ListQueuesResponse object, and provides an __aiter__ method to iterate through its queues field.

If there are more pages, the __aiter__ method will make additional ListQueues requests and continue to iterate through the queues field on the corresponding responses.

All the usual ListQueuesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListQueuesPager

A pager for iterating through list_queues requests.

This class thinly wraps an initial ListQueuesResponse object, and provides an __iter__ method to iterate through its queues field.

If there are more pages, the __iter__ method will make additional ListQueues requests and continue to iterate through the queues field on the corresponding responses.

All the usual ListQueuesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListTasksAsyncPager

A pager for iterating through list_tasks requests.

This class thinly wraps an initial ListTasksResponse object, and provides an __aiter__ method to iterate through its tasks field.

If there are more pages, the __aiter__ method will make additional ListTasks requests and continue to iterate through the tasks field on the corresponding responses.

All the usual ListTasksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListTasksPager

A pager for iterating through list_tasks requests.

This class thinly wraps an initial ListTasksResponse object, and provides an __iter__ method to iterate through its tasks field.

If there are more pages, the __iter__ method will make additional ListTasks requests and continue to iterate through the tasks field on the corresponding responses.

All the usual ListTasksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

AcknowledgeTaskRequest

Request message for acknowledging a task using AcknowledgeTask.

AppEngineHttpRequest

App Engine HTTP request.

The message defines the HTTP request that is sent to an App Engine app when the task is dispatched.

This proto can only be used for tasks in a queue which has app_engine_http_target set.

Using AppEngineHttpRequest requires `appengine.applications.get https://cloud.google.com/appengine/docs/admin-api/access-control`__ Google IAM permission for the project and the following scope:

https://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 <https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed> and how routing is affected by dispatch files <https://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 set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the [task-level app_engine_routing][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing].

The url that the task will be sent to is:

  • url = host + relative_url

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 withlogin: required` <https://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][Task.dispatch_deadline]. Failed tasks will be retried according to the [retry configuration][google.cloud.tasks.v2beta2.Queue.retry_config]. 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.

HeadersEntry

The abstract base class for a message.

AppEngineHttpTarget

App Engine HTTP target.

The task will be delivered to the App Engine application hostname specified by its AppEngineHttpTarget and AppEngineHttpRequest. The documentation for AppEngineHttpRequest explains how the task's host URL is constructed.

Using AppEngineHttpTarget requires `appengine.applications.get https://cloud.google.com/appengine/docs/admin-api/access-control`__ Google IAM permission for the project and the following scope:

https://www.googleapis.com/auth/cloud-platform

AppEngineRouting

App Engine Routing.

Defines routing characteristics specific to App Engine - service, version, and instance.

For more information about services, versions, and instances see An Overview of App Engine <https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine>, Microservices Architecture on Google App Engine <https://cloud.google.com/appengine/docs/python/microservices-on-app-engine>, App Engine Standard request routing <https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed>, and App Engine Flex request routing <https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed>.

AttemptStatus

The status of a task attempt.

CancelLeaseRequest

Request message for canceling a lease using CancelLease.

CreateQueueRequest

Request message for CreateQueue.

CreateTaskRequest

Request message for CreateTask.

DeleteQueueRequest

Request message for DeleteQueue.

DeleteTaskRequest

Request message for deleting a task using DeleteTask.

GetQueueRequest

Request message for GetQueue.

GetTaskRequest

Request message for getting a task using GetTask.

HttpMethod

The HTTP method used to execute the task.

HttpRequest

HTTP request.

The task will be pushed to the worker as an HTTP request. An HTTP request embodies a url, an http method, headers, body and authorization for the http task.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

HeadersEntry

The abstract base class for a message.

HttpTarget

HTTP target.

When specified as a Queue][target_type], all the tasks with [HttpRequest] will be overridden according to the target.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Defines a header message. A header can have a key and a value.

HeaderOverride

Wraps the Header object.

LeaseTasksRequest

Request message for leasing tasks using LeaseTasks.

LeaseTasksResponse

Response message for leasing tasks using LeaseTasks.

ListQueuesRequest

Request message for ListQueues.

ListQueuesResponse

Response message for ListQueues.

ListTasksRequest

Request message for listing tasks using ListTasks.

ListTasksResponse

Response message for listing tasks using ListTasks.

OAuthToken

Contains information needed for generating an OAuth token <https://developers.google.com/identity/protocols/OAuth2>__. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.

OidcToken

Contains information needed for generating an OpenID Connect token <https://developers.google.com/identity/protocols/OpenIDConnect>__. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.

PathOverride

PathOverride.

Path message defines path override for HTTP targets.

PauseQueueRequest

Request message for PauseQueue.

PullMessage

The pull message contains data that can be used by the caller of LeaseTasks to process the task.

This proto can only be used for tasks in a queue which has pull_target set.

PullTarget

Pull target.

PurgeQueueRequest

Request message for PurgeQueue.

QueryOverride

QueryOverride.

Query message defines query override for HTTP targets.

Queue

A queue is a container of related tasks. Queues are configured to manage how those tasks are dispatched. Configurable properties include rate limits, retry options, target types, and others.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

State

State of the queue.

    If the queue was created using Cloud Tasks and the queue has
    had no activity (method calls or task dispatches) for 30
    days, the queue may take a few minutes to re-activate. Some
    method calls may return
    `NOT_FOUND][google.rpc.Code.NOT_FOUND]` and tasks may not be
    dispatched for a few minutes until the queue has been
    re-activated.
PAUSED (2):
    Tasks are paused by the user. If the queue is paused then
    Cloud Tasks will stop delivering tasks from it, but more
    tasks can still be added to it by the user. When a pull
    queue is paused, all
    <xref uid="google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks">LeaseTasks</xref>
    calls will return a
    `FAILED_PRECONDITION][google.rpc.Code.FAILED_PRECONDITION]`.
DISABLED (3):
    The queue is disabled.

    A queue becomes `DISABLED` when
    `queue.yaml <https://cloud.google.com/appengine/docs/python/config/queueref>`__
    or
    `queue.xml <https://cloud.google.com/appengine/docs/standard/java/config/queueref>`__
    is uploaded which does not contain the queue. You cannot
    directly disable a queue.

    When a queue is disabled, tasks can still be added to a
    queue but the tasks are not dispatched and
    <xref uid="google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks">LeaseTasks</xref>
    calls return a `FAILED_PRECONDITION` error.

    To permanently delete this queue and all of its tasks, call
    <xref uid="google.cloud.tasks.v2beta2.CloudTasks.DeleteQueue">DeleteQueue</xref>.

QueueStats

Statistics for a queue.

RateLimits

Rate limits.

This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry.

Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits.

RenewLeaseRequest

Request message for renewing a lease using RenewLease.

ResumeQueueRequest

Request message for ResumeQueue.

RetryConfig

Retry config.

These settings determine how a failed task attempt is retried.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

RunTaskRequest

Request message for forcing a task to run now using RunTask.

Task

A unit of scheduled work.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

View

The view specifies a subset of Task data.

When a task is returned in a response, not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains.

    This view does not include the ([payload in
    AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest]
    and [payload in
    PullMessage][google.cloud.tasks.v2beta2.PullMessage.payload]).
    These payloads are desirable to return only when needed,
    because they can be large and because of the sensitivity of
    the data that you choose to store in it.
FULL (2):
    All information is returned.

    Authorization for
    <xref uid="google.cloud.tasks.v2beta2.Task.View.FULL">FULL</xref> requires
    `cloudtasks.tasks.fullView` `Google
    IAM <https://cloud.google.com/iam/>`__ permission on the
    <xref uid="google.cloud.tasks.v2beta2.Queue">Queue</xref> resource.

TaskStatus

Status of the task.

UpdateQueueRequest

Request message for UpdateQueue.

UploadQueueYamlRequest

Request message for UploadQueueYaml.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

UriOverride

Uri Override.

When specified, all the HTTP tasks inside the queue will be partially or fully overridden depending on the configured values.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Scheme

The Scheme for an HTTP request. By default, it is HTTPS.

UriOverrideEnforceMode

UriOverrideEnforceMode mode is to define enforcing mode for the override modes.

CloudTasksAsyncClient

Cloud Tasks allows developers to manage the execution of background work in their applications.

CloudTasksClient

Cloud Tasks allows developers to manage the execution of background work in their applications.

ListQueuesAsyncPager

A pager for iterating through list_queues requests.

This class thinly wraps an initial ListQueuesResponse object, and provides an __aiter__ method to iterate through its queues field.

If there are more pages, the __aiter__ method will make additional ListQueues requests and continue to iterate through the queues field on the corresponding responses.

All the usual ListQueuesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListQueuesPager

A pager for iterating through list_queues requests.

This class thinly wraps an initial ListQueuesResponse object, and provides an __iter__ method to iterate through its queues field.

If there are more pages, the __iter__ method will make additional ListQueues requests and continue to iterate through the queues field on the corresponding responses.

All the usual ListQueuesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListTasksAsyncPager

A pager for iterating through list_tasks requests.

This class thinly wraps an initial ListTasksResponse object, and provides an __aiter__ method to iterate through its tasks field.

If there are more pages, the __aiter__ method will make additional ListTasks requests and continue to iterate through the tasks field on the corresponding responses.

All the usual ListTasksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListTasksPager

A pager for iterating through list_tasks requests.

This class thinly wraps an initial ListTasksResponse object, and provides an __iter__ method to iterate through its tasks field.

If there are more pages, the __iter__ method will make additional ListTasks requests and continue to iterate through the tasks field on the corresponding responses.

All the usual ListTasksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

AppEngineHttpQueue

App Engine HTTP queue.

The task will be delivered to the App Engine application hostname specified by its AppEngineHttpQueue and AppEngineHttpRequest. The documentation for AppEngineHttpRequest explains how the task's host URL is constructed.

Using AppEngineHttpQueue requires `appengine.applications.get https://cloud.google.com/appengine/docs/admin-api/access-control`__ Google IAM permission for the project and the following scope:

https://www.googleapis.com/auth/cloud-platform

AppEngineHttpRequest

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 https://cloud.google.com/appengine/docs/admin-api/access-control`__ Google IAM permission for the project and the following scope:

https://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 <https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed> and how routing is affected by dispatch files <https://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 set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the [task-level app_engine_routing][google.cloud.tasks.v2beta3.AppEngineHttpRequest.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 withlogin: required` <https://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][google.cloud.tasks.v2beta3.Queue.retry_config]. 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.

HeadersEntry

The abstract base class for a message.

AppEngineRouting

App Engine Routing.

Defines routing characteristics specific to App Engine - service, version, and instance.

For more information about services, versions, and instances see An Overview of App Engine <https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine>, Microservices Architecture on Google App Engine <https://cloud.google.com/appengine/docs/python/microservices-on-app-engine>, App Engine Standard request routing <https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed>, and App Engine Flex request routing <https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed>.

Attempt

The status of a task attempt.

CreateQueueRequest

Request message for CreateQueue.

CreateTaskRequest

Request message for CreateTask.

DeleteQueueRequest

Request message for DeleteQueue.

DeleteTaskRequest

Request message for deleting a task using DeleteTask.

GetQueueRequest

Request message for GetQueue.

GetTaskRequest

Request message for getting a task using GetTask.

HttpMethod

The HTTP method used to execute the task.

HttpRequest

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][google.cloud.tasks.v2beta3.Queue.retry_config], rate limits, and the [queue's state][google.cloud.tasks.v2beta3.Queue.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][google.cloud.tasks.v2beta3.Queue.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).

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

HeadersEntry

The abstract base class for a message.

HttpTarget

HTTP target.

When specified as a Queue][target_type], all the tasks with [HttpRequest] will be overridden according to the target.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Header

Defines a header message. A header can have a key and a value.

HeaderOverride

Wraps the Header object.

ListQueuesRequest

Request message for ListQueues.

ListQueuesResponse

Response message for ListQueues.

ListTasksRequest

Request message for listing tasks using ListTasks.

ListTasksResponse

Response message for listing tasks using ListTasks.

OAuthToken

Contains information needed for generating an OAuth token <https://developers.google.com/identity/protocols/OAuth2>__. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.

OidcToken

Contains information needed for generating an OpenID Connect token <https://developers.google.com/identity/protocols/OpenIDConnect>__. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.

PathOverride

PathOverride.

Path message defines path override for HTTP targets.

PauseQueueRequest

Request message for PauseQueue.

PullMessage

Pull Message.

This proto can only be used for tasks in a queue which has PULL type. It currently exists for backwards compatibility with the App Engine Task Queue SDK. This message type maybe returned with methods list and get, when the response view is FULL.

PurgeQueueRequest

Request message for PurgeQueue.

QueryOverride

QueryOverride.

Query message defines query override for HTTP targets.

Queue

A queue is a container of related tasks. Queues are configured to manage how those tasks are dispatched. Configurable properties include rate limits, retry options, queue types, and others.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

State

State of the queue.

    If the queue was created using Cloud Tasks and the queue has
    had no activity (method calls or task dispatches) for 30
    days, the queue may take a few minutes to re-activate. Some
    method calls may return
    `NOT_FOUND][google.rpc.Code.NOT_FOUND]` and tasks may not be
    dispatched for a few minutes until the queue has been
    re-activated.
PAUSED (2):
    Tasks are paused by the user. If the queue is
    paused then Cloud Tasks will stop delivering
    tasks from it, but more tasks can still be added
    to it by the user.
DISABLED (3):
    The queue is disabled.

    A queue becomes `DISABLED` when
    `queue.yaml <https://cloud.google.com/appengine/docs/python/config/queueref>`__
    or
    `queue.xml <https://cloud.google.com/appengine/docs/standard/java/config/queueref>`__
    is uploaded which does not contain the queue. You cannot
    directly disable a queue.

    When a queue is disabled, tasks can still be added to a
    queue but the tasks are not dispatched.

    To permanently delete this queue and all of its tasks, call
    <xref uid="google.cloud.tasks.v2beta3.CloudTasks.DeleteQueue">DeleteQueue</xref>.

Type

The type of the queue.

QueueStats

Statistics for a queue.

RateLimits

Rate limits.

This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry.

Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits.

ResumeQueueRequest

Request message for ResumeQueue.

RetryConfig

Retry config.

These settings determine when a failed task attempt is retried.

RunTaskRequest

Request message for forcing a task to run now using RunTask.

StackdriverLoggingConfig

Configuration options for writing logs to Stackdriver Logging <https://cloud.google.com/logging/docs/>__.

Task

A unit of scheduled work.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

View

The view specifies a subset of Task data.

When a task is returned in a response, not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains.

    This view does not include the [body in
    AppEngineHttpRequest][google.cloud.tasks.v2beta3.AppEngineHttpRequest.body].
    Bodies are desirable to return only when needed, because
    they can be large and because of the sensitivity of the data
    that you choose to store in it.
FULL (2):
    All information is returned.

    Authorization for
    <xref uid="google.cloud.tasks.v2beta3.Task.View.FULL">FULL</xref> requires
    `cloudtasks.tasks.fullView` `Google
    IAM <https://cloud.google.com/iam/>`__ permission on the
    <xref uid="google.cloud.tasks.v2beta3.Queue">Queue</xref> resource.

UpdateQueueRequest

Request message for UpdateQueue.

UriOverride

URI Override.

When specified, all the HTTP tasks inside the queue will be partially or fully overridden depending on the configured values.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Scheme

The Scheme for an HTTP request. By default, it is HTTPS.

UriOverrideEnforceMode

UriOverrideEnforceMode mode is to define enforcing mode for the override modes.

Modules

pagers

API documentation for tasks_v2.services.cloud_tasks.pagers module.

pagers

API documentation for tasks_v2beta2.services.cloud_tasks.pagers module.

pagers

API documentation for tasks_v2beta3.services.cloud_tasks.pagers module.