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_v2beta3.projects.locations.queues.html b/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.html
index f0398de..cdee382 100644
--- a/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.html
+++ b/docs/dyn/cloudtasks_v2beta3.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, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</a></code></p>
+ <code><a href="#list">list(parent, pageToken=None, pageSize=None, filter=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,150 +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, queue 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.
- "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
- # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
- # field is unset, then no logs are written.
- # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
- "samplingRatio": 3.14, # Specifies the fraction of operations to write to
- # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
- # This field may contain any value between 0.0 and 1.0, inclusive.
- # 0.0 is the default and means that no operations are logged.
- },
- "rateLimits": { # Rate limits. # Rate limits for task dispatches.
- #
- # rate_limits and retry_config are
- # related because they both control task attempts. However they control task
- # attempts 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).
- #
- # The queue's actual dispatch rate is the result of:
- #
- # * Number of tasks in the queue
- # * User-specified throttling: rate_limits,
- # retry_config, and the
- # queue's state.
- # * System throttling due to `429` (Too Many Requests) or `503` (Service
- # Unavailable) responses from the worker, high error rates, or to smooth
- # sudden large traffic spikes.
- #
- # 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.
- "maxConcurrentDispatches": 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 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_dispatches_per_second.
- #
- # Cloud Tasks will pick the value of `max_burst_size` based on the
- # value of
- # max_dispatches_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_dispatches_per_second,
- # regardless of whether
- # max_dispatches_per_second
- # is updated.
- "maxDispatchesPerSecond": 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 has the same meaning as
- # [rate in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
- },
- "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.
- #
- # All tasks that were created before this time
- # were purged.
- #
- # A queue can be purged using PurgeQueue, the
- # [App Engine Task Queue SDK, or the Cloud
- # Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
- #
- # Purge time will be truncated to the nearest microsecond. Purge
- # time will be unset if the queue has never been purged.
- "appEngineHttpQueue": { # App Engine HTTP queue. # AppEngineHttpQueue settings apply only to
+ "appEngineHttpQueue": { # App Engine HTTP queue. # AppEngineHttpQueue settings apply only to
# App Engine tasks in this queue.
# Http tasks are not affected by this proto.
#
# The task will be delivered to the App Engine application hostname
# specified by its AppEngineHttpQueue and AppEngineHttpRequest.
# The documentation for AppEngineHttpRequest explains how the
- # task's host URL is constructed.
+ # task's host URL is constructed.
#
# Using AppEngineHttpQueue requires
# [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
@@ -295,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
@@ -314,31 +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.
- #
- # By default, the task is sent to an instance which is available when
- # the task is attempted.
- #
- # Requests can only be sent to a specific instance if
- # [manual scaling is used in App Engine
- # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
- # App Engine Flex does not support instances. For more information, see
- # [App Engine Standard request
- # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
- # and [App Engine Flex request
- # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "host": "A String", # Output only. The host that the task is sent to.
- #
- # The host is constructed from the domain name of the app associated with
- # the queue's project ID (for example <app-id>.appspot.com), and the
- # service, version,
- # and instance. Tasks which were created using
- # the App Engine SDK might have a custom domain name.
- #
- # For more information, see
- # [How Requests are
- # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
- "version": "A String", # App version.
+ "version": "A String", # App version.
#
# By default, the task is sent to the version which is the default
# version when the task is attempted.
@@ -354,7 +194,18 @@
# service,
# version, and
# instance are the empty string.
- "service": "A String", # App service.
+ "host": "A String", # Output only. The host that the task is sent to.
+ #
+ # The host is constructed from the domain name of the app associated with
+ # the queue's project ID (for example <app-id>.appspot.com), and the
+ # service, version,
+ # and instance. Tasks which were created using
+ # the App Engine SDK might have a custom domain name.
+ #
+ # For more information, see
+ # [How Requests are
+ # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -370,9 +221,33 @@
# service,
# version, and
# instance are the empty string.
+ "instance": "A String", # App instance.
+ #
+ # By default, the task is sent to an instance which is available when
+ # the task is attempted.
+ #
+ # Requests can only be sent to a specific instance if
+ # [manual scaling is used in App Engine
+ # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
+ # App Engine Flex does not support instances. For more information, see
+ # [App Engine Standard request
+ # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
+ # and [App Engine Flex request
+ # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
},
},
- "retryConfig": { # Retry config. # Settings that determine the retry behavior.
+ "purgeTime": "A String", # Output only. The last time this queue was purged.
+ #
+ # All tasks that were created before this time
+ # were purged.
+ #
+ # A queue can be purged using PurgeQueue, the
+ # [App Engine Task Queue SDK, or the Cloud
+ # Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
+ #
+ # 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.
#
# * For tasks created using Cloud Tasks: the queue-level retry settings
# apply to all tasks in the queue that were created using Cloud Tasks.
@@ -384,7 +259,37 @@
# documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
#
# These settings determine when a failed task attempt is retried.
- "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ "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.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # `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.
+ #
+ #
+ # `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
@@ -402,9 +307,23 @@
# 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.
+ "maxAttempts": 42, # Number of attempts per task.
#
- # A task's retry interval starts at
+ # 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 >= -1.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # -1 indicates unlimited attempts.
+ #
+ # This field has the same meaning as
+ # [task_retry_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
@@ -428,50 +347,131 @@
# 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).
- "maxAttempts": 42, # Number of attempts per task.
+ },
+ "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`.
+ "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 task
+ # attempts 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).
+ #
+ # The queue's actual dispatch rate is the result of:
+ #
+ # * Number of tasks in the queue
+ # * User-specified throttling: rate_limits,
+ # retry_config, and the
+ # queue's state.
+ # * System throttling due to `429` (Too Many Requests) or `503` (Service
+ # Unavailable) responses from the worker, high error rates, or to smooth
+ # sudden large traffic spikes.
+ #
+ # 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.
+ "maxBurstSize": 42, # Output only. The max burst size.
#
- # 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 >= -1.
+ # 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.
#
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
+ # 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_dispatches_per_second.
#
- # -1 indicates unlimited attempts.
+ # Cloud Tasks will pick the value of `max_burst_size` based on the
+ # value of
+ # max_dispatches_per_second.
#
- # This field has the same meaning as
- # [task_retry_limit 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.
+ # 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_dispatches_per_second,
+ # regardless of whether
+ # max_dispatches_per_second
+ # is updated.
+ "maxConcurrentDispatches": 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.
#
#
- # `max_backoff` will be truncated to the nearest second.
+ # The maximum allowed value is 5,000.
+ #
#
# 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).
- "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).
+ "maxDispatchesPerSecond": 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.
#
- # `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).
+ # [rate in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
+ },
+ "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
+ # field is unset, then no logs are written.
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ "samplingRatio": 3.14, # Specifies the fraction of operations to write to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ # This field may contain any value between 0.0 and 1.0, inclusive.
+ # 0.0 is the default and means that no operations are logged.
},
}
@@ -486,150 +486,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, queue 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.
- "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
- # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
- # field is unset, then no logs are written.
- # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
- "samplingRatio": 3.14, # Specifies the fraction of operations to write to
- # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
- # This field may contain any value between 0.0 and 1.0, inclusive.
- # 0.0 is the default and means that no operations are logged.
- },
- "rateLimits": { # Rate limits. # Rate limits for task dispatches.
- #
- # rate_limits and retry_config are
- # related because they both control task attempts. However they control task
- # attempts 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).
- #
- # The queue's actual dispatch rate is the result of:
- #
- # * Number of tasks in the queue
- # * User-specified throttling: rate_limits,
- # retry_config, and the
- # queue's state.
- # * System throttling due to `429` (Too Many Requests) or `503` (Service
- # Unavailable) responses from the worker, high error rates, or to smooth
- # sudden large traffic spikes.
- #
- # 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.
- "maxConcurrentDispatches": 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 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_dispatches_per_second.
- #
- # Cloud Tasks will pick the value of `max_burst_size` based on the
- # value of
- # max_dispatches_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_dispatches_per_second,
- # regardless of whether
- # max_dispatches_per_second
- # is updated.
- "maxDispatchesPerSecond": 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 has the same meaning as
- # [rate in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
- },
- "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.
- #
- # All tasks that were created before this time
- # were purged.
- #
- # A queue can be purged using PurgeQueue, the
- # [App Engine Task Queue SDK, or the Cloud
- # Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
- #
- # Purge time will be truncated to the nearest microsecond. Purge
- # time will be unset if the queue has never been purged.
- "appEngineHttpQueue": { # App Engine HTTP queue. # AppEngineHttpQueue settings apply only to
+ "appEngineHttpQueue": { # App Engine HTTP queue. # AppEngineHttpQueue settings apply only to
# App Engine tasks in this queue.
# Http tasks are not affected by this proto.
#
# The task will be delivered to the App Engine application hostname
# specified by its AppEngineHttpQueue and AppEngineHttpRequest.
# The documentation for AppEngineHttpRequest explains how the
- # task's host URL is constructed.
+ # task's host URL is constructed.
#
# Using AppEngineHttpQueue requires
# [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
@@ -637,7 +501,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
@@ -656,31 +520,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.
- #
- # By default, the task is sent to an instance which is available when
- # the task is attempted.
- #
- # Requests can only be sent to a specific instance if
- # [manual scaling is used in App Engine
- # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
- # App Engine Flex does not support instances. For more information, see
- # [App Engine Standard request
- # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
- # and [App Engine Flex request
- # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "host": "A String", # Output only. The host that the task is sent to.
- #
- # The host is constructed from the domain name of the app associated with
- # the queue's project ID (for example <app-id>.appspot.com), and the
- # service, version,
- # and instance. Tasks which were created using
- # the App Engine SDK might have a custom domain name.
- #
- # For more information, see
- # [How Requests are
- # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
- "version": "A String", # App version.
+ "version": "A String", # App version.
#
# By default, the task is sent to the version which is the default
# version when the task is attempted.
@@ -696,7 +536,18 @@
# service,
# version, and
# instance are the empty string.
- "service": "A String", # App service.
+ "host": "A String", # Output only. The host that the task is sent to.
+ #
+ # The host is constructed from the domain name of the app associated with
+ # the queue's project ID (for example <app-id>.appspot.com), and the
+ # service, version,
+ # and instance. Tasks which were created using
+ # the App Engine SDK might have a custom domain name.
+ #
+ # For more information, see
+ # [How Requests are
+ # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -712,9 +563,33 @@
# service,
# version, and
# instance are the empty string.
+ "instance": "A String", # App instance.
+ #
+ # By default, the task is sent to an instance which is available when
+ # the task is attempted.
+ #
+ # Requests can only be sent to a specific instance if
+ # [manual scaling is used in App Engine
+ # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
+ # App Engine Flex does not support instances. For more information, see
+ # [App Engine Standard request
+ # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
+ # and [App Engine Flex request
+ # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
},
},
- "retryConfig": { # Retry config. # Settings that determine the retry behavior.
+ "purgeTime": "A String", # Output only. The last time this queue was purged.
+ #
+ # All tasks that were created before this time
+ # were purged.
+ #
+ # A queue can be purged using PurgeQueue, the
+ # [App Engine Task Queue SDK, or the Cloud
+ # Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
+ #
+ # 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.
#
# * For tasks created using Cloud Tasks: the queue-level retry settings
# apply to all tasks in the queue that were created using Cloud Tasks.
@@ -726,7 +601,37 @@
# documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
#
# These settings determine when a failed task attempt is retried.
- "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ "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.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # `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.
+ #
+ #
+ # `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
@@ -744,9 +649,23 @@
# 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.
+ "maxAttempts": 42, # Number of attempts per task.
#
- # A task's retry interval starts at
+ # 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 >= -1.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # -1 indicates unlimited attempts.
+ #
+ # This field has the same meaning as
+ # [task_retry_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
@@ -770,50 +689,131 @@
# 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).
- "maxAttempts": 42, # Number of attempts per task.
+ },
+ "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`.
+ "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 task
+ # attempts 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).
+ #
+ # The queue's actual dispatch rate is the result of:
+ #
+ # * Number of tasks in the queue
+ # * User-specified throttling: rate_limits,
+ # retry_config, and the
+ # queue's state.
+ # * System throttling due to `429` (Too Many Requests) or `503` (Service
+ # Unavailable) responses from the worker, high error rates, or to smooth
+ # sudden large traffic spikes.
+ #
+ # 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.
+ "maxBurstSize": 42, # Output only. The max burst size.
#
- # 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 >= -1.
+ # 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.
#
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
+ # 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_dispatches_per_second.
#
- # -1 indicates unlimited attempts.
+ # Cloud Tasks will pick the value of `max_burst_size` based on the
+ # value of
+ # max_dispatches_per_second.
#
- # This field has the same meaning as
- # [task_retry_limit 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.
+ # 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_dispatches_per_second,
+ # regardless of whether
+ # max_dispatches_per_second
+ # is updated.
+ "maxConcurrentDispatches": 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.
#
#
- # `max_backoff` will be truncated to the nearest second.
+ # The maximum allowed value is 5,000.
+ #
#
# 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).
- "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).
+ "maxDispatchesPerSecond": 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.
#
- # `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).
+ # [rate in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
+ },
+ "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
+ # field is unset, then no logs are written.
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ "samplingRatio": 3.14, # Specifies the fraction of operations to write to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ # This field may contain any value between 0.0 and 1.0, inclusive.
+ # 0.0 is the default and means that no operations are logged.
},
}</pre>
</div>
@@ -824,7 +824,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
@@ -875,150 +875,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, queue 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.
- "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
- # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
- # field is unset, then no logs are written.
- # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
- "samplingRatio": 3.14, # Specifies the fraction of operations to write to
- # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
- # This field may contain any value between 0.0 and 1.0, inclusive.
- # 0.0 is the default and means that no operations are logged.
- },
- "rateLimits": { # Rate limits. # Rate limits for task dispatches.
- #
- # rate_limits and retry_config are
- # related because they both control task attempts. However they control task
- # attempts 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).
- #
- # The queue's actual dispatch rate is the result of:
- #
- # * Number of tasks in the queue
- # * User-specified throttling: rate_limits,
- # retry_config, and the
- # queue's state.
- # * System throttling due to `429` (Too Many Requests) or `503` (Service
- # Unavailable) responses from the worker, high error rates, or to smooth
- # sudden large traffic spikes.
- #
- # 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.
- "maxConcurrentDispatches": 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 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_dispatches_per_second.
- #
- # Cloud Tasks will pick the value of `max_burst_size` based on the
- # value of
- # max_dispatches_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_dispatches_per_second,
- # regardless of whether
- # max_dispatches_per_second
- # is updated.
- "maxDispatchesPerSecond": 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 has the same meaning as
- # [rate in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
- },
- "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.
- #
- # All tasks that were created before this time
- # were purged.
- #
- # A queue can be purged using PurgeQueue, the
- # [App Engine Task Queue SDK, or the Cloud
- # Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
- #
- # Purge time will be truncated to the nearest microsecond. Purge
- # time will be unset if the queue has never been purged.
- "appEngineHttpQueue": { # App Engine HTTP queue. # AppEngineHttpQueue settings apply only to
+ "appEngineHttpQueue": { # App Engine HTTP queue. # AppEngineHttpQueue settings apply only to
# App Engine tasks in this queue.
# Http tasks are not affected by this proto.
#
# The task will be delivered to the App Engine application hostname
# specified by its AppEngineHttpQueue and AppEngineHttpRequest.
# The documentation for AppEngineHttpRequest explains how the
- # task's host URL is constructed.
+ # task's host URL is constructed.
#
# Using AppEngineHttpQueue requires
# [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
@@ -1026,7 +890,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
@@ -1045,31 +909,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.
- #
- # By default, the task is sent to an instance which is available when
- # the task is attempted.
- #
- # Requests can only be sent to a specific instance if
- # [manual scaling is used in App Engine
- # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
- # App Engine Flex does not support instances. For more information, see
- # [App Engine Standard request
- # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
- # and [App Engine Flex request
- # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "host": "A String", # Output only. The host that the task is sent to.
- #
- # The host is constructed from the domain name of the app associated with
- # the queue's project ID (for example <app-id>.appspot.com), and the
- # service, version,
- # and instance. Tasks which were created using
- # the App Engine SDK might have a custom domain name.
- #
- # For more information, see
- # [How Requests are
- # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
- "version": "A String", # App version.
+ "version": "A String", # App version.
#
# By default, the task is sent to the version which is the default
# version when the task is attempted.
@@ -1085,7 +925,18 @@
# service,
# version, and
# instance are the empty string.
- "service": "A String", # App service.
+ "host": "A String", # Output only. The host that the task is sent to.
+ #
+ # The host is constructed from the domain name of the app associated with
+ # the queue's project ID (for example <app-id>.appspot.com), and the
+ # service, version,
+ # and instance. Tasks which were created using
+ # the App Engine SDK might have a custom domain name.
+ #
+ # For more information, see
+ # [How Requests are
+ # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -1101,9 +952,33 @@
# service,
# version, and
# instance are the empty string.
+ "instance": "A String", # App instance.
+ #
+ # By default, the task is sent to an instance which is available when
+ # the task is attempted.
+ #
+ # Requests can only be sent to a specific instance if
+ # [manual scaling is used in App Engine
+ # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
+ # App Engine Flex does not support instances. For more information, see
+ # [App Engine Standard request
+ # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
+ # and [App Engine Flex request
+ # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
},
},
- "retryConfig": { # Retry config. # Settings that determine the retry behavior.
+ "purgeTime": "A String", # Output only. The last time this queue was purged.
+ #
+ # All tasks that were created before this time
+ # were purged.
+ #
+ # A queue can be purged using PurgeQueue, the
+ # [App Engine Task Queue SDK, or the Cloud
+ # Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
+ #
+ # 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.
#
# * For tasks created using Cloud Tasks: the queue-level retry settings
# apply to all tasks in the queue that were created using Cloud Tasks.
@@ -1115,7 +990,37 @@
# documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
#
# These settings determine when a failed task attempt is retried.
- "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ "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.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # `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.
+ #
+ #
+ # `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
@@ -1133,9 +1038,23 @@
# 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.
+ "maxAttempts": 42, # Number of attempts per task.
#
- # A task's retry interval starts at
+ # 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 >= -1.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # -1 indicates unlimited attempts.
+ #
+ # This field has the same meaning as
+ # [task_retry_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
@@ -1159,50 +1078,131 @@
# 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).
- "maxAttempts": 42, # Number of attempts per task.
+ },
+ "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`.
+ "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 task
+ # attempts 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).
+ #
+ # The queue's actual dispatch rate is the result of:
+ #
+ # * Number of tasks in the queue
+ # * User-specified throttling: rate_limits,
+ # retry_config, and the
+ # queue's state.
+ # * System throttling due to `429` (Too Many Requests) or `503` (Service
+ # Unavailable) responses from the worker, high error rates, or to smooth
+ # sudden large traffic spikes.
+ #
+ # 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.
+ "maxBurstSize": 42, # Output only. The max burst size.
#
- # 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 >= -1.
+ # 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.
#
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
+ # 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_dispatches_per_second.
#
- # -1 indicates unlimited attempts.
+ # Cloud Tasks will pick the value of `max_burst_size` based on the
+ # value of
+ # max_dispatches_per_second.
#
- # This field has the same meaning as
- # [task_retry_limit 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.
+ # 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_dispatches_per_second,
+ # regardless of whether
+ # max_dispatches_per_second
+ # is updated.
+ "maxConcurrentDispatches": 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.
#
#
- # `max_backoff` will be truncated to the nearest second.
+ # The maximum allowed value is 5,000.
+ #
#
# 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).
- "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).
+ "maxDispatchesPerSecond": 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.
#
- # `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).
+ # [rate in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
+ },
+ "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
+ # field is unset, then no logs are written.
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ "samplingRatio": 3.14, # Specifies the fraction of operations to write to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ # This field may contain any value between 0.0 and 1.0, inclusive.
+ # 0.0 is the default and means that no operations are logged.
},
}</pre>
</div>
@@ -1226,9 +1226,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.
@@ -1236,6 +1236,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).
},
}
@@ -1257,36 +1261,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:**
@@ -1304,63 +1312,93 @@
# 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
+ "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`.
- # 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.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
+ "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
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
# syntax.
- "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.
- "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.
},
- "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
@@ -1403,11 +1441,13 @@
# * `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",
],
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ "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
@@ -1419,32 +1459,11 @@
# 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.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</code>
+ <code class="details" id="list">list(parent, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</code>
<pre>Lists queues.
Queues are returned in lexicographical order.
@@ -1452,13 +1471,6 @@
Args:
parent: string, Required. The location name.
For example: `projects/PROJECT_ID/locations/LOCATION_ID` (required)
- pageSize: integer, Requested page size.
-
-The maximum page size is 9800. If unspecified, the page size will
-be the maximum. Fewer queues than requested might be returned,
-even if more queues exist; use the
-next_page_token in the
-response to determine if more queues exist.
pageToken: string, A token identifying the page of results to return.
To request the first page results, page_token must be empty. To
@@ -1467,183 +1479,45 @@
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
+be the maximum. Fewer queues than requested might be returned,
+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
+[Stackdriver's Advanced Logs
Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
-Sample filter "state: PAUSED".
+Sample filter "state: PAUSED".
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, queue 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.
- "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
- # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
- # field is unset, then no logs are written.
- # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
- "samplingRatio": 3.14, # Specifies the fraction of operations to write to
- # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
- # This field may contain any value between 0.0 and 1.0, inclusive.
- # 0.0 is the default and means that no operations are logged.
- },
- "rateLimits": { # Rate limits. # Rate limits for task dispatches.
- #
- # rate_limits and retry_config are
- # related because they both control task attempts. However they control task
- # attempts 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).
- #
- # The queue's actual dispatch rate is the result of:
- #
- # * Number of tasks in the queue
- # * User-specified throttling: rate_limits,
- # retry_config, and the
- # queue's state.
- # * System throttling due to `429` (Too Many Requests) or `503` (Service
- # Unavailable) responses from the worker, high error rates, or to smooth
- # sudden large traffic spikes.
- #
- # 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.
- "maxConcurrentDispatches": 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 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_dispatches_per_second.
- #
- # Cloud Tasks will pick the value of `max_burst_size` based on the
- # value of
- # max_dispatches_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_dispatches_per_second,
- # regardless of whether
- # max_dispatches_per_second
- # is updated.
- "maxDispatchesPerSecond": 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 has the same meaning as
- # [rate in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
- },
- "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.
- #
- # All tasks that were created before this time
- # were purged.
- #
- # A queue can be purged using PurgeQueue, the
- # [App Engine Task Queue SDK, or the Cloud
- # Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
- #
- # Purge time will be truncated to the nearest microsecond. Purge
- # time will be unset if the queue has never been purged.
- "appEngineHttpQueue": { # App Engine HTTP queue. # AppEngineHttpQueue settings apply only to
+ "appEngineHttpQueue": { # App Engine HTTP queue. # AppEngineHttpQueue settings apply only to
# App Engine tasks in this queue.
# Http tasks are not affected by this proto.
#
# The task will be delivered to the App Engine application hostname
# specified by its AppEngineHttpQueue and AppEngineHttpRequest.
# The documentation for AppEngineHttpRequest explains how the
- # task's host URL is constructed.
+ # task's host URL is constructed.
#
# Using AppEngineHttpQueue requires
# [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
@@ -1651,7 +1525,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
@@ -1670,31 +1544,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.
- #
- # By default, the task is sent to an instance which is available when
- # the task is attempted.
- #
- # Requests can only be sent to a specific instance if
- # [manual scaling is used in App Engine
- # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
- # App Engine Flex does not support instances. For more information, see
- # [App Engine Standard request
- # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
- # and [App Engine Flex request
- # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "host": "A String", # Output only. The host that the task is sent to.
- #
- # The host is constructed from the domain name of the app associated with
- # the queue's project ID (for example <app-id>.appspot.com), and the
- # service, version,
- # and instance. Tasks which were created using
- # the App Engine SDK might have a custom domain name.
- #
- # For more information, see
- # [How Requests are
- # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
- "version": "A String", # App version.
+ "version": "A String", # App version.
#
# By default, the task is sent to the version which is the default
# version when the task is attempted.
@@ -1710,7 +1560,18 @@
# service,
# version, and
# instance are the empty string.
- "service": "A String", # App service.
+ "host": "A String", # Output only. The host that the task is sent to.
+ #
+ # The host is constructed from the domain name of the app associated with
+ # the queue's project ID (for example <app-id>.appspot.com), and the
+ # service, version,
+ # and instance. Tasks which were created using
+ # the App Engine SDK might have a custom domain name.
+ #
+ # For more information, see
+ # [How Requests are
+ # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -1726,9 +1587,33 @@
# service,
# version, and
# instance are the empty string.
+ "instance": "A String", # App instance.
+ #
+ # By default, the task is sent to an instance which is available when
+ # the task is attempted.
+ #
+ # Requests can only be sent to a specific instance if
+ # [manual scaling is used in App Engine
+ # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
+ # App Engine Flex does not support instances. For more information, see
+ # [App Engine Standard request
+ # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
+ # and [App Engine Flex request
+ # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
},
},
- "retryConfig": { # Retry config. # Settings that determine the retry behavior.
+ "purgeTime": "A String", # Output only. The last time this queue was purged.
+ #
+ # All tasks that were created before this time
+ # were purged.
+ #
+ # A queue can be purged using PurgeQueue, the
+ # [App Engine Task Queue SDK, or the Cloud
+ # Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
+ #
+ # 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.
#
# * For tasks created using Cloud Tasks: the queue-level retry settings
# apply to all tasks in the queue that were created using Cloud Tasks.
@@ -1740,7 +1625,37 @@
# documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
#
# These settings determine when a failed task attempt is retried.
- "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ "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.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # `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.
+ #
+ #
+ # `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
@@ -1758,9 +1673,23 @@
# 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.
+ "maxAttempts": 42, # Number of attempts per task.
#
- # A task's retry interval starts at
+ # 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 >= -1.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # -1 indicates unlimited attempts.
+ #
+ # This field has the same meaning as
+ # [task_retry_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
@@ -1784,53 +1713,143 @@
# 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).
- "maxAttempts": 42, # Number of attempts per task.
+ },
+ "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`.
+ "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 task
+ # attempts 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).
+ #
+ # The queue's actual dispatch rate is the result of:
+ #
+ # * Number of tasks in the queue
+ # * User-specified throttling: rate_limits,
+ # retry_config, and the
+ # queue's state.
+ # * System throttling due to `429` (Too Many Requests) or `503` (Service
+ # Unavailable) responses from the worker, high error rates, or to smooth
+ # sudden large traffic spikes.
+ #
+ # 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.
+ "maxBurstSize": 42, # Output only. The max burst size.
#
- # 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 >= -1.
+ # 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.
#
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
+ # 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_dispatches_per_second.
#
- # -1 indicates unlimited attempts.
+ # Cloud Tasks will pick the value of `max_burst_size` based on the
+ # value of
+ # max_dispatches_per_second.
#
- # This field has the same meaning as
- # [task_retry_limit 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.
+ # 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_dispatches_per_second,
+ # regardless of whether
+ # max_dispatches_per_second
+ # is updated.
+ "maxConcurrentDispatches": 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.
#
#
- # `max_backoff` will be truncated to the nearest second.
+ # The maximum allowed value is 5,000.
+ #
#
# 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).
- "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).
+ "maxDispatchesPerSecond": 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.
#
- # `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).
+ # [rate in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
+ },
+ "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
+ # field is unset, then no logs are written.
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ "samplingRatio": 3.14, # Specifies the fraction of operations to write to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ # This field may contain any value between 0.0 and 1.0, inclusive.
+ # 0.0 is the default and means that no operations are logged.
},
},
],
+ "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>
@@ -1843,7 +1862,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>
@@ -1880,7 +1899,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/.
@@ -1892,150 +1911,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, queue 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.
- "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
- # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
- # field is unset, then no logs are written.
- # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
- "samplingRatio": 3.14, # Specifies the fraction of operations to write to
- # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
- # This field may contain any value between 0.0 and 1.0, inclusive.
- # 0.0 is the default and means that no operations are logged.
- },
- "rateLimits": { # Rate limits. # Rate limits for task dispatches.
- #
- # rate_limits and retry_config are
- # related because they both control task attempts. However they control task
- # attempts 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).
- #
- # The queue's actual dispatch rate is the result of:
- #
- # * Number of tasks in the queue
- # * User-specified throttling: rate_limits,
- # retry_config, and the
- # queue's state.
- # * System throttling due to `429` (Too Many Requests) or `503` (Service
- # Unavailable) responses from the worker, high error rates, or to smooth
- # sudden large traffic spikes.
- #
- # 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.
- "maxConcurrentDispatches": 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 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_dispatches_per_second.
- #
- # Cloud Tasks will pick the value of `max_burst_size` based on the
- # value of
- # max_dispatches_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_dispatches_per_second,
- # regardless of whether
- # max_dispatches_per_second
- # is updated.
- "maxDispatchesPerSecond": 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 has the same meaning as
- # [rate in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
- },
- "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.
- #
- # All tasks that were created before this time
- # were purged.
- #
- # A queue can be purged using PurgeQueue, the
- # [App Engine Task Queue SDK, or the Cloud
- # Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
- #
- # Purge time will be truncated to the nearest microsecond. Purge
- # time will be unset if the queue has never been purged.
- "appEngineHttpQueue": { # App Engine HTTP queue. # AppEngineHttpQueue settings apply only to
+ "appEngineHttpQueue": { # App Engine HTTP queue. # AppEngineHttpQueue settings apply only to
# App Engine tasks in this queue.
# Http tasks are not affected by this proto.
#
# The task will be delivered to the App Engine application hostname
# specified by its AppEngineHttpQueue and AppEngineHttpRequest.
# The documentation for AppEngineHttpRequest explains how the
- # task's host URL is constructed.
+ # task's host URL is constructed.
#
# Using AppEngineHttpQueue requires
# [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
@@ -2043,7 +1926,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
@@ -2062,31 +1945,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.
- #
- # By default, the task is sent to an instance which is available when
- # the task is attempted.
- #
- # Requests can only be sent to a specific instance if
- # [manual scaling is used in App Engine
- # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
- # App Engine Flex does not support instances. For more information, see
- # [App Engine Standard request
- # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
- # and [App Engine Flex request
- # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "host": "A String", # Output only. The host that the task is sent to.
- #
- # The host is constructed from the domain name of the app associated with
- # the queue's project ID (for example <app-id>.appspot.com), and the
- # service, version,
- # and instance. Tasks which were created using
- # the App Engine SDK might have a custom domain name.
- #
- # For more information, see
- # [How Requests are
- # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
- "version": "A String", # App version.
+ "version": "A String", # App version.
#
# By default, the task is sent to the version which is the default
# version when the task is attempted.
@@ -2102,7 +1961,18 @@
# service,
# version, and
# instance are the empty string.
- "service": "A String", # App service.
+ "host": "A String", # Output only. The host that the task is sent to.
+ #
+ # The host is constructed from the domain name of the app associated with
+ # the queue's project ID (for example <app-id>.appspot.com), and the
+ # service, version,
+ # and instance. Tasks which were created using
+ # the App Engine SDK might have a custom domain name.
+ #
+ # For more information, see
+ # [How Requests are
+ # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -2118,9 +1988,33 @@
# service,
# version, and
# instance are the empty string.
+ "instance": "A String", # App instance.
+ #
+ # By default, the task is sent to an instance which is available when
+ # the task is attempted.
+ #
+ # Requests can only be sent to a specific instance if
+ # [manual scaling is used in App Engine
+ # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
+ # App Engine Flex does not support instances. For more information, see
+ # [App Engine Standard request
+ # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
+ # and [App Engine Flex request
+ # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
},
},
- "retryConfig": { # Retry config. # Settings that determine the retry behavior.
+ "purgeTime": "A String", # Output only. The last time this queue was purged.
+ #
+ # All tasks that were created before this time
+ # were purged.
+ #
+ # A queue can be purged using PurgeQueue, the
+ # [App Engine Task Queue SDK, or the Cloud
+ # Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
+ #
+ # 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.
#
# * For tasks created using Cloud Tasks: the queue-level retry settings
# apply to all tasks in the queue that were created using Cloud Tasks.
@@ -2132,7 +2026,37 @@
# documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
#
# These settings determine when a failed task attempt is retried.
- "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ "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.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # `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.
+ #
+ #
+ # `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
@@ -2150,9 +2074,23 @@
# 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.
+ "maxAttempts": 42, # Number of attempts per task.
#
- # A task's retry interval starts at
+ # 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 >= -1.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # -1 indicates unlimited attempts.
+ #
+ # This field has the same meaning as
+ # [task_retry_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
@@ -2176,50 +2114,131 @@
# 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).
- "maxAttempts": 42, # Number of attempts per task.
+ },
+ "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`.
+ "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 task
+ # attempts 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).
+ #
+ # The queue's actual dispatch rate is the result of:
+ #
+ # * Number of tasks in the queue
+ # * User-specified throttling: rate_limits,
+ # retry_config, and the
+ # queue's state.
+ # * System throttling due to `429` (Too Many Requests) or `503` (Service
+ # Unavailable) responses from the worker, high error rates, or to smooth
+ # sudden large traffic spikes.
+ #
+ # 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.
+ "maxBurstSize": 42, # Output only. The max burst size.
#
- # 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 >= -1.
+ # 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.
#
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
+ # 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_dispatches_per_second.
#
- # -1 indicates unlimited attempts.
+ # Cloud Tasks will pick the value of `max_burst_size` based on the
+ # value of
+ # max_dispatches_per_second.
#
- # This field has the same meaning as
- # [task_retry_limit 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.
+ # 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_dispatches_per_second,
+ # regardless of whether
+ # max_dispatches_per_second
+ # is updated.
+ "maxConcurrentDispatches": 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.
#
#
- # `max_backoff` will be truncated to the nearest second.
+ # The maximum allowed value is 5,000.
+ #
#
# 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).
- "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).
+ "maxDispatchesPerSecond": 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.
#
- # `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).
+ # [rate in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
+ },
+ "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
+ # field is unset, then no logs are written.
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ "samplingRatio": 3.14, # Specifies the fraction of operations to write to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ # This field may contain any value between 0.0 and 1.0, inclusive.
+ # 0.0 is the default and means that no operations are logged.
},
}
@@ -2237,150 +2256,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, queue 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.
- "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
- # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
- # field is unset, then no logs are written.
- # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
- "samplingRatio": 3.14, # Specifies the fraction of operations to write to
- # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
- # This field may contain any value between 0.0 and 1.0, inclusive.
- # 0.0 is the default and means that no operations are logged.
- },
- "rateLimits": { # Rate limits. # Rate limits for task dispatches.
- #
- # rate_limits and retry_config are
- # related because they both control task attempts. However they control task
- # attempts 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).
- #
- # The queue's actual dispatch rate is the result of:
- #
- # * Number of tasks in the queue
- # * User-specified throttling: rate_limits,
- # retry_config, and the
- # queue's state.
- # * System throttling due to `429` (Too Many Requests) or `503` (Service
- # Unavailable) responses from the worker, high error rates, or to smooth
- # sudden large traffic spikes.
- #
- # 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.
- "maxConcurrentDispatches": 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 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_dispatches_per_second.
- #
- # Cloud Tasks will pick the value of `max_burst_size` based on the
- # value of
- # max_dispatches_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_dispatches_per_second,
- # regardless of whether
- # max_dispatches_per_second
- # is updated.
- "maxDispatchesPerSecond": 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 has the same meaning as
- # [rate in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
- },
- "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.
- #
- # All tasks that were created before this time
- # were purged.
- #
- # A queue can be purged using PurgeQueue, the
- # [App Engine Task Queue SDK, or the Cloud
- # Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
- #
- # Purge time will be truncated to the nearest microsecond. Purge
- # time will be unset if the queue has never been purged.
- "appEngineHttpQueue": { # App Engine HTTP queue. # AppEngineHttpQueue settings apply only to
+ "appEngineHttpQueue": { # App Engine HTTP queue. # AppEngineHttpQueue settings apply only to
# App Engine tasks in this queue.
# Http tasks are not affected by this proto.
#
# The task will be delivered to the App Engine application hostname
# specified by its AppEngineHttpQueue and AppEngineHttpRequest.
# The documentation for AppEngineHttpRequest explains how the
- # task's host URL is constructed.
+ # task's host URL is constructed.
#
# Using AppEngineHttpQueue requires
# [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
@@ -2388,7 +2271,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
@@ -2407,31 +2290,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.
- #
- # By default, the task is sent to an instance which is available when
- # the task is attempted.
- #
- # Requests can only be sent to a specific instance if
- # [manual scaling is used in App Engine
- # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
- # App Engine Flex does not support instances. For more information, see
- # [App Engine Standard request
- # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
- # and [App Engine Flex request
- # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "host": "A String", # Output only. The host that the task is sent to.
- #
- # The host is constructed from the domain name of the app associated with
- # the queue's project ID (for example <app-id>.appspot.com), and the
- # service, version,
- # and instance. Tasks which were created using
- # the App Engine SDK might have a custom domain name.
- #
- # For more information, see
- # [How Requests are
- # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
- "version": "A String", # App version.
+ "version": "A String", # App version.
#
# By default, the task is sent to the version which is the default
# version when the task is attempted.
@@ -2447,7 +2306,18 @@
# service,
# version, and
# instance are the empty string.
- "service": "A String", # App service.
+ "host": "A String", # Output only. The host that the task is sent to.
+ #
+ # The host is constructed from the domain name of the app associated with
+ # the queue's project ID (for example <app-id>.appspot.com), and the
+ # service, version,
+ # and instance. Tasks which were created using
+ # the App Engine SDK might have a custom domain name.
+ #
+ # For more information, see
+ # [How Requests are
+ # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -2463,9 +2333,33 @@
# service,
# version, and
# instance are the empty string.
+ "instance": "A String", # App instance.
+ #
+ # By default, the task is sent to an instance which is available when
+ # the task is attempted.
+ #
+ # Requests can only be sent to a specific instance if
+ # [manual scaling is used in App Engine
+ # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
+ # App Engine Flex does not support instances. For more information, see
+ # [App Engine Standard request
+ # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
+ # and [App Engine Flex request
+ # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
},
},
- "retryConfig": { # Retry config. # Settings that determine the retry behavior.
+ "purgeTime": "A String", # Output only. The last time this queue was purged.
+ #
+ # All tasks that were created before this time
+ # were purged.
+ #
+ # A queue can be purged using PurgeQueue, the
+ # [App Engine Task Queue SDK, or the Cloud
+ # Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
+ #
+ # 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.
#
# * For tasks created using Cloud Tasks: the queue-level retry settings
# apply to all tasks in the queue that were created using Cloud Tasks.
@@ -2477,7 +2371,37 @@
# documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
#
# These settings determine when a failed task attempt is retried.
- "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ "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.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # `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.
+ #
+ #
+ # `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
@@ -2495,9 +2419,23 @@
# 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.
+ "maxAttempts": 42, # Number of attempts per task.
#
- # A task's retry interval starts at
+ # 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 >= -1.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # -1 indicates unlimited attempts.
+ #
+ # This field has the same meaning as
+ # [task_retry_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
@@ -2521,50 +2459,131 @@
# 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).
- "maxAttempts": 42, # Number of attempts per task.
+ },
+ "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`.
+ "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 task
+ # attempts 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).
+ #
+ # The queue's actual dispatch rate is the result of:
+ #
+ # * Number of tasks in the queue
+ # * User-specified throttling: rate_limits,
+ # retry_config, and the
+ # queue's state.
+ # * System throttling due to `429` (Too Many Requests) or `503` (Service
+ # Unavailable) responses from the worker, high error rates, or to smooth
+ # sudden large traffic spikes.
+ #
+ # 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.
+ "maxBurstSize": 42, # Output only. The max burst size.
#
- # 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 >= -1.
+ # 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.
#
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
+ # 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_dispatches_per_second.
#
- # -1 indicates unlimited attempts.
+ # Cloud Tasks will pick the value of `max_burst_size` based on the
+ # value of
+ # max_dispatches_per_second.
#
- # This field has the same meaning as
- # [task_retry_limit 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.
+ # 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_dispatches_per_second,
+ # regardless of whether
+ # max_dispatches_per_second
+ # is updated.
+ "maxConcurrentDispatches": 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.
#
#
- # `max_backoff` will be truncated to the nearest second.
+ # The maximum allowed value is 5,000.
+ #
#
# 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).
- "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).
+ "maxDispatchesPerSecond": 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.
#
- # `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).
+ # [rate in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
+ },
+ "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
+ # field is unset, then no logs are written.
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ "samplingRatio": 3.14, # Specifies the fraction of operations to write to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ # This field may contain any value between 0.0 and 1.0, inclusive.
+ # 0.0 is the default and means that no operations are logged.
},
}</pre>
</div>
@@ -2599,150 +2618,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, queue 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.
- "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
- # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
- # field is unset, then no logs are written.
- # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
- "samplingRatio": 3.14, # Specifies the fraction of operations to write to
- # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
- # This field may contain any value between 0.0 and 1.0, inclusive.
- # 0.0 is the default and means that no operations are logged.
- },
- "rateLimits": { # Rate limits. # Rate limits for task dispatches.
- #
- # rate_limits and retry_config are
- # related because they both control task attempts. However they control task
- # attempts 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).
- #
- # The queue's actual dispatch rate is the result of:
- #
- # * Number of tasks in the queue
- # * User-specified throttling: rate_limits,
- # retry_config, and the
- # queue's state.
- # * System throttling due to `429` (Too Many Requests) or `503` (Service
- # Unavailable) responses from the worker, high error rates, or to smooth
- # sudden large traffic spikes.
- #
- # 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.
- "maxConcurrentDispatches": 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 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_dispatches_per_second.
- #
- # Cloud Tasks will pick the value of `max_burst_size` based on the
- # value of
- # max_dispatches_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_dispatches_per_second,
- # regardless of whether
- # max_dispatches_per_second
- # is updated.
- "maxDispatchesPerSecond": 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 has the same meaning as
- # [rate in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
- },
- "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.
- #
- # All tasks that were created before this time
- # were purged.
- #
- # A queue can be purged using PurgeQueue, the
- # [App Engine Task Queue SDK, or the Cloud
- # Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
- #
- # Purge time will be truncated to the nearest microsecond. Purge
- # time will be unset if the queue has never been purged.
- "appEngineHttpQueue": { # App Engine HTTP queue. # AppEngineHttpQueue settings apply only to
+ "appEngineHttpQueue": { # App Engine HTTP queue. # AppEngineHttpQueue settings apply only to
# App Engine tasks in this queue.
# Http tasks are not affected by this proto.
#
# The task will be delivered to the App Engine application hostname
# specified by its AppEngineHttpQueue and AppEngineHttpRequest.
# The documentation for AppEngineHttpRequest explains how the
- # task's host URL is constructed.
+ # task's host URL is constructed.
#
# Using AppEngineHttpQueue requires
# [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
@@ -2750,7 +2633,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
@@ -2769,31 +2652,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.
- #
- # By default, the task is sent to an instance which is available when
- # the task is attempted.
- #
- # Requests can only be sent to a specific instance if
- # [manual scaling is used in App Engine
- # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
- # App Engine Flex does not support instances. For more information, see
- # [App Engine Standard request
- # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
- # and [App Engine Flex request
- # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "host": "A String", # Output only. The host that the task is sent to.
- #
- # The host is constructed from the domain name of the app associated with
- # the queue's project ID (for example <app-id>.appspot.com), and the
- # service, version,
- # and instance. Tasks which were created using
- # the App Engine SDK might have a custom domain name.
- #
- # For more information, see
- # [How Requests are
- # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
- "version": "A String", # App version.
+ "version": "A String", # App version.
#
# By default, the task is sent to the version which is the default
# version when the task is attempted.
@@ -2809,7 +2668,18 @@
# service,
# version, and
# instance are the empty string.
- "service": "A String", # App service.
+ "host": "A String", # Output only. The host that the task is sent to.
+ #
+ # The host is constructed from the domain name of the app associated with
+ # the queue's project ID (for example <app-id>.appspot.com), and the
+ # service, version,
+ # and instance. Tasks which were created using
+ # the App Engine SDK might have a custom domain name.
+ #
+ # For more information, see
+ # [How Requests are
+ # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -2825,9 +2695,33 @@
# service,
# version, and
# instance are the empty string.
+ "instance": "A String", # App instance.
+ #
+ # By default, the task is sent to an instance which is available when
+ # the task is attempted.
+ #
+ # Requests can only be sent to a specific instance if
+ # [manual scaling is used in App Engine
+ # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
+ # App Engine Flex does not support instances. For more information, see
+ # [App Engine Standard request
+ # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
+ # and [App Engine Flex request
+ # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
},
},
- "retryConfig": { # Retry config. # Settings that determine the retry behavior.
+ "purgeTime": "A String", # Output only. The last time this queue was purged.
+ #
+ # All tasks that were created before this time
+ # were purged.
+ #
+ # A queue can be purged using PurgeQueue, the
+ # [App Engine Task Queue SDK, or the Cloud
+ # Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
+ #
+ # 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.
#
# * For tasks created using Cloud Tasks: the queue-level retry settings
# apply to all tasks in the queue that were created using Cloud Tasks.
@@ -2839,7 +2733,37 @@
# documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
#
# These settings determine when a failed task attempt is retried.
- "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ "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.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # `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.
+ #
+ #
+ # `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
@@ -2857,9 +2781,23 @@
# 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.
+ "maxAttempts": 42, # Number of attempts per task.
#
- # A task's retry interval starts at
+ # 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 >= -1.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # -1 indicates unlimited attempts.
+ #
+ # This field has the same meaning as
+ # [task_retry_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
@@ -2883,50 +2821,131 @@
# 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).
- "maxAttempts": 42, # Number of attempts per task.
+ },
+ "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`.
+ "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 task
+ # attempts 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).
+ #
+ # The queue's actual dispatch rate is the result of:
+ #
+ # * Number of tasks in the queue
+ # * User-specified throttling: rate_limits,
+ # retry_config, and the
+ # queue's state.
+ # * System throttling due to `429` (Too Many Requests) or `503` (Service
+ # Unavailable) responses from the worker, high error rates, or to smooth
+ # sudden large traffic spikes.
+ #
+ # 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.
+ "maxBurstSize": 42, # Output only. The max burst size.
#
- # 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 >= -1.
+ # 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.
#
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
+ # 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_dispatches_per_second.
#
- # -1 indicates unlimited attempts.
+ # Cloud Tasks will pick the value of `max_burst_size` based on the
+ # value of
+ # max_dispatches_per_second.
#
- # This field has the same meaning as
- # [task_retry_limit 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.
+ # 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_dispatches_per_second,
+ # regardless of whether
+ # max_dispatches_per_second
+ # is updated.
+ "maxConcurrentDispatches": 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.
#
#
- # `max_backoff` will be truncated to the nearest second.
+ # The maximum allowed value is 5,000.
+ #
#
# 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).
- "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).
+ "maxDispatchesPerSecond": 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.
#
- # `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).
+ # [rate in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
+ },
+ "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
+ # field is unset, then no logs are written.
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ "samplingRatio": 3.14, # Specifies the fraction of operations to write to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ # This field may contain any value between 0.0 and 1.0, inclusive.
+ # 0.0 is the default and means that no operations are logged.
},
}</pre>
</div>
@@ -2960,150 +2979,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, queue 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.
- "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
- # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
- # field is unset, then no logs are written.
- # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
- "samplingRatio": 3.14, # Specifies the fraction of operations to write to
- # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
- # This field may contain any value between 0.0 and 1.0, inclusive.
- # 0.0 is the default and means that no operations are logged.
- },
- "rateLimits": { # Rate limits. # Rate limits for task dispatches.
- #
- # rate_limits and retry_config are
- # related because they both control task attempts. However they control task
- # attempts 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).
- #
- # The queue's actual dispatch rate is the result of:
- #
- # * Number of tasks in the queue
- # * User-specified throttling: rate_limits,
- # retry_config, and the
- # queue's state.
- # * System throttling due to `429` (Too Many Requests) or `503` (Service
- # Unavailable) responses from the worker, high error rates, or to smooth
- # sudden large traffic spikes.
- #
- # 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.
- "maxConcurrentDispatches": 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 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_dispatches_per_second.
- #
- # Cloud Tasks will pick the value of `max_burst_size` based on the
- # value of
- # max_dispatches_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_dispatches_per_second,
- # regardless of whether
- # max_dispatches_per_second
- # is updated.
- "maxDispatchesPerSecond": 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 has the same meaning as
- # [rate in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
- },
- "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.
- #
- # All tasks that were created before this time
- # were purged.
- #
- # A queue can be purged using PurgeQueue, the
- # [App Engine Task Queue SDK, or the Cloud
- # Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
- #
- # Purge time will be truncated to the nearest microsecond. Purge
- # time will be unset if the queue has never been purged.
- "appEngineHttpQueue": { # App Engine HTTP queue. # AppEngineHttpQueue settings apply only to
+ "appEngineHttpQueue": { # App Engine HTTP queue. # AppEngineHttpQueue settings apply only to
# App Engine tasks in this queue.
# Http tasks are not affected by this proto.
#
# The task will be delivered to the App Engine application hostname
# specified by its AppEngineHttpQueue and AppEngineHttpRequest.
# The documentation for AppEngineHttpRequest explains how the
- # task's host URL is constructed.
+ # task's host URL is constructed.
#
# Using AppEngineHttpQueue requires
# [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
@@ -3111,7 +2994,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
@@ -3130,31 +3013,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.
- #
- # By default, the task is sent to an instance which is available when
- # the task is attempted.
- #
- # Requests can only be sent to a specific instance if
- # [manual scaling is used in App Engine
- # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
- # App Engine Flex does not support instances. For more information, see
- # [App Engine Standard request
- # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
- # and [App Engine Flex request
- # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "host": "A String", # Output only. The host that the task is sent to.
- #
- # The host is constructed from the domain name of the app associated with
- # the queue's project ID (for example <app-id>.appspot.com), and the
- # service, version,
- # and instance. Tasks which were created using
- # the App Engine SDK might have a custom domain name.
- #
- # For more information, see
- # [How Requests are
- # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
- "version": "A String", # App version.
+ "version": "A String", # App version.
#
# By default, the task is sent to the version which is the default
# version when the task is attempted.
@@ -3170,7 +3029,18 @@
# service,
# version, and
# instance are the empty string.
- "service": "A String", # App service.
+ "host": "A String", # Output only. The host that the task is sent to.
+ #
+ # The host is constructed from the domain name of the app associated with
+ # the queue's project ID (for example <app-id>.appspot.com), and the
+ # service, version,
+ # and instance. Tasks which were created using
+ # the App Engine SDK might have a custom domain name.
+ #
+ # For more information, see
+ # [How Requests are
+ # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -3186,9 +3056,33 @@
# service,
# version, and
# instance are the empty string.
+ "instance": "A String", # App instance.
+ #
+ # By default, the task is sent to an instance which is available when
+ # the task is attempted.
+ #
+ # Requests can only be sent to a specific instance if
+ # [manual scaling is used in App Engine
+ # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
+ # App Engine Flex does not support instances. For more information, see
+ # [App Engine Standard request
+ # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
+ # and [App Engine Flex request
+ # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
},
},
- "retryConfig": { # Retry config. # Settings that determine the retry behavior.
+ "purgeTime": "A String", # Output only. The last time this queue was purged.
+ #
+ # All tasks that were created before this time
+ # were purged.
+ #
+ # A queue can be purged using PurgeQueue, the
+ # [App Engine Task Queue SDK, or the Cloud
+ # Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
+ #
+ # 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.
#
# * For tasks created using Cloud Tasks: the queue-level retry settings
# apply to all tasks in the queue that were created using Cloud Tasks.
@@ -3200,7 +3094,37 @@
# documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
#
# These settings determine when a failed task attempt is retried.
- "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ "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.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # `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.
+ #
+ #
+ # `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
@@ -3218,9 +3142,23 @@
# 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.
+ "maxAttempts": 42, # Number of attempts per task.
#
- # A task's retry interval starts at
+ # 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 >= -1.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # -1 indicates unlimited attempts.
+ #
+ # This field has the same meaning as
+ # [task_retry_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
@@ -3244,50 +3182,131 @@
# 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).
- "maxAttempts": 42, # Number of attempts per task.
+ },
+ "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`.
+ "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 task
+ # attempts 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).
+ #
+ # The queue's actual dispatch rate is the result of:
+ #
+ # * Number of tasks in the queue
+ # * User-specified throttling: rate_limits,
+ # retry_config, and the
+ # queue's state.
+ # * System throttling due to `429` (Too Many Requests) or `503` (Service
+ # Unavailable) responses from the worker, high error rates, or to smooth
+ # sudden large traffic spikes.
+ #
+ # 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.
+ "maxBurstSize": 42, # Output only. The max burst size.
#
- # 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 >= -1.
+ # 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.
#
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
+ # 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_dispatches_per_second.
#
- # -1 indicates unlimited attempts.
+ # Cloud Tasks will pick the value of `max_burst_size` based on the
+ # value of
+ # max_dispatches_per_second.
#
- # This field has the same meaning as
- # [task_retry_limit 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.
+ # 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_dispatches_per_second,
+ # regardless of whether
+ # max_dispatches_per_second
+ # is updated.
+ "maxConcurrentDispatches": 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.
#
#
- # `max_backoff` will be truncated to the nearest second.
+ # The maximum allowed value is 5,000.
+ #
#
# 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).
- "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).
+ "maxDispatchesPerSecond": 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.
#
- # `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).
+ # [rate in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
+ },
+ "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
+ # field is unset, then no logs are written.
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ "samplingRatio": 3.14, # Specifies the fraction of operations to write to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ # This field may contain any value between 0.0 and 1.0, inclusive.
+ # 0.0 is the default and means that no operations are logged.
},
}</pre>
</div>
@@ -3299,7 +3318,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
@@ -3328,150 +3347,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, queue 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.
- "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
- # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
- # field is unset, then no logs are written.
- # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
- "samplingRatio": 3.14, # Specifies the fraction of operations to write to
- # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
- # This field may contain any value between 0.0 and 1.0, inclusive.
- # 0.0 is the default and means that no operations are logged.
- },
- "rateLimits": { # Rate limits. # Rate limits for task dispatches.
- #
- # rate_limits and retry_config are
- # related because they both control task attempts. However they control task
- # attempts 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).
- #
- # The queue's actual dispatch rate is the result of:
- #
- # * Number of tasks in the queue
- # * User-specified throttling: rate_limits,
- # retry_config, and the
- # queue's state.
- # * System throttling due to `429` (Too Many Requests) or `503` (Service
- # Unavailable) responses from the worker, high error rates, or to smooth
- # sudden large traffic spikes.
- #
- # 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.
- "maxConcurrentDispatches": 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 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_dispatches_per_second.
- #
- # Cloud Tasks will pick the value of `max_burst_size` based on the
- # value of
- # max_dispatches_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_dispatches_per_second,
- # regardless of whether
- # max_dispatches_per_second
- # is updated.
- "maxDispatchesPerSecond": 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 has the same meaning as
- # [rate in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
- },
- "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.
- #
- # All tasks that were created before this time
- # were purged.
- #
- # A queue can be purged using PurgeQueue, the
- # [App Engine Task Queue SDK, or the Cloud
- # Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
- #
- # Purge time will be truncated to the nearest microsecond. Purge
- # time will be unset if the queue has never been purged.
- "appEngineHttpQueue": { # App Engine HTTP queue. # AppEngineHttpQueue settings apply only to
+ "appEngineHttpQueue": { # App Engine HTTP queue. # AppEngineHttpQueue settings apply only to
# App Engine tasks in this queue.
# Http tasks are not affected by this proto.
#
# The task will be delivered to the App Engine application hostname
# specified by its AppEngineHttpQueue and AppEngineHttpRequest.
# The documentation for AppEngineHttpRequest explains how the
- # task's host URL is constructed.
+ # task's host URL is constructed.
#
# Using AppEngineHttpQueue requires
# [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
@@ -3479,7 +3362,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
@@ -3498,31 +3381,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.
- #
- # By default, the task is sent to an instance which is available when
- # the task is attempted.
- #
- # Requests can only be sent to a specific instance if
- # [manual scaling is used in App Engine
- # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
- # App Engine Flex does not support instances. For more information, see
- # [App Engine Standard request
- # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
- # and [App Engine Flex request
- # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "host": "A String", # Output only. The host that the task is sent to.
- #
- # The host is constructed from the domain name of the app associated with
- # the queue's project ID (for example <app-id>.appspot.com), and the
- # service, version,
- # and instance. Tasks which were created using
- # the App Engine SDK might have a custom domain name.
- #
- # For more information, see
- # [How Requests are
- # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
- "version": "A String", # App version.
+ "version": "A String", # App version.
#
# By default, the task is sent to the version which is the default
# version when the task is attempted.
@@ -3538,7 +3397,18 @@
# service,
# version, and
# instance are the empty string.
- "service": "A String", # App service.
+ "host": "A String", # Output only. The host that the task is sent to.
+ #
+ # The host is constructed from the domain name of the app associated with
+ # the queue's project ID (for example <app-id>.appspot.com), and the
+ # service, version,
+ # and instance. Tasks which were created using
+ # the App Engine SDK might have a custom domain name.
+ #
+ # For more information, see
+ # [How Requests are
+ # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -3554,9 +3424,33 @@
# service,
# version, and
# instance are the empty string.
+ "instance": "A String", # App instance.
+ #
+ # By default, the task is sent to an instance which is available when
+ # the task is attempted.
+ #
+ # Requests can only be sent to a specific instance if
+ # [manual scaling is used in App Engine
+ # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
+ # App Engine Flex does not support instances. For more information, see
+ # [App Engine Standard request
+ # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
+ # and [App Engine Flex request
+ # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
},
},
- "retryConfig": { # Retry config. # Settings that determine the retry behavior.
+ "purgeTime": "A String", # Output only. The last time this queue was purged.
+ #
+ # All tasks that were created before this time
+ # were purged.
+ #
+ # A queue can be purged using PurgeQueue, the
+ # [App Engine Task Queue SDK, or the Cloud
+ # Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
+ #
+ # 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.
#
# * For tasks created using Cloud Tasks: the queue-level retry settings
# apply to all tasks in the queue that were created using Cloud Tasks.
@@ -3568,7 +3462,37 @@
# documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
#
# These settings determine when a failed task attempt is retried.
- "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ "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.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # `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.
+ #
+ #
+ # `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
@@ -3586,9 +3510,23 @@
# 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.
+ "maxAttempts": 42, # Number of attempts per task.
#
- # A task's retry interval starts at
+ # 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 >= -1.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # -1 indicates unlimited attempts.
+ #
+ # This field has the same meaning as
+ # [task_retry_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
@@ -3612,50 +3550,131 @@
# 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).
- "maxAttempts": 42, # Number of attempts per task.
+ },
+ "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`.
+ "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 task
+ # attempts 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).
+ #
+ # The queue's actual dispatch rate is the result of:
+ #
+ # * Number of tasks in the queue
+ # * User-specified throttling: rate_limits,
+ # retry_config, and the
+ # queue's state.
+ # * System throttling due to `429` (Too Many Requests) or `503` (Service
+ # Unavailable) responses from the worker, high error rates, or to smooth
+ # sudden large traffic spikes.
+ #
+ # 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.
+ "maxBurstSize": 42, # Output only. The max burst size.
#
- # 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 >= -1.
+ # 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.
#
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
+ # 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_dispatches_per_second.
#
- # -1 indicates unlimited attempts.
+ # Cloud Tasks will pick the value of `max_burst_size` based on the
+ # value of
+ # max_dispatches_per_second.
#
- # This field has the same meaning as
- # [task_retry_limit 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.
+ # 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_dispatches_per_second,
+ # regardless of whether
+ # max_dispatches_per_second
+ # is updated.
+ "maxConcurrentDispatches": 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.
#
#
- # `max_backoff` will be truncated to the nearest second.
+ # The maximum allowed value is 5,000.
+ #
#
# 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).
- "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).
+ "maxDispatchesPerSecond": 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.
#
- # `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).
+ # [rate in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
+ },
+ "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
+ # field is unset, then no logs are written.
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ "samplingRatio": 3.14, # Specifies the fraction of operations to write to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ # This field may contain any value between 0.0 and 1.0, inclusive.
+ # 0.0 is the default and means that no operations are logged.
},
}</pre>
</div>
@@ -3681,7 +3700,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.
@@ -3694,36 +3713,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:**
@@ -3741,63 +3764,93 @@
# 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
+ "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`.
- # 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.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
+ "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
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
# syntax.
- "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.
- "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.
},
- "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
@@ -3840,11 +3893,13 @@
# * `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",
],
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ "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
@@ -3856,27 +3911,6 @@
# 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.
},
}
@@ -3898,36 +3932,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:**
@@ -3945,63 +3983,93 @@
# 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
+ "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`.
- # 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.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
+ "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
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
# syntax.
- "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.
- "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.
},
- "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
@@ -4044,11 +4112,13 @@
# * `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",
],
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ "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
@@ -4060,27 +4130,6 @@
# 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.
}</pre>
</div>
@@ -4092,7 +4141,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.
@@ -4101,11 +4150,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",
],
}
@@ -4118,9 +4167,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>