docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.html b/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.html
index f796d05..c5fdd2c 100644
--- a/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.html
+++ b/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.html
@@ -92,7 +92,7 @@
<code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the access control policy for a Queue.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</a></code></p>
+ <code><a href="#list">list(parent, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists queues.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -136,7 +136,7 @@
For example: `projects/PROJECT_ID/locations/LOCATION_ID`
The list of allowed locations can be obtained by calling Cloud
-Tasks' implementation of
+Tasks' implementation of
ListLocations. (required)
body: object, The request body.
The object takes the form of:
@@ -144,121 +144,14 @@
{ # 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.
- "name": "A String", # Caller-specified and required in CreateQueue,
- # after which it becomes output only.
- #
- # The queue name.
- #
- # The queue name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the queue's location.
- # The list of available locations can be obtained by calling
- # 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.
- "rateLimits": { # Rate limits. # Rate limits for task dispatches.
- #
- # rate_limits and
- # retry_config are related because they both
- # control task attempts however they control how tasks are
- # attempted in different ways:
- #
- # * rate_limits controls the total rate of
- # dispatches from a queue (i.e. all traffic dispatched from the
- # queue, regardless of whether the dispatch is from a first
- # attempt or a retry).
- # * retry_config controls what happens to
- # particular a task after its first attempt fails. That is,
- # retry_config controls task retries (the
- # second attempt, third attempt, etc).
- #
- # 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.
- "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
- # to be dispatched for this queue. After this threshold has been
- # reached, Cloud Tasks stops dispatching tasks until the number of
- # concurrent requests decreases.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- #
- # The maximum allowed value is 5,000.
- #
- # This field is output only for
- # pull queues and always -1, which indicates no limit. No other
- # queue types can have `max_concurrent_tasks` set to -1.
- #
- #
- # This field has the same meaning as
- # [max_concurrent_requests in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
- "maxBurstSize": 42, # Output only. The max burst size.
- #
- # Max burst size limits how fast tasks in queue are processed when
- # many tasks are in the queue and the rate is high. This field
- # allows the queue to have a high rate so processing starts shortly
- # after a task is enqueued, but still limits resource usage when
- # many tasks are enqueued in a short period of time.
- #
- # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
- # algorithm is used to control the rate of task dispatches. Each
- # queue has a token bucket that holds tokens, up to the maximum
- # specified by `max_burst_size`. Each time a task is dispatched, a
- # token is removed from the bucket. Tasks will be dispatched until
- # the queue's bucket runs out of tokens. The bucket will be
- # continuously refilled with new tokens based on
- # max_tasks_dispatched_per_second.
- #
- # Cloud Tasks will pick the value of `max_burst_size` based on the
- # value of
- # max_tasks_dispatched_per_second.
- #
- # For App Engine queues that were created or updated using
- # `queue.yaml/xml`, `max_burst_size` is equal to
- # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
- # Since `max_burst_size` is output only, if
- # UpdateQueue is called on a queue
- # created by `queue.yaml/xml`, `max_burst_size` will be reset based
- # on the value of
- # max_tasks_dispatched_per_second,
- # regardless of whether
- # max_tasks_dispatched_per_second
- # is updated.
- "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- # * For App Engine queues, the maximum allowed value
- # is 500.
- # * This field is output only for pull queues. In addition to the
- # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
- # LeaseTasks requests are allowed per pull queue.
- #
- #
- # This field has the same meaning as
- # [rate in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
- },
- "appEngineHttpTarget": { # App Engine HTTP target. # App Engine HTTP target.
+ "appEngineHttpTarget": { # App Engine HTTP target. # App Engine HTTP target.
#
# An App Engine queue is a queue that has an AppEngineHttpTarget.
#
# 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.
+ # task's host URL is constructed.
#
# Using AppEngineHttpTarget requires
# [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
@@ -266,7 +159,7 @@
# and the following scope:
#
# `https://www.googleapis.com/auth/cloud-platform`
- "appEngineRoutingOverride": { # App Engine Routing. # Overrides for the
+ "appEngineRoutingOverride": { # App Engine Routing. # Overrides for the
# task-level app_engine_routing.
#
# If set, `app_engine_routing_override` is used for all tasks in
@@ -285,7 +178,7 @@
# 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).
- "instance": "A String", # App instance.
+ "instance": "A String", # App instance.
#
# By default, the task is sent to an instance which is available when
# the task is attempted.
@@ -298,7 +191,23 @@
# 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).
- "host": "A String", # Output only. The host that the task is sent to.
+ "version": "A String", # App version.
+ #
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
+ #
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
#
# For more information, see
# [How Requests are
@@ -308,17 +217,17 @@
#
#
# * `host = [application_domain_name]`</br>
- # `| [service] + '.' + [application_domain_name]`</br>
- # `| [version] + '.' + [application_domain_name]`</br>
- # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
- # `| [instance] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
+ # `| [service] + '.' + [application_domain_name]`</br>
+ # `| [version] + '.' + [application_domain_name]`</br>
+ # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
+ # `| [instance] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
#
# * `application_domain_name` = The domain name of the app, for
# example <app-id>.appspot.com, which is associated with the
- # queue's project ID. Some tasks which were created using the App Engine
+ # queue's project ID. Some tasks which were created using the App Engine
# SDK use a custom domain name.
#
# * `service =` service
@@ -326,22 +235,22 @@
# * `version =` version
#
# * `version_dot_service =`
- # version `+ '.' +`
+ # version `+ '.' +`
# service
#
# * `instance =` instance
#
# * `instance_dot_service =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# service
#
# * `instance_dot_version =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# version
#
# * `instance_dot_version_dot_service =`
- # instance `+ '.' +`
- # version `+ '.' +`
+ # instance `+ '.' +`
+ # version `+ '.' +`
# service
#
# If service is empty, then the task will be sent
@@ -359,23 +268,7 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "version": "A String", # App version.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "service": "A String", # App service.
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -393,18 +286,7 @@
# instance are the empty string.
},
},
- "pullTarget": { # Pull target. # Pull target.
- #
- # A pull queue is a queue that has a PullTarget.
- },
- "state": "A String", # Output only. The state of the queue.
- #
- # `state` can only be changed by called
- # PauseQueue,
- # ResumeQueue, or uploading
- # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
- # UpdateQueue cannot be used to change `state`.
- "purgeTime": "A String", # Output only. The last time this queue was purged.
+ "purgeTime": "A String", # Output only. The last time this queue was purged.
#
# All tasks that were created before this time
# were purged.
@@ -415,7 +297,14 @@
#
# Purge time will be truncated to the nearest microsecond. Purge
# time will be unset if the queue has never been purged.
- "retryConfig": { # Retry config. # Settings that determine the retry behavior.
+ "state": "A String", # Output only. The state of the queue.
+ #
+ # `state` can only be changed by called
+ # PauseQueue,
+ # ResumeQueue, or uploading
+ # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
+ # UpdateQueue cannot be used to change `state`.
+ "retryConfig": { # Retry config. # Settings that determine the retry behavior.
#
# * For tasks created using Cloud Tasks: the queue-level retry settings
# apply to all tasks in the queue that were created using Cloud Tasks.
@@ -427,9 +316,63 @@
# documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
#
# These settings determine how a failed task attempt is retried.
- "maxDoublings": 42, # The time between retries will double `max_doublings` times.
+ "minBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
#
- # A task's retry interval starts at
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `min_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [min_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [max_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ # retrying a failed task, measured from when the task was first
+ # attempted. Once `max_retry_duration` time has passed *and* the
+ # task has been attempted max_attempts
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_retry_duration` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [task_age_limit in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxDoublings": 42, # The time between retries will double `max_doublings` times.
+ #
+ # A task's retry interval starts at
# min_backoff, then doubles
# `max_doublings` times, then increases linearly, and finally
# retries at intervals of
@@ -455,66 +398,123 @@
# This field has the same meaning as
# [max_doublings in
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
- "maxAttempts": 42, # The maximum number of attempts for a task.
+ "maxAttempts": 42, # The maximum number of attempts for a task.
#
# Cloud Tasks will attempt the task `max_attempts` times (that
# is, if the first attempt fails, then there will be
# `max_attempts - 1` retries). Must be > 0.
- "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
- # retrying a failed task, measured from when the task was first
- # attempted. Once `max_retry_duration` time has passed *and* the
- # task has been attempted max_attempts
- # times, no further attempts will be made and the task will be
- # deleted.
- #
- # If zero, then the task age is unlimited.
+ "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
+ },
+ "name": "A String", # Caller-specified and required in CreateQueue,
+ # after which it becomes output only.
+ #
+ # The queue name.
+ #
+ # The queue name must have the following format:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the queue's location.
+ # The list of available locations can be obtained by calling
+ # 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.
+ "rateLimits": { # Rate limits. # Rate limits for task dispatches.
+ #
+ # rate_limits and
+ # retry_config are related because they both
+ # control task attempts however they control how tasks are
+ # attempted in different ways:
+ #
+ # * rate_limits controls the total rate of
+ # dispatches from a queue (i.e. all traffic dispatched from the
+ # queue, regardless of whether the dispatch is from a first
+ # attempt or a retry).
+ # * retry_config controls what happens to
+ # particular a task after its first attempt fails. That is,
+ # retry_config controls task retries (the
+ # second attempt, third attempt, etc).
+ #
+ # 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.
+ "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
+ # to be dispatched for this queue. After this threshold has been
+ # reached, Cloud Tasks stops dispatching tasks until the number of
+ # concurrent requests decreases.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # This field is output only for pull queues.
#
+ # The maximum allowed value is 5,000.
#
- # `max_retry_duration` will be truncated to the nearest second.
+ # This field is output only for
+ # pull queues and always -1, which indicates no limit. No other
+ # queue types can have `max_concurrent_tasks` set to -1.
+ #
#
# This field has the same meaning as
- # [task_age_limit in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "minBackoff": "A String", # A task will be scheduled for retry between
- # min_backoff and
- # max_backoff duration after it fails,
- # if the queue's RetryConfig specifies that the task should be
- # retried.
+ # [max_concurrent_requests in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
+ "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # This field is output only for pull queues.
+ # * For App Engine queues, the maximum allowed value
+ # is 500.
+ # * This field is output only for pull queues. In addition to the
+ # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
+ # LeaseTasks requests are allowed per pull queue.
#
#
- # `min_backoff` will be truncated to the nearest second.
- #
# This field has the same meaning as
- # [min_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxBackoff": "A String", # A task will be scheduled for retry between
- # min_backoff and
- # max_backoff duration after it fails,
- # if the queue's RetryConfig specifies that the task should be
- # retried.
+ # [rate in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
+ "maxBurstSize": 42, # Output only. The max burst size.
#
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
+ # Max burst size limits how fast tasks in queue are processed when
+ # many tasks are in the queue and the rate is high. This field
+ # allows the queue to have a high rate so processing starts shortly
+ # after a task is enqueued, but still limits resource usage when
+ # many tasks are enqueued in a short period of time.
#
- # This field is output only for pull queues.
+ # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
+ # algorithm is used to control the rate of task dispatches. Each
+ # queue has a token bucket that holds tokens, up to the maximum
+ # specified by `max_burst_size`. Each time a task is dispatched, a
+ # token is removed from the bucket. Tasks will be dispatched until
+ # the queue's bucket runs out of tokens. The bucket will be
+ # continuously refilled with new tokens based on
+ # max_tasks_dispatched_per_second.
#
+ # Cloud Tasks will pick the value of `max_burst_size` based on the
+ # value of
+ # max_tasks_dispatched_per_second.
#
- # `max_backoff` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [max_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ # For App Engine queues that were created or updated using
+ # `queue.yaml/xml`, `max_burst_size` is equal to
+ # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
+ # Since `max_burst_size` is output only, if
+ # UpdateQueue is called on a queue
+ # created by `queue.yaml/xml`, `max_burst_size` will be reset based
+ # on the value of
+ # max_tasks_dispatched_per_second,
+ # regardless of whether
+ # max_tasks_dispatched_per_second
+ # is updated.
+ },
+ "pullTarget": { # Pull target. # Pull target.
+ #
+ # A pull queue is a queue that has a PullTarget.
},
}
@@ -529,121 +529,14 @@
{ # 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.
- "name": "A String", # Caller-specified and required in CreateQueue,
- # after which it becomes output only.
- #
- # The queue name.
- #
- # The queue name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the queue's location.
- # The list of available locations can be obtained by calling
- # 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.
- "rateLimits": { # Rate limits. # Rate limits for task dispatches.
- #
- # rate_limits and
- # retry_config are related because they both
- # control task attempts however they control how tasks are
- # attempted in different ways:
- #
- # * rate_limits controls the total rate of
- # dispatches from a queue (i.e. all traffic dispatched from the
- # queue, regardless of whether the dispatch is from a first
- # attempt or a retry).
- # * retry_config controls what happens to
- # particular a task after its first attempt fails. That is,
- # retry_config controls task retries (the
- # second attempt, third attempt, etc).
- #
- # 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.
- "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
- # to be dispatched for this queue. After this threshold has been
- # reached, Cloud Tasks stops dispatching tasks until the number of
- # concurrent requests decreases.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- #
- # The maximum allowed value is 5,000.
- #
- # This field is output only for
- # pull queues and always -1, which indicates no limit. No other
- # queue types can have `max_concurrent_tasks` set to -1.
- #
- #
- # This field has the same meaning as
- # [max_concurrent_requests in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
- "maxBurstSize": 42, # Output only. The max burst size.
- #
- # Max burst size limits how fast tasks in queue are processed when
- # many tasks are in the queue and the rate is high. This field
- # allows the queue to have a high rate so processing starts shortly
- # after a task is enqueued, but still limits resource usage when
- # many tasks are enqueued in a short period of time.
- #
- # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
- # algorithm is used to control the rate of task dispatches. Each
- # queue has a token bucket that holds tokens, up to the maximum
- # specified by `max_burst_size`. Each time a task is dispatched, a
- # token is removed from the bucket. Tasks will be dispatched until
- # the queue's bucket runs out of tokens. The bucket will be
- # continuously refilled with new tokens based on
- # max_tasks_dispatched_per_second.
- #
- # Cloud Tasks will pick the value of `max_burst_size` based on the
- # value of
- # max_tasks_dispatched_per_second.
- #
- # For App Engine queues that were created or updated using
- # `queue.yaml/xml`, `max_burst_size` is equal to
- # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
- # Since `max_burst_size` is output only, if
- # UpdateQueue is called on a queue
- # created by `queue.yaml/xml`, `max_burst_size` will be reset based
- # on the value of
- # max_tasks_dispatched_per_second,
- # regardless of whether
- # max_tasks_dispatched_per_second
- # is updated.
- "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- # * For App Engine queues, the maximum allowed value
- # is 500.
- # * This field is output only for pull queues. In addition to the
- # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
- # LeaseTasks requests are allowed per pull queue.
- #
- #
- # This field has the same meaning as
- # [rate in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
- },
- "appEngineHttpTarget": { # App Engine HTTP target. # App Engine HTTP target.
+ "appEngineHttpTarget": { # App Engine HTTP target. # App Engine HTTP target.
#
# An App Engine queue is a queue that has an AppEngineHttpTarget.
#
# 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.
+ # task's host URL is constructed.
#
# Using AppEngineHttpTarget requires
# [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
@@ -651,7 +544,7 @@
# and the following scope:
#
# `https://www.googleapis.com/auth/cloud-platform`
- "appEngineRoutingOverride": { # App Engine Routing. # Overrides for the
+ "appEngineRoutingOverride": { # App Engine Routing. # Overrides for the
# task-level app_engine_routing.
#
# If set, `app_engine_routing_override` is used for all tasks in
@@ -670,7 +563,7 @@
# 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).
- "instance": "A String", # App instance.
+ "instance": "A String", # App instance.
#
# By default, the task is sent to an instance which is available when
# the task is attempted.
@@ -683,7 +576,23 @@
# 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).
- "host": "A String", # Output only. The host that the task is sent to.
+ "version": "A String", # App version.
+ #
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
+ #
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
#
# For more information, see
# [How Requests are
@@ -693,17 +602,17 @@
#
#
# * `host = [application_domain_name]`</br>
- # `| [service] + '.' + [application_domain_name]`</br>
- # `| [version] + '.' + [application_domain_name]`</br>
- # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
- # `| [instance] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
+ # `| [service] + '.' + [application_domain_name]`</br>
+ # `| [version] + '.' + [application_domain_name]`</br>
+ # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
+ # `| [instance] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
#
# * `application_domain_name` = The domain name of the app, for
# example <app-id>.appspot.com, which is associated with the
- # queue's project ID. Some tasks which were created using the App Engine
+ # queue's project ID. Some tasks which were created using the App Engine
# SDK use a custom domain name.
#
# * `service =` service
@@ -711,22 +620,22 @@
# * `version =` version
#
# * `version_dot_service =`
- # version `+ '.' +`
+ # version `+ '.' +`
# service
#
# * `instance =` instance
#
# * `instance_dot_service =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# service
#
# * `instance_dot_version =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# version
#
# * `instance_dot_version_dot_service =`
- # instance `+ '.' +`
- # version `+ '.' +`
+ # instance `+ '.' +`
+ # version `+ '.' +`
# service
#
# If service is empty, then the task will be sent
@@ -744,23 +653,7 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "version": "A String", # App version.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "service": "A String", # App service.
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -778,18 +671,7 @@
# instance are the empty string.
},
},
- "pullTarget": { # Pull target. # Pull target.
- #
- # A pull queue is a queue that has a PullTarget.
- },
- "state": "A String", # Output only. The state of the queue.
- #
- # `state` can only be changed by called
- # PauseQueue,
- # ResumeQueue, or uploading
- # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
- # UpdateQueue cannot be used to change `state`.
- "purgeTime": "A String", # Output only. The last time this queue was purged.
+ "purgeTime": "A String", # Output only. The last time this queue was purged.
#
# All tasks that were created before this time
# were purged.
@@ -800,7 +682,14 @@
#
# Purge time will be truncated to the nearest microsecond. Purge
# time will be unset if the queue has never been purged.
- "retryConfig": { # Retry config. # Settings that determine the retry behavior.
+ "state": "A String", # Output only. The state of the queue.
+ #
+ # `state` can only be changed by called
+ # PauseQueue,
+ # ResumeQueue, or uploading
+ # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
+ # UpdateQueue cannot be used to change `state`.
+ "retryConfig": { # Retry config. # Settings that determine the retry behavior.
#
# * For tasks created using Cloud Tasks: the queue-level retry settings
# apply to all tasks in the queue that were created using Cloud Tasks.
@@ -812,9 +701,63 @@
# documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
#
# These settings determine how a failed task attempt is retried.
- "maxDoublings": 42, # The time between retries will double `max_doublings` times.
+ "minBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
#
- # A task's retry interval starts at
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `min_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [min_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [max_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ # retrying a failed task, measured from when the task was first
+ # attempted. Once `max_retry_duration` time has passed *and* the
+ # task has been attempted max_attempts
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_retry_duration` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [task_age_limit in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxDoublings": 42, # The time between retries will double `max_doublings` times.
+ #
+ # A task's retry interval starts at
# min_backoff, then doubles
# `max_doublings` times, then increases linearly, and finally
# retries at intervals of
@@ -840,66 +783,123 @@
# This field has the same meaning as
# [max_doublings in
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
- "maxAttempts": 42, # The maximum number of attempts for a task.
+ "maxAttempts": 42, # The maximum number of attempts for a task.
#
# Cloud Tasks will attempt the task `max_attempts` times (that
# is, if the first attempt fails, then there will be
# `max_attempts - 1` retries). Must be > 0.
- "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
- # retrying a failed task, measured from when the task was first
- # attempted. Once `max_retry_duration` time has passed *and* the
- # task has been attempted max_attempts
- # times, no further attempts will be made and the task will be
- # deleted.
- #
- # If zero, then the task age is unlimited.
+ "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
+ },
+ "name": "A String", # Caller-specified and required in CreateQueue,
+ # after which it becomes output only.
+ #
+ # The queue name.
+ #
+ # The queue name must have the following format:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the queue's location.
+ # The list of available locations can be obtained by calling
+ # 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.
+ "rateLimits": { # Rate limits. # Rate limits for task dispatches.
+ #
+ # rate_limits and
+ # retry_config are related because they both
+ # control task attempts however they control how tasks are
+ # attempted in different ways:
+ #
+ # * rate_limits controls the total rate of
+ # dispatches from a queue (i.e. all traffic dispatched from the
+ # queue, regardless of whether the dispatch is from a first
+ # attempt or a retry).
+ # * retry_config controls what happens to
+ # particular a task after its first attempt fails. That is,
+ # retry_config controls task retries (the
+ # second attempt, third attempt, etc).
+ #
+ # 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.
+ "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
+ # to be dispatched for this queue. After this threshold has been
+ # reached, Cloud Tasks stops dispatching tasks until the number of
+ # concurrent requests decreases.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # This field is output only for pull queues.
#
+ # The maximum allowed value is 5,000.
#
- # `max_retry_duration` will be truncated to the nearest second.
+ # This field is output only for
+ # pull queues and always -1, which indicates no limit. No other
+ # queue types can have `max_concurrent_tasks` set to -1.
+ #
#
# This field has the same meaning as
- # [task_age_limit in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "minBackoff": "A String", # A task will be scheduled for retry between
- # min_backoff and
- # max_backoff duration after it fails,
- # if the queue's RetryConfig specifies that the task should be
- # retried.
+ # [max_concurrent_requests in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
+ "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # This field is output only for pull queues.
+ # * For App Engine queues, the maximum allowed value
+ # is 500.
+ # * This field is output only for pull queues. In addition to the
+ # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
+ # LeaseTasks requests are allowed per pull queue.
#
#
- # `min_backoff` will be truncated to the nearest second.
- #
# This field has the same meaning as
- # [min_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxBackoff": "A String", # A task will be scheduled for retry between
- # min_backoff and
- # max_backoff duration after it fails,
- # if the queue's RetryConfig specifies that the task should be
- # retried.
+ # [rate in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
+ "maxBurstSize": 42, # Output only. The max burst size.
#
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
+ # Max burst size limits how fast tasks in queue are processed when
+ # many tasks are in the queue and the rate is high. This field
+ # allows the queue to have a high rate so processing starts shortly
+ # after a task is enqueued, but still limits resource usage when
+ # many tasks are enqueued in a short period of time.
#
- # This field is output only for pull queues.
+ # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
+ # algorithm is used to control the rate of task dispatches. Each
+ # queue has a token bucket that holds tokens, up to the maximum
+ # specified by `max_burst_size`. Each time a task is dispatched, a
+ # token is removed from the bucket. Tasks will be dispatched until
+ # the queue's bucket runs out of tokens. The bucket will be
+ # continuously refilled with new tokens based on
+ # max_tasks_dispatched_per_second.
#
+ # Cloud Tasks will pick the value of `max_burst_size` based on the
+ # value of
+ # max_tasks_dispatched_per_second.
#
- # `max_backoff` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [max_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ # For App Engine queues that were created or updated using
+ # `queue.yaml/xml`, `max_burst_size` is equal to
+ # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
+ # Since `max_burst_size` is output only, if
+ # UpdateQueue is called on a queue
+ # created by `queue.yaml/xml`, `max_burst_size` will be reset based
+ # on the value of
+ # max_tasks_dispatched_per_second,
+ # regardless of whether
+ # max_tasks_dispatched_per_second
+ # is updated.
+ },
+ "pullTarget": { # Pull target. # Pull target.
+ #
+ # A pull queue is a queue that has a PullTarget.
},
}</pre>
</div>
@@ -910,7 +910,7 @@
This command will delete the queue even if it has tasks in it.
-Note: If you delete a queue, a queue with the same name can't be created
+Note: If you delete a queue, a queue with the same name can't be created
for 7 days.
WARNING: Using this method may have unintended side effects if you are
@@ -963,121 +963,14 @@
{ # 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.
- "name": "A String", # Caller-specified and required in CreateQueue,
- # after which it becomes output only.
- #
- # The queue name.
- #
- # The queue name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the queue's location.
- # The list of available locations can be obtained by calling
- # 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.
- "rateLimits": { # Rate limits. # Rate limits for task dispatches.
- #
- # rate_limits and
- # retry_config are related because they both
- # control task attempts however they control how tasks are
- # attempted in different ways:
- #
- # * rate_limits controls the total rate of
- # dispatches from a queue (i.e. all traffic dispatched from the
- # queue, regardless of whether the dispatch is from a first
- # attempt or a retry).
- # * retry_config controls what happens to
- # particular a task after its first attempt fails. That is,
- # retry_config controls task retries (the
- # second attempt, third attempt, etc).
- #
- # 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.
- "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
- # to be dispatched for this queue. After this threshold has been
- # reached, Cloud Tasks stops dispatching tasks until the number of
- # concurrent requests decreases.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- #
- # The maximum allowed value is 5,000.
- #
- # This field is output only for
- # pull queues and always -1, which indicates no limit. No other
- # queue types can have `max_concurrent_tasks` set to -1.
- #
- #
- # This field has the same meaning as
- # [max_concurrent_requests in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
- "maxBurstSize": 42, # Output only. The max burst size.
- #
- # Max burst size limits how fast tasks in queue are processed when
- # many tasks are in the queue and the rate is high. This field
- # allows the queue to have a high rate so processing starts shortly
- # after a task is enqueued, but still limits resource usage when
- # many tasks are enqueued in a short period of time.
- #
- # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
- # algorithm is used to control the rate of task dispatches. Each
- # queue has a token bucket that holds tokens, up to the maximum
- # specified by `max_burst_size`. Each time a task is dispatched, a
- # token is removed from the bucket. Tasks will be dispatched until
- # the queue's bucket runs out of tokens. The bucket will be
- # continuously refilled with new tokens based on
- # max_tasks_dispatched_per_second.
- #
- # Cloud Tasks will pick the value of `max_burst_size` based on the
- # value of
- # max_tasks_dispatched_per_second.
- #
- # For App Engine queues that were created or updated using
- # `queue.yaml/xml`, `max_burst_size` is equal to
- # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
- # Since `max_burst_size` is output only, if
- # UpdateQueue is called on a queue
- # created by `queue.yaml/xml`, `max_burst_size` will be reset based
- # on the value of
- # max_tasks_dispatched_per_second,
- # regardless of whether
- # max_tasks_dispatched_per_second
- # is updated.
- "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- # * For App Engine queues, the maximum allowed value
- # is 500.
- # * This field is output only for pull queues. In addition to the
- # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
- # LeaseTasks requests are allowed per pull queue.
- #
- #
- # This field has the same meaning as
- # [rate in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
- },
- "appEngineHttpTarget": { # App Engine HTTP target. # App Engine HTTP target.
+ "appEngineHttpTarget": { # App Engine HTTP target. # App Engine HTTP target.
#
# An App Engine queue is a queue that has an AppEngineHttpTarget.
#
# 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.
+ # task's host URL is constructed.
#
# Using AppEngineHttpTarget requires
# [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
@@ -1085,7 +978,7 @@
# and the following scope:
#
# `https://www.googleapis.com/auth/cloud-platform`
- "appEngineRoutingOverride": { # App Engine Routing. # Overrides for the
+ "appEngineRoutingOverride": { # App Engine Routing. # Overrides for the
# task-level app_engine_routing.
#
# If set, `app_engine_routing_override` is used for all tasks in
@@ -1104,7 +997,7 @@
# 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).
- "instance": "A String", # App instance.
+ "instance": "A String", # App instance.
#
# By default, the task is sent to an instance which is available when
# the task is attempted.
@@ -1117,7 +1010,23 @@
# 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).
- "host": "A String", # Output only. The host that the task is sent to.
+ "version": "A String", # App version.
+ #
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
+ #
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
#
# For more information, see
# [How Requests are
@@ -1127,17 +1036,17 @@
#
#
# * `host = [application_domain_name]`</br>
- # `| [service] + '.' + [application_domain_name]`</br>
- # `| [version] + '.' + [application_domain_name]`</br>
- # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
- # `| [instance] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
+ # `| [service] + '.' + [application_domain_name]`</br>
+ # `| [version] + '.' + [application_domain_name]`</br>
+ # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
+ # `| [instance] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
#
# * `application_domain_name` = The domain name of the app, for
# example <app-id>.appspot.com, which is associated with the
- # queue's project ID. Some tasks which were created using the App Engine
+ # queue's project ID. Some tasks which were created using the App Engine
# SDK use a custom domain name.
#
# * `service =` service
@@ -1145,22 +1054,22 @@
# * `version =` version
#
# * `version_dot_service =`
- # version `+ '.' +`
+ # version `+ '.' +`
# service
#
# * `instance =` instance
#
# * `instance_dot_service =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# service
#
# * `instance_dot_version =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# version
#
# * `instance_dot_version_dot_service =`
- # instance `+ '.' +`
- # version `+ '.' +`
+ # instance `+ '.' +`
+ # version `+ '.' +`
# service
#
# If service is empty, then the task will be sent
@@ -1178,23 +1087,7 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "version": "A String", # App version.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "service": "A String", # App service.
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -1212,18 +1105,7 @@
# instance are the empty string.
},
},
- "pullTarget": { # Pull target. # Pull target.
- #
- # A pull queue is a queue that has a PullTarget.
- },
- "state": "A String", # Output only. The state of the queue.
- #
- # `state` can only be changed by called
- # PauseQueue,
- # ResumeQueue, or uploading
- # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
- # UpdateQueue cannot be used to change `state`.
- "purgeTime": "A String", # Output only. The last time this queue was purged.
+ "purgeTime": "A String", # Output only. The last time this queue was purged.
#
# All tasks that were created before this time
# were purged.
@@ -1234,7 +1116,14 @@
#
# Purge time will be truncated to the nearest microsecond. Purge
# time will be unset if the queue has never been purged.
- "retryConfig": { # Retry config. # Settings that determine the retry behavior.
+ "state": "A String", # Output only. The state of the queue.
+ #
+ # `state` can only be changed by called
+ # PauseQueue,
+ # ResumeQueue, or uploading
+ # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
+ # UpdateQueue cannot be used to change `state`.
+ "retryConfig": { # Retry config. # Settings that determine the retry behavior.
#
# * For tasks created using Cloud Tasks: the queue-level retry settings
# apply to all tasks in the queue that were created using Cloud Tasks.
@@ -1246,9 +1135,63 @@
# documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
#
# These settings determine how a failed task attempt is retried.
- "maxDoublings": 42, # The time between retries will double `max_doublings` times.
+ "minBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
#
- # A task's retry interval starts at
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `min_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [min_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [max_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ # retrying a failed task, measured from when the task was first
+ # attempted. Once `max_retry_duration` time has passed *and* the
+ # task has been attempted max_attempts
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_retry_duration` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [task_age_limit in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxDoublings": 42, # The time between retries will double `max_doublings` times.
+ #
+ # A task's retry interval starts at
# min_backoff, then doubles
# `max_doublings` times, then increases linearly, and finally
# retries at intervals of
@@ -1274,66 +1217,123 @@
# This field has the same meaning as
# [max_doublings in
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
- "maxAttempts": 42, # The maximum number of attempts for a task.
+ "maxAttempts": 42, # The maximum number of attempts for a task.
#
# Cloud Tasks will attempt the task `max_attempts` times (that
# is, if the first attempt fails, then there will be
# `max_attempts - 1` retries). Must be > 0.
- "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
- # retrying a failed task, measured from when the task was first
- # attempted. Once `max_retry_duration` time has passed *and* the
- # task has been attempted max_attempts
- # times, no further attempts will be made and the task will be
- # deleted.
- #
- # If zero, then the task age is unlimited.
+ "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
+ },
+ "name": "A String", # Caller-specified and required in CreateQueue,
+ # after which it becomes output only.
+ #
+ # The queue name.
+ #
+ # The queue name must have the following format:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the queue's location.
+ # The list of available locations can be obtained by calling
+ # 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.
+ "rateLimits": { # Rate limits. # Rate limits for task dispatches.
+ #
+ # rate_limits and
+ # retry_config are related because they both
+ # control task attempts however they control how tasks are
+ # attempted in different ways:
+ #
+ # * rate_limits controls the total rate of
+ # dispatches from a queue (i.e. all traffic dispatched from the
+ # queue, regardless of whether the dispatch is from a first
+ # attempt or a retry).
+ # * retry_config controls what happens to
+ # particular a task after its first attempt fails. That is,
+ # retry_config controls task retries (the
+ # second attempt, third attempt, etc).
+ #
+ # 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.
+ "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
+ # to be dispatched for this queue. After this threshold has been
+ # reached, Cloud Tasks stops dispatching tasks until the number of
+ # concurrent requests decreases.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # This field is output only for pull queues.
#
+ # The maximum allowed value is 5,000.
#
- # `max_retry_duration` will be truncated to the nearest second.
+ # This field is output only for
+ # pull queues and always -1, which indicates no limit. No other
+ # queue types can have `max_concurrent_tasks` set to -1.
+ #
#
# This field has the same meaning as
- # [task_age_limit in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "minBackoff": "A String", # A task will be scheduled for retry between
- # min_backoff and
- # max_backoff duration after it fails,
- # if the queue's RetryConfig specifies that the task should be
- # retried.
+ # [max_concurrent_requests in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
+ "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # This field is output only for pull queues.
+ # * For App Engine queues, the maximum allowed value
+ # is 500.
+ # * This field is output only for pull queues. In addition to the
+ # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
+ # LeaseTasks requests are allowed per pull queue.
#
#
- # `min_backoff` will be truncated to the nearest second.
- #
# This field has the same meaning as
- # [min_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxBackoff": "A String", # A task will be scheduled for retry between
- # min_backoff and
- # max_backoff duration after it fails,
- # if the queue's RetryConfig specifies that the task should be
- # retried.
+ # [rate in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
+ "maxBurstSize": 42, # Output only. The max burst size.
#
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
+ # Max burst size limits how fast tasks in queue are processed when
+ # many tasks are in the queue and the rate is high. This field
+ # allows the queue to have a high rate so processing starts shortly
+ # after a task is enqueued, but still limits resource usage when
+ # many tasks are enqueued in a short period of time.
#
- # This field is output only for pull queues.
+ # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
+ # algorithm is used to control the rate of task dispatches. Each
+ # queue has a token bucket that holds tokens, up to the maximum
+ # specified by `max_burst_size`. Each time a task is dispatched, a
+ # token is removed from the bucket. Tasks will be dispatched until
+ # the queue's bucket runs out of tokens. The bucket will be
+ # continuously refilled with new tokens based on
+ # max_tasks_dispatched_per_second.
#
+ # Cloud Tasks will pick the value of `max_burst_size` based on the
+ # value of
+ # max_tasks_dispatched_per_second.
#
- # `max_backoff` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [max_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ # For App Engine queues that were created or updated using
+ # `queue.yaml/xml`, `max_burst_size` is equal to
+ # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
+ # Since `max_burst_size` is output only, if
+ # UpdateQueue is called on a queue
+ # created by `queue.yaml/xml`, `max_burst_size` will be reset based
+ # on the value of
+ # max_tasks_dispatched_per_second,
+ # regardless of whether
+ # max_tasks_dispatched_per_second
+ # is updated.
+ },
+ "pullTarget": { # Pull target. # Pull target.
+ #
+ # A pull queue is a queue that has a PullTarget.
},
}</pre>
</div>
@@ -1357,9 +1357,9 @@
The object takes the form of:
{ # Request message for `GetIamPolicy` method.
- "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to
+ "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to
# `GetIamPolicy`.
- "requestedPolicyVersion": 42, # Optional. The policy format version to be returned.
+ "requestedPolicyVersion": 42, # Optional. The policy format version to be returned.
#
# Valid values are 0, 1, and 3. Requests specifying an invalid value will be
# rejected.
@@ -1367,6 +1367,10 @@
# Requests for policies with any conditional bindings must specify version 3.
# Policies without any conditional bindings may specify any valid value or
# leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
},
}
@@ -1388,36 +1392,40 @@
# permissions; each `role` can be an IAM predefined role or a user-created
# custom role.
#
- # Optionally, a `binding` can specify a `condition`, which is a logical
- # expression that allows access to a resource only if the expression evaluates
- # to `true`. A condition can add constraints based on attributes of the
- # request, the resource, or both.
+ # For some types of Google Cloud resources, a `binding` can also specify a
+ # `condition`, which is a logical expression that allows access to a resource
+ # only if the expression evaluates to `true`. A condition can add constraints
+ # based on attributes of the request, the resource, or both. To learn which
+ # resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
#
# **JSON example:**
#
# {
- # "bindings": [
+ # "bindings": [
# {
- # "role": "roles/resourcemanager.organizationAdmin",
- # "members": [
- # "user:mike@example.com",
- # "group:admins@example.com",
- # "domain:google.com",
- # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+ # "role": "roles/resourcemanager.organizationAdmin",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
- # "role": "roles/resourcemanager.organizationViewer",
- # "members": ["user:eve@example.com"],
- # "condition": {
- # "title": "expirable access",
- # "description": "Does not grant access after Sep 2020",
- # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": [
+ # "user:eve@example.com"
+ # ],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
# }
# }
# ],
- # "etag": "BwWWja0YfJA=",
- # "version": 3
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
# **YAML example:**
@@ -1435,63 +1443,107 @@
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
- # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
# - etag: BwWWja0YfJA=
# - version: 3
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "role": "A String", # Role that is assigned to `members`.
+ "role": "A String", # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
- # NOTE: An unsatisfied condition will not allow user access via current
- # binding. Different bindings, including their conditions, are examined
- # independently.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ #
+ # If the condition evaluates to `true`, then this binding applies to the
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the members in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
# syntax. CEL is a C-like expression language. The syntax and semantics of CEL
# are documented at https://github.com/google/cel-spec.
#
# Example (Comparison):
#
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
#
# Example (Equality):
#
- # title: "Requestor is owner"
- # description: "Determines if requestor is the document owner"
- # expression: "document.owner == request.auth.claims.email"
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
#
# Example (Logic):
#
- # title: "Public documents"
- # description: "Determine whether the document should be publicly visible"
- # expression: "document.type != 'private' && document.type != 'internal'"
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
#
# Example (Data Manipulation):
#
- # title: "Notification string"
- # description: "Create a notification string with a timestamp."
- # expression: "'New message received at ' + string(document.create_time)"
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
#
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service
# documentation for additional information.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
},
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
# * `allUsers`: A special identifier that represents anyone who is
@@ -1534,48 +1586,15 @@
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
- "A String",
+ "A String",
],
},
],
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
- # prevent simultaneous updates of a policy from overwriting each other.
- # It is strongly suggested that systems make use of the `etag` in the
- # read-modify-write cycle to perform policy updates in order to avoid race
- # conditions: An `etag` is returned in the response to `getIamPolicy`, and
- # systems are expected to put that etag in the request to `setIamPolicy` to
- # ensure that their change will be applied to the same version of the policy.
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code>
+ <code class="details" id="list">list(parent, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
<pre>Lists queues.
Queues are returned in lexicographical order.
@@ -1583,6 +1602,17 @@
Args:
parent: string, Required. The location name.
For example: `projects/PROJECT_ID/locations/LOCATION_ID` (required)
+ filter: string, `filter` can be used to specify a subset of queues. Any Queue
+field can be used as a filter and several operators as supported.
+For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as
+described in
+[Stackdriver's Advanced Logs
+Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
+
+Sample filter "app_engine_http_target: *".
+
+Note that using filters might cause fewer queues than the
+requested_page size to be returned.
pageToken: string, A token identifying the page of results to return.
To request the first page results, page_token must be empty. To
@@ -1591,10 +1621,6 @@
from the previous call to ListQueues
method. It is an error to switch the value of the
filter while iterating through pages.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
pageSize: integer, Requested page size.
The maximum page size is 9800. If unspecified, the page size will
@@ -1602,150 +1628,27 @@
even if more queues exist; use the
next_page_token in the
response to determine if more queues exist.
- filter: string, `filter` can be used to specify a subset of queues. Any Queue
-field can be used as a filter and several operators as supported.
-For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as
-described in
-[Stackdriver's Advanced Logs
-Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
-
-Sample filter "app_engine_http_target: *".
-
-Note that using filters might cause fewer queues than the
-requested_page size to be returned.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # Response message for ListQueues.
- "nextPageToken": "A String", # A token to retrieve next page of results.
- #
- # To return the next page of results, call
- # ListQueues with this value as the
- # page_token.
- #
- # If the next_page_token is empty, there are no more results.
- #
- # The page token is valid for only 2 hours.
- "queues": [ # The list of queues.
+ "queues": [ # The list of queues.
{ # 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.
- "name": "A String", # Caller-specified and required in CreateQueue,
- # after which it becomes output only.
- #
- # The queue name.
- #
- # The queue name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the queue's location.
- # The list of available locations can be obtained by calling
- # 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.
- "rateLimits": { # Rate limits. # Rate limits for task dispatches.
- #
- # rate_limits and
- # retry_config are related because they both
- # control task attempts however they control how tasks are
- # attempted in different ways:
- #
- # * rate_limits controls the total rate of
- # dispatches from a queue (i.e. all traffic dispatched from the
- # queue, regardless of whether the dispatch is from a first
- # attempt or a retry).
- # * retry_config controls what happens to
- # particular a task after its first attempt fails. That is,
- # retry_config controls task retries (the
- # second attempt, third attempt, etc).
- #
- # 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.
- "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
- # to be dispatched for this queue. After this threshold has been
- # reached, Cloud Tasks stops dispatching tasks until the number of
- # concurrent requests decreases.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- #
- # The maximum allowed value is 5,000.
- #
- # This field is output only for
- # pull queues and always -1, which indicates no limit. No other
- # queue types can have `max_concurrent_tasks` set to -1.
- #
- #
- # This field has the same meaning as
- # [max_concurrent_requests in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
- "maxBurstSize": 42, # Output only. The max burst size.
- #
- # Max burst size limits how fast tasks in queue are processed when
- # many tasks are in the queue and the rate is high. This field
- # allows the queue to have a high rate so processing starts shortly
- # after a task is enqueued, but still limits resource usage when
- # many tasks are enqueued in a short period of time.
- #
- # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
- # algorithm is used to control the rate of task dispatches. Each
- # queue has a token bucket that holds tokens, up to the maximum
- # specified by `max_burst_size`. Each time a task is dispatched, a
- # token is removed from the bucket. Tasks will be dispatched until
- # the queue's bucket runs out of tokens. The bucket will be
- # continuously refilled with new tokens based on
- # max_tasks_dispatched_per_second.
- #
- # Cloud Tasks will pick the value of `max_burst_size` based on the
- # value of
- # max_tasks_dispatched_per_second.
- #
- # For App Engine queues that were created or updated using
- # `queue.yaml/xml`, `max_burst_size` is equal to
- # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
- # Since `max_burst_size` is output only, if
- # UpdateQueue is called on a queue
- # created by `queue.yaml/xml`, `max_burst_size` will be reset based
- # on the value of
- # max_tasks_dispatched_per_second,
- # regardless of whether
- # max_tasks_dispatched_per_second
- # is updated.
- "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- # * For App Engine queues, the maximum allowed value
- # is 500.
- # * This field is output only for pull queues. In addition to the
- # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
- # LeaseTasks requests are allowed per pull queue.
- #
- #
- # This field has the same meaning as
- # [rate in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
- },
- "appEngineHttpTarget": { # App Engine HTTP target. # App Engine HTTP target.
+ "appEngineHttpTarget": { # App Engine HTTP target. # App Engine HTTP target.
#
# An App Engine queue is a queue that has an AppEngineHttpTarget.
#
# 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.
+ # task's host URL is constructed.
#
# Using AppEngineHttpTarget requires
# [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
@@ -1753,7 +1656,7 @@
# and the following scope:
#
# `https://www.googleapis.com/auth/cloud-platform`
- "appEngineRoutingOverride": { # App Engine Routing. # Overrides for the
+ "appEngineRoutingOverride": { # App Engine Routing. # Overrides for the
# task-level app_engine_routing.
#
# If set, `app_engine_routing_override` is used for all tasks in
@@ -1772,7 +1675,7 @@
# 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).
- "instance": "A String", # App instance.
+ "instance": "A String", # App instance.
#
# By default, the task is sent to an instance which is available when
# the task is attempted.
@@ -1785,7 +1688,23 @@
# 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).
- "host": "A String", # Output only. The host that the task is sent to.
+ "version": "A String", # App version.
+ #
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
+ #
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
#
# For more information, see
# [How Requests are
@@ -1795,17 +1714,17 @@
#
#
# * `host = [application_domain_name]`</br>
- # `| [service] + '.' + [application_domain_name]`</br>
- # `| [version] + '.' + [application_domain_name]`</br>
- # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
- # `| [instance] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
+ # `| [service] + '.' + [application_domain_name]`</br>
+ # `| [version] + '.' + [application_domain_name]`</br>
+ # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
+ # `| [instance] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
#
# * `application_domain_name` = The domain name of the app, for
# example <app-id>.appspot.com, which is associated with the
- # queue's project ID. Some tasks which were created using the App Engine
+ # queue's project ID. Some tasks which were created using the App Engine
# SDK use a custom domain name.
#
# * `service =` service
@@ -1813,22 +1732,22 @@
# * `version =` version
#
# * `version_dot_service =`
- # version `+ '.' +`
+ # version `+ '.' +`
# service
#
# * `instance =` instance
#
# * `instance_dot_service =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# service
#
# * `instance_dot_version =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# version
#
# * `instance_dot_version_dot_service =`
- # instance `+ '.' +`
- # version `+ '.' +`
+ # instance `+ '.' +`
+ # version `+ '.' +`
# service
#
# If service is empty, then the task will be sent
@@ -1846,23 +1765,7 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "version": "A String", # App version.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "service": "A String", # App service.
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -1880,18 +1783,7 @@
# instance are the empty string.
},
},
- "pullTarget": { # Pull target. # Pull target.
- #
- # A pull queue is a queue that has a PullTarget.
- },
- "state": "A String", # Output only. The state of the queue.
- #
- # `state` can only be changed by called
- # PauseQueue,
- # ResumeQueue, or uploading
- # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
- # UpdateQueue cannot be used to change `state`.
- "purgeTime": "A String", # Output only. The last time this queue was purged.
+ "purgeTime": "A String", # Output only. The last time this queue was purged.
#
# All tasks that were created before this time
# were purged.
@@ -1902,7 +1794,14 @@
#
# Purge time will be truncated to the nearest microsecond. Purge
# time will be unset if the queue has never been purged.
- "retryConfig": { # Retry config. # Settings that determine the retry behavior.
+ "state": "A String", # Output only. The state of the queue.
+ #
+ # `state` can only be changed by called
+ # PauseQueue,
+ # ResumeQueue, or uploading
+ # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
+ # UpdateQueue cannot be used to change `state`.
+ "retryConfig": { # Retry config. # Settings that determine the retry behavior.
#
# * For tasks created using Cloud Tasks: the queue-level retry settings
# apply to all tasks in the queue that were created using Cloud Tasks.
@@ -1914,9 +1813,63 @@
# documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
#
# These settings determine how a failed task attempt is retried.
- "maxDoublings": 42, # The time between retries will double `max_doublings` times.
+ "minBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
#
- # A task's retry interval starts at
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `min_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [min_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [max_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ # retrying a failed task, measured from when the task was first
+ # attempted. Once `max_retry_duration` time has passed *and* the
+ # task has been attempted max_attempts
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_retry_duration` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [task_age_limit in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxDoublings": 42, # The time between retries will double `max_doublings` times.
+ #
+ # A task's retry interval starts at
# min_backoff, then doubles
# `max_doublings` times, then increases linearly, and finally
# retries at intervals of
@@ -1942,69 +1895,135 @@
# This field has the same meaning as
# [max_doublings in
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
- "maxAttempts": 42, # The maximum number of attempts for a task.
+ "maxAttempts": 42, # The maximum number of attempts for a task.
#
# Cloud Tasks will attempt the task `max_attempts` times (that
# is, if the first attempt fails, then there will be
# `max_attempts - 1` retries). Must be > 0.
- "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
- # retrying a failed task, measured from when the task was first
- # attempted. Once `max_retry_duration` time has passed *and* the
- # task has been attempted max_attempts
- # times, no further attempts will be made and the task will be
- # deleted.
- #
- # If zero, then the task age is unlimited.
+ "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
+ },
+ "name": "A String", # Caller-specified and required in CreateQueue,
+ # after which it becomes output only.
+ #
+ # The queue name.
+ #
+ # The queue name must have the following format:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the queue's location.
+ # The list of available locations can be obtained by calling
+ # 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.
+ "rateLimits": { # Rate limits. # Rate limits for task dispatches.
+ #
+ # rate_limits and
+ # retry_config are related because they both
+ # control task attempts however they control how tasks are
+ # attempted in different ways:
+ #
+ # * rate_limits controls the total rate of
+ # dispatches from a queue (i.e. all traffic dispatched from the
+ # queue, regardless of whether the dispatch is from a first
+ # attempt or a retry).
+ # * retry_config controls what happens to
+ # particular a task after its first attempt fails. That is,
+ # retry_config controls task retries (the
+ # second attempt, third attempt, etc).
+ #
+ # 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.
+ "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
+ # to be dispatched for this queue. After this threshold has been
+ # reached, Cloud Tasks stops dispatching tasks until the number of
+ # concurrent requests decreases.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # This field is output only for pull queues.
#
+ # The maximum allowed value is 5,000.
#
- # `max_retry_duration` will be truncated to the nearest second.
+ # This field is output only for
+ # pull queues and always -1, which indicates no limit. No other
+ # queue types can have `max_concurrent_tasks` set to -1.
+ #
#
# This field has the same meaning as
- # [task_age_limit in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "minBackoff": "A String", # A task will be scheduled for retry between
- # min_backoff and
- # max_backoff duration after it fails,
- # if the queue's RetryConfig specifies that the task should be
- # retried.
+ # [max_concurrent_requests in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
+ "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # This field is output only for pull queues.
+ # * For App Engine queues, the maximum allowed value
+ # is 500.
+ # * This field is output only for pull queues. In addition to the
+ # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
+ # LeaseTasks requests are allowed per pull queue.
#
#
- # `min_backoff` will be truncated to the nearest second.
- #
# This field has the same meaning as
- # [min_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxBackoff": "A String", # A task will be scheduled for retry between
- # min_backoff and
- # max_backoff duration after it fails,
- # if the queue's RetryConfig specifies that the task should be
- # retried.
+ # [rate in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
+ "maxBurstSize": 42, # Output only. The max burst size.
#
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
+ # Max burst size limits how fast tasks in queue are processed when
+ # many tasks are in the queue and the rate is high. This field
+ # allows the queue to have a high rate so processing starts shortly
+ # after a task is enqueued, but still limits resource usage when
+ # many tasks are enqueued in a short period of time.
#
- # This field is output only for pull queues.
+ # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
+ # algorithm is used to control the rate of task dispatches. Each
+ # queue has a token bucket that holds tokens, up to the maximum
+ # specified by `max_burst_size`. Each time a task is dispatched, a
+ # token is removed from the bucket. Tasks will be dispatched until
+ # the queue's bucket runs out of tokens. The bucket will be
+ # continuously refilled with new tokens based on
+ # max_tasks_dispatched_per_second.
#
+ # Cloud Tasks will pick the value of `max_burst_size` based on the
+ # value of
+ # max_tasks_dispatched_per_second.
#
- # `max_backoff` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [max_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ # For App Engine queues that were created or updated using
+ # `queue.yaml/xml`, `max_burst_size` is equal to
+ # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
+ # Since `max_burst_size` is output only, if
+ # UpdateQueue is called on a queue
+ # created by `queue.yaml/xml`, `max_burst_size` will be reset based
+ # on the value of
+ # max_tasks_dispatched_per_second,
+ # regardless of whether
+ # max_tasks_dispatched_per_second
+ # is updated.
+ },
+ "pullTarget": { # Pull target. # Pull target.
+ #
+ # A pull queue is a queue that has a PullTarget.
},
},
],
+ "nextPageToken": "A String", # A token to retrieve next page of results.
+ #
+ # To return the next page of results, call
+ # ListQueues with this value as the
+ # page_token.
+ #
+ # If the next_page_token is empty, there are no more results.
+ #
+ # The page token is valid for only 2 hours.
}</pre>
</div>
@@ -2017,7 +2036,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
@@ -2054,7 +2073,7 @@
For more information, see
[Identifying
projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
-* `LOCATION_ID` is the canonical ID for the queue's location.
+* `LOCATION_ID` is the canonical ID for the queue's location.
The list of available locations can be obtained by calling
ListLocations.
For more information, see https://cloud.google.com/about/locations/.
@@ -2066,121 +2085,14 @@
{ # 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.
- "name": "A String", # Caller-specified and required in CreateQueue,
- # after which it becomes output only.
- #
- # The queue name.
- #
- # The queue name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the queue's location.
- # The list of available locations can be obtained by calling
- # 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.
- "rateLimits": { # Rate limits. # Rate limits for task dispatches.
- #
- # rate_limits and
- # retry_config are related because they both
- # control task attempts however they control how tasks are
- # attempted in different ways:
- #
- # * rate_limits controls the total rate of
- # dispatches from a queue (i.e. all traffic dispatched from the
- # queue, regardless of whether the dispatch is from a first
- # attempt or a retry).
- # * retry_config controls what happens to
- # particular a task after its first attempt fails. That is,
- # retry_config controls task retries (the
- # second attempt, third attempt, etc).
- #
- # 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.
- "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
- # to be dispatched for this queue. After this threshold has been
- # reached, Cloud Tasks stops dispatching tasks until the number of
- # concurrent requests decreases.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- #
- # The maximum allowed value is 5,000.
- #
- # This field is output only for
- # pull queues and always -1, which indicates no limit. No other
- # queue types can have `max_concurrent_tasks` set to -1.
- #
- #
- # This field has the same meaning as
- # [max_concurrent_requests in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
- "maxBurstSize": 42, # Output only. The max burst size.
- #
- # Max burst size limits how fast tasks in queue are processed when
- # many tasks are in the queue and the rate is high. This field
- # allows the queue to have a high rate so processing starts shortly
- # after a task is enqueued, but still limits resource usage when
- # many tasks are enqueued in a short period of time.
- #
- # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
- # algorithm is used to control the rate of task dispatches. Each
- # queue has a token bucket that holds tokens, up to the maximum
- # specified by `max_burst_size`. Each time a task is dispatched, a
- # token is removed from the bucket. Tasks will be dispatched until
- # the queue's bucket runs out of tokens. The bucket will be
- # continuously refilled with new tokens based on
- # max_tasks_dispatched_per_second.
- #
- # Cloud Tasks will pick the value of `max_burst_size` based on the
- # value of
- # max_tasks_dispatched_per_second.
- #
- # For App Engine queues that were created or updated using
- # `queue.yaml/xml`, `max_burst_size` is equal to
- # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
- # Since `max_burst_size` is output only, if
- # UpdateQueue is called on a queue
- # created by `queue.yaml/xml`, `max_burst_size` will be reset based
- # on the value of
- # max_tasks_dispatched_per_second,
- # regardless of whether
- # max_tasks_dispatched_per_second
- # is updated.
- "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- # * For App Engine queues, the maximum allowed value
- # is 500.
- # * This field is output only for pull queues. In addition to the
- # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
- # LeaseTasks requests are allowed per pull queue.
- #
- #
- # This field has the same meaning as
- # [rate in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
- },
- "appEngineHttpTarget": { # App Engine HTTP target. # App Engine HTTP target.
+ "appEngineHttpTarget": { # App Engine HTTP target. # App Engine HTTP target.
#
# An App Engine queue is a queue that has an AppEngineHttpTarget.
#
# 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.
+ # task's host URL is constructed.
#
# Using AppEngineHttpTarget requires
# [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
@@ -2188,7 +2100,7 @@
# and the following scope:
#
# `https://www.googleapis.com/auth/cloud-platform`
- "appEngineRoutingOverride": { # App Engine Routing. # Overrides for the
+ "appEngineRoutingOverride": { # App Engine Routing. # Overrides for the
# task-level app_engine_routing.
#
# If set, `app_engine_routing_override` is used for all tasks in
@@ -2207,7 +2119,7 @@
# 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).
- "instance": "A String", # App instance.
+ "instance": "A String", # App instance.
#
# By default, the task is sent to an instance which is available when
# the task is attempted.
@@ -2220,7 +2132,23 @@
# 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).
- "host": "A String", # Output only. The host that the task is sent to.
+ "version": "A String", # App version.
+ #
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
+ #
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
#
# For more information, see
# [How Requests are
@@ -2230,17 +2158,17 @@
#
#
# * `host = [application_domain_name]`</br>
- # `| [service] + '.' + [application_domain_name]`</br>
- # `| [version] + '.' + [application_domain_name]`</br>
- # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
- # `| [instance] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
+ # `| [service] + '.' + [application_domain_name]`</br>
+ # `| [version] + '.' + [application_domain_name]`</br>
+ # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
+ # `| [instance] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
#
# * `application_domain_name` = The domain name of the app, for
# example <app-id>.appspot.com, which is associated with the
- # queue's project ID. Some tasks which were created using the App Engine
+ # queue's project ID. Some tasks which were created using the App Engine
# SDK use a custom domain name.
#
# * `service =` service
@@ -2248,22 +2176,22 @@
# * `version =` version
#
# * `version_dot_service =`
- # version `+ '.' +`
+ # version `+ '.' +`
# service
#
# * `instance =` instance
#
# * `instance_dot_service =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# service
#
# * `instance_dot_version =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# version
#
# * `instance_dot_version_dot_service =`
- # instance `+ '.' +`
- # version `+ '.' +`
+ # instance `+ '.' +`
+ # version `+ '.' +`
# service
#
# If service is empty, then the task will be sent
@@ -2281,23 +2209,7 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "version": "A String", # App version.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "service": "A String", # App service.
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -2315,18 +2227,7 @@
# instance are the empty string.
},
},
- "pullTarget": { # Pull target. # Pull target.
- #
- # A pull queue is a queue that has a PullTarget.
- },
- "state": "A String", # Output only. The state of the queue.
- #
- # `state` can only be changed by called
- # PauseQueue,
- # ResumeQueue, or uploading
- # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
- # UpdateQueue cannot be used to change `state`.
- "purgeTime": "A String", # Output only. The last time this queue was purged.
+ "purgeTime": "A String", # Output only. The last time this queue was purged.
#
# All tasks that were created before this time
# were purged.
@@ -2337,7 +2238,14 @@
#
# Purge time will be truncated to the nearest microsecond. Purge
# time will be unset if the queue has never been purged.
- "retryConfig": { # Retry config. # Settings that determine the retry behavior.
+ "state": "A String", # Output only. The state of the queue.
+ #
+ # `state` can only be changed by called
+ # PauseQueue,
+ # ResumeQueue, or uploading
+ # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
+ # UpdateQueue cannot be used to change `state`.
+ "retryConfig": { # Retry config. # Settings that determine the retry behavior.
#
# * For tasks created using Cloud Tasks: the queue-level retry settings
# apply to all tasks in the queue that were created using Cloud Tasks.
@@ -2349,9 +2257,63 @@
# documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
#
# These settings determine how a failed task attempt is retried.
- "maxDoublings": 42, # The time between retries will double `max_doublings` times.
+ "minBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
#
- # A task's retry interval starts at
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `min_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [min_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [max_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ # retrying a failed task, measured from when the task was first
+ # attempted. Once `max_retry_duration` time has passed *and* the
+ # task has been attempted max_attempts
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_retry_duration` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [task_age_limit in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxDoublings": 42, # The time between retries will double `max_doublings` times.
+ #
+ # A task's retry interval starts at
# min_backoff, then doubles
# `max_doublings` times, then increases linearly, and finally
# retries at intervals of
@@ -2377,66 +2339,123 @@
# This field has the same meaning as
# [max_doublings in
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
- "maxAttempts": 42, # The maximum number of attempts for a task.
+ "maxAttempts": 42, # The maximum number of attempts for a task.
#
# Cloud Tasks will attempt the task `max_attempts` times (that
# is, if the first attempt fails, then there will be
# `max_attempts - 1` retries). Must be > 0.
- "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
- # retrying a failed task, measured from when the task was first
- # attempted. Once `max_retry_duration` time has passed *and* the
- # task has been attempted max_attempts
- # times, no further attempts will be made and the task will be
- # deleted.
- #
- # If zero, then the task age is unlimited.
+ "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
+ },
+ "name": "A String", # Caller-specified and required in CreateQueue,
+ # after which it becomes output only.
+ #
+ # The queue name.
+ #
+ # The queue name must have the following format:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the queue's location.
+ # The list of available locations can be obtained by calling
+ # 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.
+ "rateLimits": { # Rate limits. # Rate limits for task dispatches.
+ #
+ # rate_limits and
+ # retry_config are related because they both
+ # control task attempts however they control how tasks are
+ # attempted in different ways:
+ #
+ # * rate_limits controls the total rate of
+ # dispatches from a queue (i.e. all traffic dispatched from the
+ # queue, regardless of whether the dispatch is from a first
+ # attempt or a retry).
+ # * retry_config controls what happens to
+ # particular a task after its first attempt fails. That is,
+ # retry_config controls task retries (the
+ # second attempt, third attempt, etc).
+ #
+ # 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.
+ "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
+ # to be dispatched for this queue. After this threshold has been
+ # reached, Cloud Tasks stops dispatching tasks until the number of
+ # concurrent requests decreases.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # This field is output only for pull queues.
#
+ # The maximum allowed value is 5,000.
#
- # `max_retry_duration` will be truncated to the nearest second.
+ # This field is output only for
+ # pull queues and always -1, which indicates no limit. No other
+ # queue types can have `max_concurrent_tasks` set to -1.
+ #
#
# This field has the same meaning as
- # [task_age_limit in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "minBackoff": "A String", # A task will be scheduled for retry between
- # min_backoff and
- # max_backoff duration after it fails,
- # if the queue's RetryConfig specifies that the task should be
- # retried.
+ # [max_concurrent_requests in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
+ "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # This field is output only for pull queues.
+ # * For App Engine queues, the maximum allowed value
+ # is 500.
+ # * This field is output only for pull queues. In addition to the
+ # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
+ # LeaseTasks requests are allowed per pull queue.
#
#
- # `min_backoff` will be truncated to the nearest second.
- #
# This field has the same meaning as
- # [min_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxBackoff": "A String", # A task will be scheduled for retry between
- # min_backoff and
- # max_backoff duration after it fails,
- # if the queue's RetryConfig specifies that the task should be
- # retried.
+ # [rate in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
+ "maxBurstSize": 42, # Output only. The max burst size.
#
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
+ # Max burst size limits how fast tasks in queue are processed when
+ # many tasks are in the queue and the rate is high. This field
+ # allows the queue to have a high rate so processing starts shortly
+ # after a task is enqueued, but still limits resource usage when
+ # many tasks are enqueued in a short period of time.
#
- # This field is output only for pull queues.
+ # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
+ # algorithm is used to control the rate of task dispatches. Each
+ # queue has a token bucket that holds tokens, up to the maximum
+ # specified by `max_burst_size`. Each time a task is dispatched, a
+ # token is removed from the bucket. Tasks will be dispatched until
+ # the queue's bucket runs out of tokens. The bucket will be
+ # continuously refilled with new tokens based on
+ # max_tasks_dispatched_per_second.
#
+ # Cloud Tasks will pick the value of `max_burst_size` based on the
+ # value of
+ # max_tasks_dispatched_per_second.
#
- # `max_backoff` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [max_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ # For App Engine queues that were created or updated using
+ # `queue.yaml/xml`, `max_burst_size` is equal to
+ # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
+ # Since `max_burst_size` is output only, if
+ # UpdateQueue is called on a queue
+ # created by `queue.yaml/xml`, `max_burst_size` will be reset based
+ # on the value of
+ # max_tasks_dispatched_per_second,
+ # regardless of whether
+ # max_tasks_dispatched_per_second
+ # is updated.
+ },
+ "pullTarget": { # Pull target. # Pull target.
+ #
+ # A pull queue is a queue that has a PullTarget.
},
}
@@ -2454,121 +2473,14 @@
{ # 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.
- "name": "A String", # Caller-specified and required in CreateQueue,
- # after which it becomes output only.
- #
- # The queue name.
- #
- # The queue name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the queue's location.
- # The list of available locations can be obtained by calling
- # 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.
- "rateLimits": { # Rate limits. # Rate limits for task dispatches.
- #
- # rate_limits and
- # retry_config are related because they both
- # control task attempts however they control how tasks are
- # attempted in different ways:
- #
- # * rate_limits controls the total rate of
- # dispatches from a queue (i.e. all traffic dispatched from the
- # queue, regardless of whether the dispatch is from a first
- # attempt or a retry).
- # * retry_config controls what happens to
- # particular a task after its first attempt fails. That is,
- # retry_config controls task retries (the
- # second attempt, third attempt, etc).
- #
- # 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.
- "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
- # to be dispatched for this queue. After this threshold has been
- # reached, Cloud Tasks stops dispatching tasks until the number of
- # concurrent requests decreases.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- #
- # The maximum allowed value is 5,000.
- #
- # This field is output only for
- # pull queues and always -1, which indicates no limit. No other
- # queue types can have `max_concurrent_tasks` set to -1.
- #
- #
- # This field has the same meaning as
- # [max_concurrent_requests in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
- "maxBurstSize": 42, # Output only. The max burst size.
- #
- # Max burst size limits how fast tasks in queue are processed when
- # many tasks are in the queue and the rate is high. This field
- # allows the queue to have a high rate so processing starts shortly
- # after a task is enqueued, but still limits resource usage when
- # many tasks are enqueued in a short period of time.
- #
- # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
- # algorithm is used to control the rate of task dispatches. Each
- # queue has a token bucket that holds tokens, up to the maximum
- # specified by `max_burst_size`. Each time a task is dispatched, a
- # token is removed from the bucket. Tasks will be dispatched until
- # the queue's bucket runs out of tokens. The bucket will be
- # continuously refilled with new tokens based on
- # max_tasks_dispatched_per_second.
- #
- # Cloud Tasks will pick the value of `max_burst_size` based on the
- # value of
- # max_tasks_dispatched_per_second.
- #
- # For App Engine queues that were created or updated using
- # `queue.yaml/xml`, `max_burst_size` is equal to
- # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
- # Since `max_burst_size` is output only, if
- # UpdateQueue is called on a queue
- # created by `queue.yaml/xml`, `max_burst_size` will be reset based
- # on the value of
- # max_tasks_dispatched_per_second,
- # regardless of whether
- # max_tasks_dispatched_per_second
- # is updated.
- "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- # * For App Engine queues, the maximum allowed value
- # is 500.
- # * This field is output only for pull queues. In addition to the
- # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
- # LeaseTasks requests are allowed per pull queue.
- #
- #
- # This field has the same meaning as
- # [rate in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
- },
- "appEngineHttpTarget": { # App Engine HTTP target. # App Engine HTTP target.
+ "appEngineHttpTarget": { # App Engine HTTP target. # App Engine HTTP target.
#
# An App Engine queue is a queue that has an AppEngineHttpTarget.
#
# 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.
+ # task's host URL is constructed.
#
# Using AppEngineHttpTarget requires
# [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
@@ -2576,7 +2488,7 @@
# and the following scope:
#
# `https://www.googleapis.com/auth/cloud-platform`
- "appEngineRoutingOverride": { # App Engine Routing. # Overrides for the
+ "appEngineRoutingOverride": { # App Engine Routing. # Overrides for the
# task-level app_engine_routing.
#
# If set, `app_engine_routing_override` is used for all tasks in
@@ -2595,7 +2507,7 @@
# 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).
- "instance": "A String", # App instance.
+ "instance": "A String", # App instance.
#
# By default, the task is sent to an instance which is available when
# the task is attempted.
@@ -2608,7 +2520,23 @@
# 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).
- "host": "A String", # Output only. The host that the task is sent to.
+ "version": "A String", # App version.
+ #
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
+ #
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
#
# For more information, see
# [How Requests are
@@ -2618,17 +2546,17 @@
#
#
# * `host = [application_domain_name]`</br>
- # `| [service] + '.' + [application_domain_name]`</br>
- # `| [version] + '.' + [application_domain_name]`</br>
- # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
- # `| [instance] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
+ # `| [service] + '.' + [application_domain_name]`</br>
+ # `| [version] + '.' + [application_domain_name]`</br>
+ # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
+ # `| [instance] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
#
# * `application_domain_name` = The domain name of the app, for
# example <app-id>.appspot.com, which is associated with the
- # queue's project ID. Some tasks which were created using the App Engine
+ # queue's project ID. Some tasks which were created using the App Engine
# SDK use a custom domain name.
#
# * `service =` service
@@ -2636,22 +2564,22 @@
# * `version =` version
#
# * `version_dot_service =`
- # version `+ '.' +`
+ # version `+ '.' +`
# service
#
# * `instance =` instance
#
# * `instance_dot_service =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# service
#
# * `instance_dot_version =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# version
#
# * `instance_dot_version_dot_service =`
- # instance `+ '.' +`
- # version `+ '.' +`
+ # instance `+ '.' +`
+ # version `+ '.' +`
# service
#
# If service is empty, then the task will be sent
@@ -2669,23 +2597,7 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "version": "A String", # App version.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "service": "A String", # App service.
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -2703,18 +2615,7 @@
# instance are the empty string.
},
},
- "pullTarget": { # Pull target. # Pull target.
- #
- # A pull queue is a queue that has a PullTarget.
- },
- "state": "A String", # Output only. The state of the queue.
- #
- # `state` can only be changed by called
- # PauseQueue,
- # ResumeQueue, or uploading
- # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
- # UpdateQueue cannot be used to change `state`.
- "purgeTime": "A String", # Output only. The last time this queue was purged.
+ "purgeTime": "A String", # Output only. The last time this queue was purged.
#
# All tasks that were created before this time
# were purged.
@@ -2725,7 +2626,14 @@
#
# Purge time will be truncated to the nearest microsecond. Purge
# time will be unset if the queue has never been purged.
- "retryConfig": { # Retry config. # Settings that determine the retry behavior.
+ "state": "A String", # Output only. The state of the queue.
+ #
+ # `state` can only be changed by called
+ # PauseQueue,
+ # ResumeQueue, or uploading
+ # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
+ # UpdateQueue cannot be used to change `state`.
+ "retryConfig": { # Retry config. # Settings that determine the retry behavior.
#
# * For tasks created using Cloud Tasks: the queue-level retry settings
# apply to all tasks in the queue that were created using Cloud Tasks.
@@ -2737,9 +2645,63 @@
# documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
#
# These settings determine how a failed task attempt is retried.
- "maxDoublings": 42, # The time between retries will double `max_doublings` times.
+ "minBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
#
- # A task's retry interval starts at
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `min_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [min_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [max_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ # retrying a failed task, measured from when the task was first
+ # attempted. Once `max_retry_duration` time has passed *and* the
+ # task has been attempted max_attempts
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_retry_duration` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [task_age_limit in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxDoublings": 42, # The time between retries will double `max_doublings` times.
+ #
+ # A task's retry interval starts at
# min_backoff, then doubles
# `max_doublings` times, then increases linearly, and finally
# retries at intervals of
@@ -2765,66 +2727,123 @@
# This field has the same meaning as
# [max_doublings in
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
- "maxAttempts": 42, # The maximum number of attempts for a task.
+ "maxAttempts": 42, # The maximum number of attempts for a task.
#
# Cloud Tasks will attempt the task `max_attempts` times (that
# is, if the first attempt fails, then there will be
# `max_attempts - 1` retries). Must be > 0.
- "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
- # retrying a failed task, measured from when the task was first
- # attempted. Once `max_retry_duration` time has passed *and* the
- # task has been attempted max_attempts
- # times, no further attempts will be made and the task will be
- # deleted.
- #
- # If zero, then the task age is unlimited.
+ "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
+ },
+ "name": "A String", # Caller-specified and required in CreateQueue,
+ # after which it becomes output only.
+ #
+ # The queue name.
+ #
+ # The queue name must have the following format:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the queue's location.
+ # The list of available locations can be obtained by calling
+ # 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.
+ "rateLimits": { # Rate limits. # Rate limits for task dispatches.
+ #
+ # rate_limits and
+ # retry_config are related because they both
+ # control task attempts however they control how tasks are
+ # attempted in different ways:
+ #
+ # * rate_limits controls the total rate of
+ # dispatches from a queue (i.e. all traffic dispatched from the
+ # queue, regardless of whether the dispatch is from a first
+ # attempt or a retry).
+ # * retry_config controls what happens to
+ # particular a task after its first attempt fails. That is,
+ # retry_config controls task retries (the
+ # second attempt, third attempt, etc).
+ #
+ # 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.
+ "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
+ # to be dispatched for this queue. After this threshold has been
+ # reached, Cloud Tasks stops dispatching tasks until the number of
+ # concurrent requests decreases.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # This field is output only for pull queues.
#
+ # The maximum allowed value is 5,000.
#
- # `max_retry_duration` will be truncated to the nearest second.
+ # This field is output only for
+ # pull queues and always -1, which indicates no limit. No other
+ # queue types can have `max_concurrent_tasks` set to -1.
+ #
#
# This field has the same meaning as
- # [task_age_limit in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "minBackoff": "A String", # A task will be scheduled for retry between
- # min_backoff and
- # max_backoff duration after it fails,
- # if the queue's RetryConfig specifies that the task should be
- # retried.
+ # [max_concurrent_requests in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
+ "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # This field is output only for pull queues.
+ # * For App Engine queues, the maximum allowed value
+ # is 500.
+ # * This field is output only for pull queues. In addition to the
+ # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
+ # LeaseTasks requests are allowed per pull queue.
#
#
- # `min_backoff` will be truncated to the nearest second.
- #
# This field has the same meaning as
- # [min_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxBackoff": "A String", # A task will be scheduled for retry between
- # min_backoff and
- # max_backoff duration after it fails,
- # if the queue's RetryConfig specifies that the task should be
- # retried.
+ # [rate in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
+ "maxBurstSize": 42, # Output only. The max burst size.
#
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
+ # Max burst size limits how fast tasks in queue are processed when
+ # many tasks are in the queue and the rate is high. This field
+ # allows the queue to have a high rate so processing starts shortly
+ # after a task is enqueued, but still limits resource usage when
+ # many tasks are enqueued in a short period of time.
#
- # This field is output only for pull queues.
+ # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
+ # algorithm is used to control the rate of task dispatches. Each
+ # queue has a token bucket that holds tokens, up to the maximum
+ # specified by `max_burst_size`. Each time a task is dispatched, a
+ # token is removed from the bucket. Tasks will be dispatched until
+ # the queue's bucket runs out of tokens. The bucket will be
+ # continuously refilled with new tokens based on
+ # max_tasks_dispatched_per_second.
#
+ # Cloud Tasks will pick the value of `max_burst_size` based on the
+ # value of
+ # max_tasks_dispatched_per_second.
#
- # `max_backoff` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [max_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ # For App Engine queues that were created or updated using
+ # `queue.yaml/xml`, `max_burst_size` is equal to
+ # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
+ # Since `max_burst_size` is output only, if
+ # UpdateQueue is called on a queue
+ # created by `queue.yaml/xml`, `max_burst_size` will be reset based
+ # on the value of
+ # max_tasks_dispatched_per_second,
+ # regardless of whether
+ # max_tasks_dispatched_per_second
+ # is updated.
+ },
+ "pullTarget": { # Pull target. # Pull target.
+ #
+ # A pull queue is a queue that has a PullTarget.
},
}</pre>
</div>
@@ -2859,121 +2878,14 @@
{ # 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.
- "name": "A String", # Caller-specified and required in CreateQueue,
- # after which it becomes output only.
- #
- # The queue name.
- #
- # The queue name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the queue's location.
- # The list of available locations can be obtained by calling
- # 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.
- "rateLimits": { # Rate limits. # Rate limits for task dispatches.
- #
- # rate_limits and
- # retry_config are related because they both
- # control task attempts however they control how tasks are
- # attempted in different ways:
- #
- # * rate_limits controls the total rate of
- # dispatches from a queue (i.e. all traffic dispatched from the
- # queue, regardless of whether the dispatch is from a first
- # attempt or a retry).
- # * retry_config controls what happens to
- # particular a task after its first attempt fails. That is,
- # retry_config controls task retries (the
- # second attempt, third attempt, etc).
- #
- # 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.
- "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
- # to be dispatched for this queue. After this threshold has been
- # reached, Cloud Tasks stops dispatching tasks until the number of
- # concurrent requests decreases.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- #
- # The maximum allowed value is 5,000.
- #
- # This field is output only for
- # pull queues and always -1, which indicates no limit. No other
- # queue types can have `max_concurrent_tasks` set to -1.
- #
- #
- # This field has the same meaning as
- # [max_concurrent_requests in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
- "maxBurstSize": 42, # Output only. The max burst size.
- #
- # Max burst size limits how fast tasks in queue are processed when
- # many tasks are in the queue and the rate is high. This field
- # allows the queue to have a high rate so processing starts shortly
- # after a task is enqueued, but still limits resource usage when
- # many tasks are enqueued in a short period of time.
- #
- # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
- # algorithm is used to control the rate of task dispatches. Each
- # queue has a token bucket that holds tokens, up to the maximum
- # specified by `max_burst_size`. Each time a task is dispatched, a
- # token is removed from the bucket. Tasks will be dispatched until
- # the queue's bucket runs out of tokens. The bucket will be
- # continuously refilled with new tokens based on
- # max_tasks_dispatched_per_second.
- #
- # Cloud Tasks will pick the value of `max_burst_size` based on the
- # value of
- # max_tasks_dispatched_per_second.
- #
- # For App Engine queues that were created or updated using
- # `queue.yaml/xml`, `max_burst_size` is equal to
- # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
- # Since `max_burst_size` is output only, if
- # UpdateQueue is called on a queue
- # created by `queue.yaml/xml`, `max_burst_size` will be reset based
- # on the value of
- # max_tasks_dispatched_per_second,
- # regardless of whether
- # max_tasks_dispatched_per_second
- # is updated.
- "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- # * For App Engine queues, the maximum allowed value
- # is 500.
- # * This field is output only for pull queues. In addition to the
- # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
- # LeaseTasks requests are allowed per pull queue.
- #
- #
- # This field has the same meaning as
- # [rate in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
- },
- "appEngineHttpTarget": { # App Engine HTTP target. # App Engine HTTP target.
+ "appEngineHttpTarget": { # App Engine HTTP target. # App Engine HTTP target.
#
# An App Engine queue is a queue that has an AppEngineHttpTarget.
#
# 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.
+ # task's host URL is constructed.
#
# Using AppEngineHttpTarget requires
# [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
@@ -2981,7 +2893,7 @@
# and the following scope:
#
# `https://www.googleapis.com/auth/cloud-platform`
- "appEngineRoutingOverride": { # App Engine Routing. # Overrides for the
+ "appEngineRoutingOverride": { # App Engine Routing. # Overrides for the
# task-level app_engine_routing.
#
# If set, `app_engine_routing_override` is used for all tasks in
@@ -3000,7 +2912,7 @@
# 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).
- "instance": "A String", # App instance.
+ "instance": "A String", # App instance.
#
# By default, the task is sent to an instance which is available when
# the task is attempted.
@@ -3013,7 +2925,23 @@
# 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).
- "host": "A String", # Output only. The host that the task is sent to.
+ "version": "A String", # App version.
+ #
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
+ #
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
#
# For more information, see
# [How Requests are
@@ -3023,17 +2951,17 @@
#
#
# * `host = [application_domain_name]`</br>
- # `| [service] + '.' + [application_domain_name]`</br>
- # `| [version] + '.' + [application_domain_name]`</br>
- # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
- # `| [instance] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
+ # `| [service] + '.' + [application_domain_name]`</br>
+ # `| [version] + '.' + [application_domain_name]`</br>
+ # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
+ # `| [instance] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
#
# * `application_domain_name` = The domain name of the app, for
# example <app-id>.appspot.com, which is associated with the
- # queue's project ID. Some tasks which were created using the App Engine
+ # queue's project ID. Some tasks which were created using the App Engine
# SDK use a custom domain name.
#
# * `service =` service
@@ -3041,22 +2969,22 @@
# * `version =` version
#
# * `version_dot_service =`
- # version `+ '.' +`
+ # version `+ '.' +`
# service
#
# * `instance =` instance
#
# * `instance_dot_service =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# service
#
# * `instance_dot_version =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# version
#
# * `instance_dot_version_dot_service =`
- # instance `+ '.' +`
- # version `+ '.' +`
+ # instance `+ '.' +`
+ # version `+ '.' +`
# service
#
# If service is empty, then the task will be sent
@@ -3074,23 +3002,7 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "version": "A String", # App version.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "service": "A String", # App service.
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -3108,18 +3020,7 @@
# instance are the empty string.
},
},
- "pullTarget": { # Pull target. # Pull target.
- #
- # A pull queue is a queue that has a PullTarget.
- },
- "state": "A String", # Output only. The state of the queue.
- #
- # `state` can only be changed by called
- # PauseQueue,
- # ResumeQueue, or uploading
- # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
- # UpdateQueue cannot be used to change `state`.
- "purgeTime": "A String", # Output only. The last time this queue was purged.
+ "purgeTime": "A String", # Output only. The last time this queue was purged.
#
# All tasks that were created before this time
# were purged.
@@ -3130,7 +3031,14 @@
#
# Purge time will be truncated to the nearest microsecond. Purge
# time will be unset if the queue has never been purged.
- "retryConfig": { # Retry config. # Settings that determine the retry behavior.
+ "state": "A String", # Output only. The state of the queue.
+ #
+ # `state` can only be changed by called
+ # PauseQueue,
+ # ResumeQueue, or uploading
+ # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
+ # UpdateQueue cannot be used to change `state`.
+ "retryConfig": { # Retry config. # Settings that determine the retry behavior.
#
# * For tasks created using Cloud Tasks: the queue-level retry settings
# apply to all tasks in the queue that were created using Cloud Tasks.
@@ -3142,9 +3050,63 @@
# documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
#
# These settings determine how a failed task attempt is retried.
- "maxDoublings": 42, # The time between retries will double `max_doublings` times.
+ "minBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
#
- # A task's retry interval starts at
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `min_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [min_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [max_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ # retrying a failed task, measured from when the task was first
+ # attempted. Once `max_retry_duration` time has passed *and* the
+ # task has been attempted max_attempts
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_retry_duration` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [task_age_limit in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxDoublings": 42, # The time between retries will double `max_doublings` times.
+ #
+ # A task's retry interval starts at
# min_backoff, then doubles
# `max_doublings` times, then increases linearly, and finally
# retries at intervals of
@@ -3170,66 +3132,123 @@
# This field has the same meaning as
# [max_doublings in
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
- "maxAttempts": 42, # The maximum number of attempts for a task.
+ "maxAttempts": 42, # The maximum number of attempts for a task.
#
# Cloud Tasks will attempt the task `max_attempts` times (that
# is, if the first attempt fails, then there will be
# `max_attempts - 1` retries). Must be > 0.
- "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
- # retrying a failed task, measured from when the task was first
- # attempted. Once `max_retry_duration` time has passed *and* the
- # task has been attempted max_attempts
- # times, no further attempts will be made and the task will be
- # deleted.
- #
- # If zero, then the task age is unlimited.
+ "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
+ },
+ "name": "A String", # Caller-specified and required in CreateQueue,
+ # after which it becomes output only.
+ #
+ # The queue name.
+ #
+ # The queue name must have the following format:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the queue's location.
+ # The list of available locations can be obtained by calling
+ # 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.
+ "rateLimits": { # Rate limits. # Rate limits for task dispatches.
+ #
+ # rate_limits and
+ # retry_config are related because they both
+ # control task attempts however they control how tasks are
+ # attempted in different ways:
+ #
+ # * rate_limits controls the total rate of
+ # dispatches from a queue (i.e. all traffic dispatched from the
+ # queue, regardless of whether the dispatch is from a first
+ # attempt or a retry).
+ # * retry_config controls what happens to
+ # particular a task after its first attempt fails. That is,
+ # retry_config controls task retries (the
+ # second attempt, third attempt, etc).
+ #
+ # 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.
+ "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
+ # to be dispatched for this queue. After this threshold has been
+ # reached, Cloud Tasks stops dispatching tasks until the number of
+ # concurrent requests decreases.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # This field is output only for pull queues.
#
+ # The maximum allowed value is 5,000.
#
- # `max_retry_duration` will be truncated to the nearest second.
+ # This field is output only for
+ # pull queues and always -1, which indicates no limit. No other
+ # queue types can have `max_concurrent_tasks` set to -1.
+ #
#
# This field has the same meaning as
- # [task_age_limit in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "minBackoff": "A String", # A task will be scheduled for retry between
- # min_backoff and
- # max_backoff duration after it fails,
- # if the queue's RetryConfig specifies that the task should be
- # retried.
+ # [max_concurrent_requests in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
+ "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # This field is output only for pull queues.
+ # * For App Engine queues, the maximum allowed value
+ # is 500.
+ # * This field is output only for pull queues. In addition to the
+ # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
+ # LeaseTasks requests are allowed per pull queue.
#
#
- # `min_backoff` will be truncated to the nearest second.
- #
# This field has the same meaning as
- # [min_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxBackoff": "A String", # A task will be scheduled for retry between
- # min_backoff and
- # max_backoff duration after it fails,
- # if the queue's RetryConfig specifies that the task should be
- # retried.
+ # [rate in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
+ "maxBurstSize": 42, # Output only. The max burst size.
#
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
+ # Max burst size limits how fast tasks in queue are processed when
+ # many tasks are in the queue and the rate is high. This field
+ # allows the queue to have a high rate so processing starts shortly
+ # after a task is enqueued, but still limits resource usage when
+ # many tasks are enqueued in a short period of time.
#
- # This field is output only for pull queues.
+ # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
+ # algorithm is used to control the rate of task dispatches. Each
+ # queue has a token bucket that holds tokens, up to the maximum
+ # specified by `max_burst_size`. Each time a task is dispatched, a
+ # token is removed from the bucket. Tasks will be dispatched until
+ # the queue's bucket runs out of tokens. The bucket will be
+ # continuously refilled with new tokens based on
+ # max_tasks_dispatched_per_second.
#
+ # Cloud Tasks will pick the value of `max_burst_size` based on the
+ # value of
+ # max_tasks_dispatched_per_second.
#
- # `max_backoff` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [max_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ # For App Engine queues that were created or updated using
+ # `queue.yaml/xml`, `max_burst_size` is equal to
+ # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
+ # Since `max_burst_size` is output only, if
+ # UpdateQueue is called on a queue
+ # created by `queue.yaml/xml`, `max_burst_size` will be reset based
+ # on the value of
+ # max_tasks_dispatched_per_second,
+ # regardless of whether
+ # max_tasks_dispatched_per_second
+ # is updated.
+ },
+ "pullTarget": { # Pull target. # Pull target.
+ #
+ # A pull queue is a queue that has a PullTarget.
},
}</pre>
</div>
@@ -3263,121 +3282,14 @@
{ # 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.
- "name": "A String", # Caller-specified and required in CreateQueue,
- # after which it becomes output only.
- #
- # The queue name.
- #
- # The queue name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the queue's location.
- # The list of available locations can be obtained by calling
- # 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.
- "rateLimits": { # Rate limits. # Rate limits for task dispatches.
- #
- # rate_limits and
- # retry_config are related because they both
- # control task attempts however they control how tasks are
- # attempted in different ways:
- #
- # * rate_limits controls the total rate of
- # dispatches from a queue (i.e. all traffic dispatched from the
- # queue, regardless of whether the dispatch is from a first
- # attempt or a retry).
- # * retry_config controls what happens to
- # particular a task after its first attempt fails. That is,
- # retry_config controls task retries (the
- # second attempt, third attempt, etc).
- #
- # 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.
- "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
- # to be dispatched for this queue. After this threshold has been
- # reached, Cloud Tasks stops dispatching tasks until the number of
- # concurrent requests decreases.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- #
- # The maximum allowed value is 5,000.
- #
- # This field is output only for
- # pull queues and always -1, which indicates no limit. No other
- # queue types can have `max_concurrent_tasks` set to -1.
- #
- #
- # This field has the same meaning as
- # [max_concurrent_requests in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
- "maxBurstSize": 42, # Output only. The max burst size.
- #
- # Max burst size limits how fast tasks in queue are processed when
- # many tasks are in the queue and the rate is high. This field
- # allows the queue to have a high rate so processing starts shortly
- # after a task is enqueued, but still limits resource usage when
- # many tasks are enqueued in a short period of time.
- #
- # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
- # algorithm is used to control the rate of task dispatches. Each
- # queue has a token bucket that holds tokens, up to the maximum
- # specified by `max_burst_size`. Each time a task is dispatched, a
- # token is removed from the bucket. Tasks will be dispatched until
- # the queue's bucket runs out of tokens. The bucket will be
- # continuously refilled with new tokens based on
- # max_tasks_dispatched_per_second.
- #
- # Cloud Tasks will pick the value of `max_burst_size` based on the
- # value of
- # max_tasks_dispatched_per_second.
- #
- # For App Engine queues that were created or updated using
- # `queue.yaml/xml`, `max_burst_size` is equal to
- # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
- # Since `max_burst_size` is output only, if
- # UpdateQueue is called on a queue
- # created by `queue.yaml/xml`, `max_burst_size` will be reset based
- # on the value of
- # max_tasks_dispatched_per_second,
- # regardless of whether
- # max_tasks_dispatched_per_second
- # is updated.
- "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- # * For App Engine queues, the maximum allowed value
- # is 500.
- # * This field is output only for pull queues. In addition to the
- # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
- # LeaseTasks requests are allowed per pull queue.
- #
- #
- # This field has the same meaning as
- # [rate in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
- },
- "appEngineHttpTarget": { # App Engine HTTP target. # App Engine HTTP target.
+ "appEngineHttpTarget": { # App Engine HTTP target. # App Engine HTTP target.
#
# An App Engine queue is a queue that has an AppEngineHttpTarget.
#
# 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.
+ # task's host URL is constructed.
#
# Using AppEngineHttpTarget requires
# [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
@@ -3385,7 +3297,7 @@
# and the following scope:
#
# `https://www.googleapis.com/auth/cloud-platform`
- "appEngineRoutingOverride": { # App Engine Routing. # Overrides for the
+ "appEngineRoutingOverride": { # App Engine Routing. # Overrides for the
# task-level app_engine_routing.
#
# If set, `app_engine_routing_override` is used for all tasks in
@@ -3404,7 +3316,7 @@
# 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).
- "instance": "A String", # App instance.
+ "instance": "A String", # App instance.
#
# By default, the task is sent to an instance which is available when
# the task is attempted.
@@ -3417,7 +3329,23 @@
# 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).
- "host": "A String", # Output only. The host that the task is sent to.
+ "version": "A String", # App version.
+ #
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
+ #
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
#
# For more information, see
# [How Requests are
@@ -3427,17 +3355,17 @@
#
#
# * `host = [application_domain_name]`</br>
- # `| [service] + '.' + [application_domain_name]`</br>
- # `| [version] + '.' + [application_domain_name]`</br>
- # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
- # `| [instance] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
+ # `| [service] + '.' + [application_domain_name]`</br>
+ # `| [version] + '.' + [application_domain_name]`</br>
+ # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
+ # `| [instance] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
#
# * `application_domain_name` = The domain name of the app, for
# example <app-id>.appspot.com, which is associated with the
- # queue's project ID. Some tasks which were created using the App Engine
+ # queue's project ID. Some tasks which were created using the App Engine
# SDK use a custom domain name.
#
# * `service =` service
@@ -3445,22 +3373,22 @@
# * `version =` version
#
# * `version_dot_service =`
- # version `+ '.' +`
+ # version `+ '.' +`
# service
#
# * `instance =` instance
#
# * `instance_dot_service =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# service
#
# * `instance_dot_version =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# version
#
# * `instance_dot_version_dot_service =`
- # instance `+ '.' +`
- # version `+ '.' +`
+ # instance `+ '.' +`
+ # version `+ '.' +`
# service
#
# If service is empty, then the task will be sent
@@ -3478,23 +3406,7 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "version": "A String", # App version.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "service": "A String", # App service.
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -3512,18 +3424,7 @@
# instance are the empty string.
},
},
- "pullTarget": { # Pull target. # Pull target.
- #
- # A pull queue is a queue that has a PullTarget.
- },
- "state": "A String", # Output only. The state of the queue.
- #
- # `state` can only be changed by called
- # PauseQueue,
- # ResumeQueue, or uploading
- # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
- # UpdateQueue cannot be used to change `state`.
- "purgeTime": "A String", # Output only. The last time this queue was purged.
+ "purgeTime": "A String", # Output only. The last time this queue was purged.
#
# All tasks that were created before this time
# were purged.
@@ -3534,7 +3435,14 @@
#
# Purge time will be truncated to the nearest microsecond. Purge
# time will be unset if the queue has never been purged.
- "retryConfig": { # Retry config. # Settings that determine the retry behavior.
+ "state": "A String", # Output only. The state of the queue.
+ #
+ # `state` can only be changed by called
+ # PauseQueue,
+ # ResumeQueue, or uploading
+ # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
+ # UpdateQueue cannot be used to change `state`.
+ "retryConfig": { # Retry config. # Settings that determine the retry behavior.
#
# * For tasks created using Cloud Tasks: the queue-level retry settings
# apply to all tasks in the queue that were created using Cloud Tasks.
@@ -3546,9 +3454,63 @@
# documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
#
# These settings determine how a failed task attempt is retried.
- "maxDoublings": 42, # The time between retries will double `max_doublings` times.
+ "minBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
#
- # A task's retry interval starts at
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `min_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [min_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [max_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ # retrying a failed task, measured from when the task was first
+ # attempted. Once `max_retry_duration` time has passed *and* the
+ # task has been attempted max_attempts
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_retry_duration` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [task_age_limit in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxDoublings": 42, # The time between retries will double `max_doublings` times.
+ #
+ # A task's retry interval starts at
# min_backoff, then doubles
# `max_doublings` times, then increases linearly, and finally
# retries at intervals of
@@ -3574,66 +3536,123 @@
# This field has the same meaning as
# [max_doublings in
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
- "maxAttempts": 42, # The maximum number of attempts for a task.
+ "maxAttempts": 42, # The maximum number of attempts for a task.
#
# Cloud Tasks will attempt the task `max_attempts` times (that
# is, if the first attempt fails, then there will be
# `max_attempts - 1` retries). Must be > 0.
- "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
- # retrying a failed task, measured from when the task was first
- # attempted. Once `max_retry_duration` time has passed *and* the
- # task has been attempted max_attempts
- # times, no further attempts will be made and the task will be
- # deleted.
- #
- # If zero, then the task age is unlimited.
+ "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
+ },
+ "name": "A String", # Caller-specified and required in CreateQueue,
+ # after which it becomes output only.
+ #
+ # The queue name.
+ #
+ # The queue name must have the following format:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the queue's location.
+ # The list of available locations can be obtained by calling
+ # 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.
+ "rateLimits": { # Rate limits. # Rate limits for task dispatches.
+ #
+ # rate_limits and
+ # retry_config are related because they both
+ # control task attempts however they control how tasks are
+ # attempted in different ways:
+ #
+ # * rate_limits controls the total rate of
+ # dispatches from a queue (i.e. all traffic dispatched from the
+ # queue, regardless of whether the dispatch is from a first
+ # attempt or a retry).
+ # * retry_config controls what happens to
+ # particular a task after its first attempt fails. That is,
+ # retry_config controls task retries (the
+ # second attempt, third attempt, etc).
+ #
+ # 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.
+ "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
+ # to be dispatched for this queue. After this threshold has been
+ # reached, Cloud Tasks stops dispatching tasks until the number of
+ # concurrent requests decreases.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # This field is output only for pull queues.
#
+ # The maximum allowed value is 5,000.
#
- # `max_retry_duration` will be truncated to the nearest second.
+ # This field is output only for
+ # pull queues and always -1, which indicates no limit. No other
+ # queue types can have `max_concurrent_tasks` set to -1.
+ #
#
# This field has the same meaning as
- # [task_age_limit in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "minBackoff": "A String", # A task will be scheduled for retry between
- # min_backoff and
- # max_backoff duration after it fails,
- # if the queue's RetryConfig specifies that the task should be
- # retried.
+ # [max_concurrent_requests in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
+ "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # This field is output only for pull queues.
+ # * For App Engine queues, the maximum allowed value
+ # is 500.
+ # * This field is output only for pull queues. In addition to the
+ # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
+ # LeaseTasks requests are allowed per pull queue.
#
#
- # `min_backoff` will be truncated to the nearest second.
- #
# This field has the same meaning as
- # [min_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxBackoff": "A String", # A task will be scheduled for retry between
- # min_backoff and
- # max_backoff duration after it fails,
- # if the queue's RetryConfig specifies that the task should be
- # retried.
+ # [rate in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
+ "maxBurstSize": 42, # Output only. The max burst size.
#
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
+ # Max burst size limits how fast tasks in queue are processed when
+ # many tasks are in the queue and the rate is high. This field
+ # allows the queue to have a high rate so processing starts shortly
+ # after a task is enqueued, but still limits resource usage when
+ # many tasks are enqueued in a short period of time.
#
- # This field is output only for pull queues.
+ # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
+ # algorithm is used to control the rate of task dispatches. Each
+ # queue has a token bucket that holds tokens, up to the maximum
+ # specified by `max_burst_size`. Each time a task is dispatched, a
+ # token is removed from the bucket. Tasks will be dispatched until
+ # the queue's bucket runs out of tokens. The bucket will be
+ # continuously refilled with new tokens based on
+ # max_tasks_dispatched_per_second.
#
+ # Cloud Tasks will pick the value of `max_burst_size` based on the
+ # value of
+ # max_tasks_dispatched_per_second.
#
- # `max_backoff` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [max_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ # For App Engine queues that were created or updated using
+ # `queue.yaml/xml`, `max_burst_size` is equal to
+ # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
+ # Since `max_burst_size` is output only, if
+ # UpdateQueue is called on a queue
+ # created by `queue.yaml/xml`, `max_burst_size` will be reset based
+ # on the value of
+ # max_tasks_dispatched_per_second,
+ # regardless of whether
+ # max_tasks_dispatched_per_second
+ # is updated.
+ },
+ "pullTarget": { # Pull target. # Pull target.
+ #
+ # A pull queue is a queue that has a PullTarget.
},
}</pre>
</div>
@@ -3645,7 +3664,7 @@
This method resumes a queue after it has been
PAUSED or
DISABLED. The state of a queue is stored
-in the queue's state; after calling this method it
+in the queue's state; after calling this method it
will be set to RUNNING.
WARNING: Resuming many high-QPS queues at the same time can
@@ -3674,121 +3693,14 @@
{ # 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.
- "name": "A String", # Caller-specified and required in CreateQueue,
- # after which it becomes output only.
- #
- # The queue name.
- #
- # The queue name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the queue's location.
- # The list of available locations can be obtained by calling
- # 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.
- "rateLimits": { # Rate limits. # Rate limits for task dispatches.
- #
- # rate_limits and
- # retry_config are related because they both
- # control task attempts however they control how tasks are
- # attempted in different ways:
- #
- # * rate_limits controls the total rate of
- # dispatches from a queue (i.e. all traffic dispatched from the
- # queue, regardless of whether the dispatch is from a first
- # attempt or a retry).
- # * retry_config controls what happens to
- # particular a task after its first attempt fails. That is,
- # retry_config controls task retries (the
- # second attempt, third attempt, etc).
- #
- # 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.
- "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
- # to be dispatched for this queue. After this threshold has been
- # reached, Cloud Tasks stops dispatching tasks until the number of
- # concurrent requests decreases.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- #
- # The maximum allowed value is 5,000.
- #
- # This field is output only for
- # pull queues and always -1, which indicates no limit. No other
- # queue types can have `max_concurrent_tasks` set to -1.
- #
- #
- # This field has the same meaning as
- # [max_concurrent_requests in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
- "maxBurstSize": 42, # Output only. The max burst size.
- #
- # Max burst size limits how fast tasks in queue are processed when
- # many tasks are in the queue and the rate is high. This field
- # allows the queue to have a high rate so processing starts shortly
- # after a task is enqueued, but still limits resource usage when
- # many tasks are enqueued in a short period of time.
- #
- # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
- # algorithm is used to control the rate of task dispatches. Each
- # queue has a token bucket that holds tokens, up to the maximum
- # specified by `max_burst_size`. Each time a task is dispatched, a
- # token is removed from the bucket. Tasks will be dispatched until
- # the queue's bucket runs out of tokens. The bucket will be
- # continuously refilled with new tokens based on
- # max_tasks_dispatched_per_second.
- #
- # Cloud Tasks will pick the value of `max_burst_size` based on the
- # value of
- # max_tasks_dispatched_per_second.
- #
- # For App Engine queues that were created or updated using
- # `queue.yaml/xml`, `max_burst_size` is equal to
- # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
- # Since `max_burst_size` is output only, if
- # UpdateQueue is called on a queue
- # created by `queue.yaml/xml`, `max_burst_size` will be reset based
- # on the value of
- # max_tasks_dispatched_per_second,
- # regardless of whether
- # max_tasks_dispatched_per_second
- # is updated.
- "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- # * For App Engine queues, the maximum allowed value
- # is 500.
- # * This field is output only for pull queues. In addition to the
- # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
- # LeaseTasks requests are allowed per pull queue.
- #
- #
- # This field has the same meaning as
- # [rate in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
- },
- "appEngineHttpTarget": { # App Engine HTTP target. # App Engine HTTP target.
+ "appEngineHttpTarget": { # App Engine HTTP target. # App Engine HTTP target.
#
# An App Engine queue is a queue that has an AppEngineHttpTarget.
#
# 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.
+ # task's host URL is constructed.
#
# Using AppEngineHttpTarget requires
# [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
@@ -3796,7 +3708,7 @@
# and the following scope:
#
# `https://www.googleapis.com/auth/cloud-platform`
- "appEngineRoutingOverride": { # App Engine Routing. # Overrides for the
+ "appEngineRoutingOverride": { # App Engine Routing. # Overrides for the
# task-level app_engine_routing.
#
# If set, `app_engine_routing_override` is used for all tasks in
@@ -3815,7 +3727,7 @@
# 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).
- "instance": "A String", # App instance.
+ "instance": "A String", # App instance.
#
# By default, the task is sent to an instance which is available when
# the task is attempted.
@@ -3828,7 +3740,23 @@
# 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).
- "host": "A String", # Output only. The host that the task is sent to.
+ "version": "A String", # App version.
+ #
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
+ #
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
#
# For more information, see
# [How Requests are
@@ -3838,17 +3766,17 @@
#
#
# * `host = [application_domain_name]`</br>
- # `| [service] + '.' + [application_domain_name]`</br>
- # `| [version] + '.' + [application_domain_name]`</br>
- # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
- # `| [instance] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
- # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
+ # `| [service] + '.' + [application_domain_name]`</br>
+ # `| [version] + '.' + [application_domain_name]`</br>
+ # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
+ # `| [instance] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
+ # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
#
# * `application_domain_name` = The domain name of the app, for
# example <app-id>.appspot.com, which is associated with the
- # queue's project ID. Some tasks which were created using the App Engine
+ # queue's project ID. Some tasks which were created using the App Engine
# SDK use a custom domain name.
#
# * `service =` service
@@ -3856,22 +3784,22 @@
# * `version =` version
#
# * `version_dot_service =`
- # version `+ '.' +`
+ # version `+ '.' +`
# service
#
# * `instance =` instance
#
# * `instance_dot_service =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# service
#
# * `instance_dot_version =`
- # instance `+ '.' +`
+ # instance `+ '.' +`
# version
#
# * `instance_dot_version_dot_service =`
- # instance `+ '.' +`
- # version `+ '.' +`
+ # instance `+ '.' +`
+ # version `+ '.' +`
# service
#
# If service is empty, then the task will be sent
@@ -3889,23 +3817,7 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "version": "A String", # App version.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "service": "A String", # App service.
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -3923,18 +3835,7 @@
# instance are the empty string.
},
},
- "pullTarget": { # Pull target. # Pull target.
- #
- # A pull queue is a queue that has a PullTarget.
- },
- "state": "A String", # Output only. The state of the queue.
- #
- # `state` can only be changed by called
- # PauseQueue,
- # ResumeQueue, or uploading
- # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
- # UpdateQueue cannot be used to change `state`.
- "purgeTime": "A String", # Output only. The last time this queue was purged.
+ "purgeTime": "A String", # Output only. The last time this queue was purged.
#
# All tasks that were created before this time
# were purged.
@@ -3945,7 +3846,14 @@
#
# Purge time will be truncated to the nearest microsecond. Purge
# time will be unset if the queue has never been purged.
- "retryConfig": { # Retry config. # Settings that determine the retry behavior.
+ "state": "A String", # Output only. The state of the queue.
+ #
+ # `state` can only be changed by called
+ # PauseQueue,
+ # ResumeQueue, or uploading
+ # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
+ # UpdateQueue cannot be used to change `state`.
+ "retryConfig": { # Retry config. # Settings that determine the retry behavior.
#
# * For tasks created using Cloud Tasks: the queue-level retry settings
# apply to all tasks in the queue that were created using Cloud Tasks.
@@ -3957,9 +3865,63 @@
# documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
#
# These settings determine how a failed task attempt is retried.
- "maxDoublings": 42, # The time between retries will double `max_doublings` times.
+ "minBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
#
- # A task's retry interval starts at
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `min_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [min_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [max_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ # retrying a failed task, measured from when the task was first
+ # attempted. Once `max_retry_duration` time has passed *and* the
+ # task has been attempted max_attempts
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_retry_duration` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [task_age_limit in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxDoublings": 42, # The time between retries will double `max_doublings` times.
+ #
+ # A task's retry interval starts at
# min_backoff, then doubles
# `max_doublings` times, then increases linearly, and finally
# retries at intervals of
@@ -3985,66 +3947,123 @@
# This field has the same meaning as
# [max_doublings in
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
- "maxAttempts": 42, # The maximum number of attempts for a task.
+ "maxAttempts": 42, # The maximum number of attempts for a task.
#
# Cloud Tasks will attempt the task `max_attempts` times (that
# is, if the first attempt fails, then there will be
# `max_attempts - 1` retries). Must be > 0.
- "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
- # retrying a failed task, measured from when the task was first
- # attempted. Once `max_retry_duration` time has passed *and* the
- # task has been attempted max_attempts
- # times, no further attempts will be made and the task will be
- # deleted.
- #
- # If zero, then the task age is unlimited.
+ "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
+ },
+ "name": "A String", # Caller-specified and required in CreateQueue,
+ # after which it becomes output only.
+ #
+ # The queue name.
+ #
+ # The queue name must have the following format:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the queue's location.
+ # The list of available locations can be obtained by calling
+ # 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.
+ "rateLimits": { # Rate limits. # Rate limits for task dispatches.
+ #
+ # rate_limits and
+ # retry_config are related because they both
+ # control task attempts however they control how tasks are
+ # attempted in different ways:
+ #
+ # * rate_limits controls the total rate of
+ # dispatches from a queue (i.e. all traffic dispatched from the
+ # queue, regardless of whether the dispatch is from a first
+ # attempt or a retry).
+ # * retry_config controls what happens to
+ # particular a task after its first attempt fails. That is,
+ # retry_config controls task retries (the
+ # second attempt, third attempt, etc).
+ #
+ # 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.
+ "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
+ # to be dispatched for this queue. After this threshold has been
+ # reached, Cloud Tasks stops dispatching tasks until the number of
+ # concurrent requests decreases.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # This field is output only for pull queues.
#
+ # The maximum allowed value is 5,000.
#
- # `max_retry_duration` will be truncated to the nearest second.
+ # This field is output only for
+ # pull queues and always -1, which indicates no limit. No other
+ # queue types can have `max_concurrent_tasks` set to -1.
+ #
#
# This field has the same meaning as
- # [task_age_limit in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "minBackoff": "A String", # A task will be scheduled for retry between
- # min_backoff and
- # max_backoff duration after it fails,
- # if the queue's RetryConfig specifies that the task should be
- # retried.
+ # [max_concurrent_requests in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
+ "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # This field is output only for pull queues.
+ # * For App Engine queues, the maximum allowed value
+ # is 500.
+ # * This field is output only for pull queues. In addition to the
+ # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
+ # LeaseTasks requests are allowed per pull queue.
#
#
- # `min_backoff` will be truncated to the nearest second.
- #
# This field has the same meaning as
- # [min_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxBackoff": "A String", # A task will be scheduled for retry between
- # min_backoff and
- # max_backoff duration after it fails,
- # if the queue's RetryConfig specifies that the task should be
- # retried.
+ # [rate in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
+ "maxBurstSize": 42, # Output only. The max burst size.
#
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
+ # Max burst size limits how fast tasks in queue are processed when
+ # many tasks are in the queue and the rate is high. This field
+ # allows the queue to have a high rate so processing starts shortly
+ # after a task is enqueued, but still limits resource usage when
+ # many tasks are enqueued in a short period of time.
#
- # This field is output only for pull queues.
+ # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
+ # algorithm is used to control the rate of task dispatches. Each
+ # queue has a token bucket that holds tokens, up to the maximum
+ # specified by `max_burst_size`. Each time a task is dispatched, a
+ # token is removed from the bucket. Tasks will be dispatched until
+ # the queue's bucket runs out of tokens. The bucket will be
+ # continuously refilled with new tokens based on
+ # max_tasks_dispatched_per_second.
#
+ # Cloud Tasks will pick the value of `max_burst_size` based on the
+ # value of
+ # max_tasks_dispatched_per_second.
#
- # `max_backoff` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [max_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ # For App Engine queues that were created or updated using
+ # `queue.yaml/xml`, `max_burst_size` is equal to
+ # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
+ # Since `max_burst_size` is output only, if
+ # UpdateQueue is called on a queue
+ # created by `queue.yaml/xml`, `max_burst_size` will be reset based
+ # on the value of
+ # max_tasks_dispatched_per_second,
+ # regardless of whether
+ # max_tasks_dispatched_per_second
+ # is updated.
+ },
+ "pullTarget": { # Pull target. # Pull target.
+ #
+ # A pull queue is a queue that has a PullTarget.
},
}</pre>
</div>
@@ -4070,7 +4089,7 @@
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
- "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of
+ "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of
# the policy is limited to a few 10s of KB. An empty policy is a
# valid policy but certain Cloud Platform services (such as Projects)
# might reject them.
@@ -4083,36 +4102,40 @@
# permissions; each `role` can be an IAM predefined role or a user-created
# custom role.
#
- # Optionally, a `binding` can specify a `condition`, which is a logical
- # expression that allows access to a resource only if the expression evaluates
- # to `true`. A condition can add constraints based on attributes of the
- # request, the resource, or both.
+ # For some types of Google Cloud resources, a `binding` can also specify a
+ # `condition`, which is a logical expression that allows access to a resource
+ # only if the expression evaluates to `true`. A condition can add constraints
+ # based on attributes of the request, the resource, or both. To learn which
+ # resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
#
# **JSON example:**
#
# {
- # "bindings": [
+ # "bindings": [
# {
- # "role": "roles/resourcemanager.organizationAdmin",
- # "members": [
- # "user:mike@example.com",
- # "group:admins@example.com",
- # "domain:google.com",
- # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+ # "role": "roles/resourcemanager.organizationAdmin",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
- # "role": "roles/resourcemanager.organizationViewer",
- # "members": ["user:eve@example.com"],
- # "condition": {
- # "title": "expirable access",
- # "description": "Does not grant access after Sep 2020",
- # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": [
+ # "user:eve@example.com"
+ # ],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
# }
# }
# ],
- # "etag": "BwWWja0YfJA=",
- # "version": 3
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
# **YAML example:**
@@ -4130,63 +4153,107 @@
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
- # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
# - etag: BwWWja0YfJA=
# - version: 3
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "role": "A String", # Role that is assigned to `members`.
+ "role": "A String", # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
- # NOTE: An unsatisfied condition will not allow user access via current
- # binding. Different bindings, including their conditions, are examined
- # independently.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ #
+ # If the condition evaluates to `true`, then this binding applies to the
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the members in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
# syntax. CEL is a C-like expression language. The syntax and semantics of CEL
# are documented at https://github.com/google/cel-spec.
#
# Example (Comparison):
#
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
#
# Example (Equality):
#
- # title: "Requestor is owner"
- # description: "Determines if requestor is the document owner"
- # expression: "document.owner == request.auth.claims.email"
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
#
# Example (Logic):
#
- # title: "Public documents"
- # description: "Determine whether the document should be publicly visible"
- # expression: "document.type != 'private' && document.type != 'internal'"
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
#
# Example (Data Manipulation):
#
- # title: "Notification string"
- # description: "Create a notification string with a timestamp."
- # expression: "'New message received at ' + string(document.create_time)"
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
#
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service
# documentation for additional information.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
},
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
# * `allUsers`: A special identifier that represents anyone who is
@@ -4229,43 +4296,10 @@
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
- "A String",
+ "A String",
],
},
],
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
- # prevent simultaneous updates of a policy from overwriting each other.
- # It is strongly suggested that systems make use of the `etag` in the
- # read-modify-write cycle to perform policy updates in order to avoid race
- # conditions: An `etag` is returned in the response to `getIamPolicy`, and
- # systems are expected to put that etag in the request to `setIamPolicy` to
- # ensure that their change will be applied to the same version of the policy.
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
},
}
@@ -4287,36 +4321,40 @@
# permissions; each `role` can be an IAM predefined role or a user-created
# custom role.
#
- # Optionally, a `binding` can specify a `condition`, which is a logical
- # expression that allows access to a resource only if the expression evaluates
- # to `true`. A condition can add constraints based on attributes of the
- # request, the resource, or both.
+ # For some types of Google Cloud resources, a `binding` can also specify a
+ # `condition`, which is a logical expression that allows access to a resource
+ # only if the expression evaluates to `true`. A condition can add constraints
+ # based on attributes of the request, the resource, or both. To learn which
+ # resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
#
# **JSON example:**
#
# {
- # "bindings": [
+ # "bindings": [
# {
- # "role": "roles/resourcemanager.organizationAdmin",
- # "members": [
- # "user:mike@example.com",
- # "group:admins@example.com",
- # "domain:google.com",
- # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+ # "role": "roles/resourcemanager.organizationAdmin",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
- # "role": "roles/resourcemanager.organizationViewer",
- # "members": ["user:eve@example.com"],
- # "condition": {
- # "title": "expirable access",
- # "description": "Does not grant access after Sep 2020",
- # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": [
+ # "user:eve@example.com"
+ # ],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
# }
# }
# ],
- # "etag": "BwWWja0YfJA=",
- # "version": 3
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
# **YAML example:**
@@ -4334,63 +4372,107 @@
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
- # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
# - etag: BwWWja0YfJA=
# - version: 3
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "role": "A String", # Role that is assigned to `members`.
+ "role": "A String", # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
- # NOTE: An unsatisfied condition will not allow user access via current
- # binding. Different bindings, including their conditions, are examined
- # independently.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ #
+ # If the condition evaluates to `true`, then this binding applies to the
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the members in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
# syntax. CEL is a C-like expression language. The syntax and semantics of CEL
# are documented at https://github.com/google/cel-spec.
#
# Example (Comparison):
#
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
#
# Example (Equality):
#
- # title: "Requestor is owner"
- # description: "Determines if requestor is the document owner"
- # expression: "document.owner == request.auth.claims.email"
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
#
# Example (Logic):
#
- # title: "Public documents"
- # description: "Determine whether the document should be publicly visible"
- # expression: "document.type != 'private' && document.type != 'internal'"
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
#
# Example (Data Manipulation):
#
- # title: "Notification string"
- # description: "Create a notification string with a timestamp."
- # expression: "'New message received at ' + string(document.create_time)"
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
#
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service
# documentation for additional information.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
},
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
# * `allUsers`: A special identifier that represents anyone who is
@@ -4433,43 +4515,10 @@
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
- "A String",
+ "A String",
],
},
],
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
- # prevent simultaneous updates of a policy from overwriting each other.
- # It is strongly suggested that systems make use of the `etag` in the
- # read-modify-write cycle to perform policy updates in order to avoid race
- # conditions: An `etag` is returned in the response to `getIamPolicy`, and
- # systems are expected to put that etag in the request to `setIamPolicy` to
- # ensure that their change will be applied to the same version of the policy.
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
}</pre>
</div>
@@ -4481,7 +4530,7 @@
Note: This operation is designed to be used for building permission-aware
UIs and command-line tools, not for authorization checking. This operation
-may "fail open" without warning.
+may "fail open" without warning.
Args:
resource: string, REQUIRED: The resource for which the policy detail is being requested.
@@ -4490,11 +4539,11 @@
The object takes the form of:
{ # Request message for `TestIamPermissions` method.
- "permissions": [ # The set of permissions to check for the `resource`. Permissions with
- # wildcards (such as '*' or 'storage.*') are not allowed. For more
+ "permissions": [ # The set of permissions to check for the `resource`. Permissions with
+ # wildcards (such as '*' or 'storage.*') are not allowed. For more
# information see
# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
- "A String",
+ "A String",
],
}
@@ -4507,9 +4556,9 @@
An object of the form:
{ # Response message for `TestIamPermissions` method.
- "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
# allowed.
- "A String",
+ "A String",
],
}</pre>
</div>