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_v2.projects.locations.queues.html b/docs/dyn/cloudtasks_v2.projects.locations.queues.html
index 07af78f..8a0283a 100644
--- a/docs/dyn/cloudtasks_v2.projects.locations.queues.html
+++ b/docs/dyn/cloudtasks_v2.projects.locations.queues.html
@@ -92,7 +92,7 @@
<code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the access control policy for a Queue.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</a></code></p>
+ <code><a href="#list">list(parent, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists queues.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -136,7 +136,7 @@
For example: `projects/PROJECT_ID/locations/LOCATION_ID`
The list of allowed locations can be obtained by calling Cloud
-Tasks' implementation of
+Tasks' implementation of
ListLocations. (required)
body: object, The request body.
The object takes the form of:
@@ -144,7 +144,126 @@
{ # 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,
+ "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.
+ # Retry settings cannot be set on individual tasks.
+ # * For tasks created using the App Engine SDK: the queue-level retry
+ # settings apply to all tasks in the queue which do not have retry settings
+ # explicitly set on the task and were created by the App Engine SDK. See
+ # [App Engine
+ # documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
+ #
+ # These settings determine when a failed task attempt is retried.
+ "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
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # `max_retry_duration` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [task_age_limit in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxAttempts": 42, # Number of attempts per task.
+ #
+ # Cloud Tasks will attempt the task `max_attempts` times (that is, if the
+ # first attempt fails, then there will be `max_attempts - 1` retries). Must
+ # be >= -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
+ # max_backoff up to
+ # max_attempts times.
+ #
+ # For example, if min_backoff is 10s,
+ # max_backoff is 300s, and
+ # `max_doublings` is 3, then the a task will first be retried in
+ # 10s. The retry interval will double three times, and then
+ # increase linearly by 2^3 * 10s. Finally, the task will retry at
+ # intervals of max_backoff until the
+ # task has been attempted max_attempts
+ # times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s,
+ # 240s, 300s, 300s, ....
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # 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).
+ },
+ "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.
@@ -157,22 +276,13 @@
# 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/.
# * `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.
+ "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
@@ -187,12 +297,12 @@
# retry_config controls task retries (the
# second attempt, third attempt, etc).
#
- # The queue's actual dispatch rate is the result of:
+ # 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.
+ # 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.
@@ -202,7 +312,7 @@
#
# 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
+ "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.
@@ -217,7 +327,18 @@
# 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.
+ "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.
+ #
+ # * 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).
+ "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
@@ -230,7 +351,7 @@
# 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
+ # the queue's bucket runs out of tokens. The bucket will be
# continuously refilled with new tokens based on
# max_dispatches_per_second.
#
@@ -249,19 +370,17 @@
# 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.
- #
- # * 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).
},
- "appEngineRoutingOverride": { # App Engine Routing. # Overrides for
+ "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.
+ },
+ "appEngineRoutingOverride": { # App Engine Routing. # Overrides for
# task-level app_engine_routing.
# These settings apply only to
# App Engine tasks in this queue.
@@ -291,47 +410,7 @@
# and the following scope:
#
# `https://www.googleapis.com/auth/cloud-platform`
- "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.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "service": "A String", # App service.
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -347,125 +426,46 @@
# service,
# version, and
# instance are the empty string.
- },
- "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.
- "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.
- # Retry settings cannot be set on individual tasks.
- # * For tasks created using the App Engine SDK: the queue-level retry
- # settings apply to all tasks in the queue which do not have retry settings
- # explicitly set on the task and were created by the App Engine SDK. See
- # [App Engine
- # 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
- # retrying a failed task, measured from when the task was first
- # attempted. Once `max_retry_duration` time has passed *and* the
- # task has been attempted max_attempts
- # times, no further attempts will be made and the task will be
- # deleted.
+ "instance": "A String", # App instance.
#
- # If zero, then the task age is unlimited.
+ # By default, the task is sent to an instance which is available when
+ # the task is attempted.
#
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
+ # 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).
+ "version": "A String", # App version.
#
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
#
- # `max_retry_duration` will be truncated to the nearest second.
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
#
- # 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.
+ # 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.
#
- # A task's retry interval starts at
- # min_backoff, then doubles
- # `max_doublings` times, then increases linearly, and finally
- # retries at intervals of
- # max_backoff up to
- # max_attempts times.
- #
- # For example, if min_backoff is 10s,
- # max_backoff is 300s, and
- # `max_doublings` is 3, then the a task will first be retried in
- # 10s. The retry interval will double three times, and then
- # increase linearly by 2^3 * 10s. Finally, the task will retry at
- # intervals of max_backoff until the
- # task has been attempted max_attempts
- # times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s,
- # 240s, 300s, 300s, ....
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- #
- # 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.
- #
- # 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).
- "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).
- "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).
+ # For more information, see
+ # [How Requests are
+ # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
},
}
@@ -480,7 +480,126 @@
{ # 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,
+ "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.
+ # Retry settings cannot be set on individual tasks.
+ # * For tasks created using the App Engine SDK: the queue-level retry
+ # settings apply to all tasks in the queue which do not have retry settings
+ # explicitly set on the task and were created by the App Engine SDK. See
+ # [App Engine
+ # documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
+ #
+ # These settings determine when a failed task attempt is retried.
+ "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
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # `max_retry_duration` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [task_age_limit in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxAttempts": 42, # Number of attempts per task.
+ #
+ # Cloud Tasks will attempt the task `max_attempts` times (that is, if the
+ # first attempt fails, then there will be `max_attempts - 1` retries). Must
+ # be >= -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
+ # max_backoff up to
+ # max_attempts times.
+ #
+ # For example, if min_backoff is 10s,
+ # max_backoff is 300s, and
+ # `max_doublings` is 3, then the a task will first be retried in
+ # 10s. The retry interval will double three times, and then
+ # increase linearly by 2^3 * 10s. Finally, the task will retry at
+ # intervals of max_backoff until the
+ # task has been attempted max_attempts
+ # times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s,
+ # 240s, 300s, 300s, ....
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # 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).
+ },
+ "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.
@@ -493,22 +612,13 @@
# 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/.
# * `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.
+ "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
@@ -523,12 +633,12 @@
# retry_config controls task retries (the
# second attempt, third attempt, etc).
#
- # The queue's actual dispatch rate is the result of:
+ # 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.
+ # 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.
@@ -538,7 +648,7 @@
#
# 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
+ "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.
@@ -553,7 +663,18 @@
# 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.
+ "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.
+ #
+ # * 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).
+ "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
@@ -566,7 +687,7 @@
# 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
+ # the queue's bucket runs out of tokens. The bucket will be
# continuously refilled with new tokens based on
# max_dispatches_per_second.
#
@@ -585,19 +706,17 @@
# 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.
- #
- # * 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).
},
- "appEngineRoutingOverride": { # App Engine Routing. # Overrides for
+ "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.
+ },
+ "appEngineRoutingOverride": { # App Engine Routing. # Overrides for
# task-level app_engine_routing.
# These settings apply only to
# App Engine tasks in this queue.
@@ -627,47 +746,7 @@
# and the following scope:
#
# `https://www.googleapis.com/auth/cloud-platform`
- "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.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "service": "A String", # App service.
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -683,125 +762,46 @@
# service,
# version, and
# instance are the empty string.
- },
- "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.
- "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.
- # Retry settings cannot be set on individual tasks.
- # * For tasks created using the App Engine SDK: the queue-level retry
- # settings apply to all tasks in the queue which do not have retry settings
- # explicitly set on the task and were created by the App Engine SDK. See
- # [App Engine
- # 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
- # retrying a failed task, measured from when the task was first
- # attempted. Once `max_retry_duration` time has passed *and* the
- # task has been attempted max_attempts
- # times, no further attempts will be made and the task will be
- # deleted.
+ "instance": "A String", # App instance.
#
- # If zero, then the task age is unlimited.
+ # By default, the task is sent to an instance which is available when
+ # the task is attempted.
#
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
+ # 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).
+ "version": "A String", # App version.
#
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
#
- # `max_retry_duration` will be truncated to the nearest second.
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
#
- # 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.
+ # 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.
#
- # A task's retry interval starts at
- # min_backoff, then doubles
- # `max_doublings` times, then increases linearly, and finally
- # retries at intervals of
- # max_backoff up to
- # max_attempts times.
- #
- # For example, if min_backoff is 10s,
- # max_backoff is 300s, and
- # `max_doublings` is 3, then the a task will first be retried in
- # 10s. The retry interval will double three times, and then
- # increase linearly by 2^3 * 10s. Finally, the task will retry at
- # intervals of max_backoff until the
- # task has been attempted max_attempts
- # times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s,
- # 240s, 300s, 300s, ....
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- #
- # 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.
- #
- # 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).
- "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).
- "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).
+ # For more information, see
+ # [How Requests are
+ # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
},
}</pre>
</div>
@@ -812,7 +812,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
@@ -863,7 +863,126 @@
{ # 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,
+ "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.
+ # Retry settings cannot be set on individual tasks.
+ # * For tasks created using the App Engine SDK: the queue-level retry
+ # settings apply to all tasks in the queue which do not have retry settings
+ # explicitly set on the task and were created by the App Engine SDK. See
+ # [App Engine
+ # documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
+ #
+ # These settings determine when a failed task attempt is retried.
+ "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
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # `max_retry_duration` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [task_age_limit in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxAttempts": 42, # Number of attempts per task.
+ #
+ # Cloud Tasks will attempt the task `max_attempts` times (that is, if the
+ # first attempt fails, then there will be `max_attempts - 1` retries). Must
+ # be >= -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
+ # max_backoff up to
+ # max_attempts times.
+ #
+ # For example, if min_backoff is 10s,
+ # max_backoff is 300s, and
+ # `max_doublings` is 3, then the a task will first be retried in
+ # 10s. The retry interval will double three times, and then
+ # increase linearly by 2^3 * 10s. Finally, the task will retry at
+ # intervals of max_backoff until the
+ # task has been attempted max_attempts
+ # times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s,
+ # 240s, 300s, 300s, ....
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # 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).
+ },
+ "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.
@@ -876,22 +995,13 @@
# 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/.
# * `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.
+ "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
@@ -906,12 +1016,12 @@
# retry_config controls task retries (the
# second attempt, third attempt, etc).
#
- # The queue's actual dispatch rate is the result of:
+ # 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.
+ # 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.
@@ -921,7 +1031,7 @@
#
# 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
+ "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.
@@ -936,7 +1046,18 @@
# 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.
+ "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.
+ #
+ # * 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).
+ "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
@@ -949,7 +1070,7 @@
# 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
+ # the queue's bucket runs out of tokens. The bucket will be
# continuously refilled with new tokens based on
# max_dispatches_per_second.
#
@@ -968,19 +1089,17 @@
# 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.
- #
- # * 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).
},
- "appEngineRoutingOverride": { # App Engine Routing. # Overrides for
+ "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.
+ },
+ "appEngineRoutingOverride": { # App Engine Routing. # Overrides for
# task-level app_engine_routing.
# These settings apply only to
# App Engine tasks in this queue.
@@ -1010,47 +1129,7 @@
# and the following scope:
#
# `https://www.googleapis.com/auth/cloud-platform`
- "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.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "service": "A String", # App service.
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -1066,125 +1145,46 @@
# service,
# version, and
# instance are the empty string.
- },
- "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.
- "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.
- # Retry settings cannot be set on individual tasks.
- # * For tasks created using the App Engine SDK: the queue-level retry
- # settings apply to all tasks in the queue which do not have retry settings
- # explicitly set on the task and were created by the App Engine SDK. See
- # [App Engine
- # 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
- # retrying a failed task, measured from when the task was first
- # attempted. Once `max_retry_duration` time has passed *and* the
- # task has been attempted max_attempts
- # times, no further attempts will be made and the task will be
- # deleted.
+ "instance": "A String", # App instance.
#
- # If zero, then the task age is unlimited.
+ # By default, the task is sent to an instance which is available when
+ # the task is attempted.
#
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
+ # 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).
+ "version": "A String", # App version.
#
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
#
- # `max_retry_duration` will be truncated to the nearest second.
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
#
- # 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.
+ # 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.
#
- # A task's retry interval starts at
- # min_backoff, then doubles
- # `max_doublings` times, then increases linearly, and finally
- # retries at intervals of
- # max_backoff up to
- # max_attempts times.
- #
- # For example, if min_backoff is 10s,
- # max_backoff is 300s, and
- # `max_doublings` is 3, then the a task will first be retried in
- # 10s. The retry interval will double three times, and then
- # increase linearly by 2^3 * 10s. Finally, the task will retry at
- # intervals of max_backoff until the
- # task has been attempted max_attempts
- # times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s,
- # 240s, 300s, 300s, ....
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- #
- # 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.
- #
- # 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).
- "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).
- "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).
+ # For more information, see
+ # [How Requests are
+ # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
},
}</pre>
</div>
@@ -1208,9 +1208,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.
@@ -1218,6 +1218,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).
},
}
@@ -1239,36 +1243,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:**
@@ -1286,63 +1294,53 @@
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
- # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
# - etag: BwWWja0YfJA=
# - version: 3
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "role": "A String", # Role that is assigned to `members`.
- # 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.
- # 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"
- #
- # Example (Equality):
- #
- # 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'"
- #
- # Example (Data Manipulation):
- #
- # title: "Notification string"
- # description: "Create a notification string with a timestamp."
- # expression: "'New message received at ' + string(document.create_time)"
- #
- # The exact variables and functions that may be referenced within an expression
- # are determined by the service that evaluates it. See the service
- # documentation for additional information.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
- # its purpose. This can be used e.g. in UIs which allow to enter the
- # expression.
- },
- "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
@@ -1385,48 +1383,69 @@
# * `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`.
+ "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"
+ #
+ # Example (Equality):
+ #
+ # 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'"
+ #
+ # Example (Data Manipulation):
+ #
+ # 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.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ },
},
],
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
- # prevent simultaneous updates of a policy from overwriting each other.
- # It is strongly suggested that systems make use of the `etag` in the
- # read-modify-write cycle to perform policy updates in order to avoid race
- # conditions: An `etag` is returned in the response to `getIamPolicy`, and
- # systems are expected to put that etag in the request to `setIamPolicy` to
- # ensure that their change will be applied to the same version of the policy.
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code>
+ <code class="details" id="list">list(parent, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
<pre>Lists queues.
Queues are returned in lexicographical order.
@@ -1434,6 +1453,17 @@
Args:
parent: string, Required. The location name.
For example: `projects/PROJECT_ID/locations/LOCATION_ID` (required)
+ filter: string, `filter` can be used to specify a subset of queues. Any Queue
+field can be used as a filter and several operators as supported.
+For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as
+described in
+[Stackdriver's Advanced Logs
+Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
+
+Sample filter "state: PAUSED".
+
+Note that using filters might cause fewer queues than the
+requested page_size to be returned.
pageToken: string, A token identifying the page of results to return.
To request the first page results, page_token must be empty. To
@@ -1442,10 +1472,6 @@
from the previous call to ListQueues
method. It is an error to switch the value of the
filter while iterating through pages.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
pageSize: integer, Requested page size.
The maximum page size is 9800. If unspecified, the page size will
@@ -1453,36 +1479,139 @@
even if more queues exist; use the
next_page_token in the
response to determine if more queues exist.
- filter: string, `filter` can be used to specify a subset of queues. Any Queue
-field can be used as a filter and several operators as supported.
-For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as
-described in
-[Stackdriver's Advanced Logs
-Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
-
-Sample filter "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,
+ "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.
+ # Retry settings cannot be set on individual tasks.
+ # * For tasks created using the App Engine SDK: the queue-level retry
+ # settings apply to all tasks in the queue which do not have retry settings
+ # explicitly set on the task and were created by the App Engine SDK. See
+ # [App Engine
+ # documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
+ #
+ # These settings determine when a failed task attempt is retried.
+ "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
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # `max_retry_duration` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [task_age_limit in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxAttempts": 42, # Number of attempts per task.
+ #
+ # Cloud Tasks will attempt the task `max_attempts` times (that is, if the
+ # first attempt fails, then there will be `max_attempts - 1` retries). Must
+ # be >= -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
+ # max_backoff up to
+ # max_attempts times.
+ #
+ # For example, if min_backoff is 10s,
+ # max_backoff is 300s, and
+ # `max_doublings` is 3, then the a task will first be retried in
+ # 10s. The retry interval will double three times, and then
+ # increase linearly by 2^3 * 10s. Finally, the task will retry at
+ # intervals of max_backoff until the
+ # task has been attempted max_attempts
+ # times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s,
+ # 240s, 300s, 300s, ....
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # 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).
+ },
+ "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.
@@ -1495,22 +1624,13 @@
# 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/.
# * `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.
+ "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
@@ -1525,12 +1645,12 @@
# retry_config controls task retries (the
# second attempt, third attempt, etc).
#
- # The queue's actual dispatch rate is the result of:
+ # 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.
+ # 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.
@@ -1540,7 +1660,7 @@
#
# 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
+ "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.
@@ -1555,7 +1675,18 @@
# 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.
+ "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.
+ #
+ # * 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).
+ "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
@@ -1568,7 +1699,7 @@
# 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
+ # the queue's bucket runs out of tokens. The bucket will be
# continuously refilled with new tokens based on
# max_dispatches_per_second.
#
@@ -1587,19 +1718,17 @@
# 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.
- #
- # * 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).
},
- "appEngineRoutingOverride": { # App Engine Routing. # Overrides for
+ "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.
+ },
+ "appEngineRoutingOverride": { # App Engine Routing. # Overrides for
# task-level app_engine_routing.
# These settings apply only to
# App Engine tasks in this queue.
@@ -1629,47 +1758,7 @@
# and the following scope:
#
# `https://www.googleapis.com/auth/cloud-platform`
- "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.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "service": "A String", # App service.
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -1685,128 +1774,58 @@
# service,
# version, and
# instance are the empty string.
- },
- "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.
- "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.
- # Retry settings cannot be set on individual tasks.
- # * For tasks created using the App Engine SDK: the queue-level retry
- # settings apply to all tasks in the queue which do not have retry settings
- # explicitly set on the task and were created by the App Engine SDK. See
- # [App Engine
- # 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
- # retrying a failed task, measured from when the task was first
- # attempted. Once `max_retry_duration` time has passed *and* the
- # task has been attempted max_attempts
- # times, no further attempts will be made and the task will be
- # deleted.
+ "instance": "A String", # App instance.
#
- # If zero, then the task age is unlimited.
+ # By default, the task is sent to an instance which is available when
+ # the task is attempted.
#
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
+ # 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).
+ "version": "A String", # App version.
#
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
#
- # `max_retry_duration` will be truncated to the nearest second.
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
#
- # 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.
+ # 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.
#
- # A task's retry interval starts at
- # min_backoff, then doubles
- # `max_doublings` times, then increases linearly, and finally
- # retries at intervals of
- # max_backoff up to
- # max_attempts times.
- #
- # For example, if min_backoff is 10s,
- # max_backoff is 300s, and
- # `max_doublings` is 3, then the a task will first be retried in
- # 10s. The retry interval will double three times, and then
- # increase linearly by 2^3 * 10s. Finally, the task will retry at
- # intervals of max_backoff until the
- # task has been attempted max_attempts
- # times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s,
- # 240s, 300s, 300s, ....
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- #
- # 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.
- #
- # 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).
- "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).
- "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).
+ # For more information, see
+ # [How Requests are
+ # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
},
},
],
+ "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>
@@ -1819,7 +1838,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>
@@ -1856,7 +1875,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/.
@@ -1868,7 +1887,126 @@
{ # 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,
+ "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.
+ # Retry settings cannot be set on individual tasks.
+ # * For tasks created using the App Engine SDK: the queue-level retry
+ # settings apply to all tasks in the queue which do not have retry settings
+ # explicitly set on the task and were created by the App Engine SDK. See
+ # [App Engine
+ # documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
+ #
+ # These settings determine when a failed task attempt is retried.
+ "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
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # `max_retry_duration` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [task_age_limit in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxAttempts": 42, # Number of attempts per task.
+ #
+ # Cloud Tasks will attempt the task `max_attempts` times (that is, if the
+ # first attempt fails, then there will be `max_attempts - 1` retries). Must
+ # be >= -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
+ # max_backoff up to
+ # max_attempts times.
+ #
+ # For example, if min_backoff is 10s,
+ # max_backoff is 300s, and
+ # `max_doublings` is 3, then the a task will first be retried in
+ # 10s. The retry interval will double three times, and then
+ # increase linearly by 2^3 * 10s. Finally, the task will retry at
+ # intervals of max_backoff until the
+ # task has been attempted max_attempts
+ # times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s,
+ # 240s, 300s, 300s, ....
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # 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).
+ },
+ "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.
@@ -1881,22 +2019,13 @@
# 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/.
# * `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.
+ "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
@@ -1911,12 +2040,12 @@
# retry_config controls task retries (the
# second attempt, third attempt, etc).
#
- # The queue's actual dispatch rate is the result of:
+ # 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.
+ # 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.
@@ -1926,7 +2055,7 @@
#
# 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
+ "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.
@@ -1941,7 +2070,18 @@
# 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.
+ "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.
+ #
+ # * 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).
+ "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
@@ -1954,7 +2094,7 @@
# 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
+ # the queue's bucket runs out of tokens. The bucket will be
# continuously refilled with new tokens based on
# max_dispatches_per_second.
#
@@ -1973,19 +2113,17 @@
# 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.
- #
- # * 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).
},
- "appEngineRoutingOverride": { # App Engine Routing. # Overrides for
+ "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.
+ },
+ "appEngineRoutingOverride": { # App Engine Routing. # Overrides for
# task-level app_engine_routing.
# These settings apply only to
# App Engine tasks in this queue.
@@ -2015,47 +2153,7 @@
# and the following scope:
#
# `https://www.googleapis.com/auth/cloud-platform`
- "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.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "service": "A String", # App service.
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -2071,125 +2169,46 @@
# service,
# version, and
# instance are the empty string.
- },
- "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.
- "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.
- # Retry settings cannot be set on individual tasks.
- # * For tasks created using the App Engine SDK: the queue-level retry
- # settings apply to all tasks in the queue which do not have retry settings
- # explicitly set on the task and were created by the App Engine SDK. See
- # [App Engine
- # 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
- # retrying a failed task, measured from when the task was first
- # attempted. Once `max_retry_duration` time has passed *and* the
- # task has been attempted max_attempts
- # times, no further attempts will be made and the task will be
- # deleted.
+ "instance": "A String", # App instance.
#
- # If zero, then the task age is unlimited.
+ # By default, the task is sent to an instance which is available when
+ # the task is attempted.
#
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
+ # 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).
+ "version": "A String", # App version.
#
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
#
- # `max_retry_duration` will be truncated to the nearest second.
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
#
- # 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.
+ # 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.
#
- # A task's retry interval starts at
- # min_backoff, then doubles
- # `max_doublings` times, then increases linearly, and finally
- # retries at intervals of
- # max_backoff up to
- # max_attempts times.
- #
- # For example, if min_backoff is 10s,
- # max_backoff is 300s, and
- # `max_doublings` is 3, then the a task will first be retried in
- # 10s. The retry interval will double three times, and then
- # increase linearly by 2^3 * 10s. Finally, the task will retry at
- # intervals of max_backoff until the
- # task has been attempted max_attempts
- # times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s,
- # 240s, 300s, 300s, ....
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- #
- # 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.
- #
- # 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).
- "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).
- "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).
+ # For more information, see
+ # [How Requests are
+ # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
},
}
@@ -2207,7 +2226,126 @@
{ # 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,
+ "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.
+ # Retry settings cannot be set on individual tasks.
+ # * For tasks created using the App Engine SDK: the queue-level retry
+ # settings apply to all tasks in the queue which do not have retry settings
+ # explicitly set on the task and were created by the App Engine SDK. See
+ # [App Engine
+ # documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
+ #
+ # These settings determine when a failed task attempt is retried.
+ "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
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # `max_retry_duration` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [task_age_limit in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxAttempts": 42, # Number of attempts per task.
+ #
+ # Cloud Tasks will attempt the task `max_attempts` times (that is, if the
+ # first attempt fails, then there will be `max_attempts - 1` retries). Must
+ # be >= -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
+ # max_backoff up to
+ # max_attempts times.
+ #
+ # For example, if min_backoff is 10s,
+ # max_backoff is 300s, and
+ # `max_doublings` is 3, then the a task will first be retried in
+ # 10s. The retry interval will double three times, and then
+ # increase linearly by 2^3 * 10s. Finally, the task will retry at
+ # intervals of max_backoff until the
+ # task has been attempted max_attempts
+ # times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s,
+ # 240s, 300s, 300s, ....
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # 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).
+ },
+ "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.
@@ -2220,22 +2358,13 @@
# 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/.
# * `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.
+ "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
@@ -2250,12 +2379,12 @@
# retry_config controls task retries (the
# second attempt, third attempt, etc).
#
- # The queue's actual dispatch rate is the result of:
+ # 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.
+ # 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.
@@ -2265,7 +2394,7 @@
#
# 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
+ "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.
@@ -2280,7 +2409,18 @@
# 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.
+ "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.
+ #
+ # * 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).
+ "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
@@ -2293,7 +2433,7 @@
# 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
+ # the queue's bucket runs out of tokens. The bucket will be
# continuously refilled with new tokens based on
# max_dispatches_per_second.
#
@@ -2312,19 +2452,17 @@
# 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.
- #
- # * 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).
},
- "appEngineRoutingOverride": { # App Engine Routing. # Overrides for
+ "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.
+ },
+ "appEngineRoutingOverride": { # App Engine Routing. # Overrides for
# task-level app_engine_routing.
# These settings apply only to
# App Engine tasks in this queue.
@@ -2354,47 +2492,7 @@
# and the following scope:
#
# `https://www.googleapis.com/auth/cloud-platform`
- "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.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "service": "A String", # App service.
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -2410,125 +2508,46 @@
# service,
# version, and
# instance are the empty string.
- },
- "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.
- "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.
- # Retry settings cannot be set on individual tasks.
- # * For tasks created using the App Engine SDK: the queue-level retry
- # settings apply to all tasks in the queue which do not have retry settings
- # explicitly set on the task and were created by the App Engine SDK. See
- # [App Engine
- # 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
- # retrying a failed task, measured from when the task was first
- # attempted. Once `max_retry_duration` time has passed *and* the
- # task has been attempted max_attempts
- # times, no further attempts will be made and the task will be
- # deleted.
+ "instance": "A String", # App instance.
#
- # If zero, then the task age is unlimited.
+ # By default, the task is sent to an instance which is available when
+ # the task is attempted.
#
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
+ # 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).
+ "version": "A String", # App version.
#
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
#
- # `max_retry_duration` will be truncated to the nearest second.
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
#
- # 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.
+ # 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.
#
- # A task's retry interval starts at
- # min_backoff, then doubles
- # `max_doublings` times, then increases linearly, and finally
- # retries at intervals of
- # max_backoff up to
- # max_attempts times.
- #
- # For example, if min_backoff is 10s,
- # max_backoff is 300s, and
- # `max_doublings` is 3, then the a task will first be retried in
- # 10s. The retry interval will double three times, and then
- # increase linearly by 2^3 * 10s. Finally, the task will retry at
- # intervals of max_backoff until the
- # task has been attempted max_attempts
- # times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s,
- # 240s, 300s, 300s, ....
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- #
- # 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.
- #
- # 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).
- "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).
- "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).
+ # For more information, see
+ # [How Requests are
+ # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
},
}</pre>
</div>
@@ -2563,7 +2582,126 @@
{ # 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,
+ "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.
+ # Retry settings cannot be set on individual tasks.
+ # * For tasks created using the App Engine SDK: the queue-level retry
+ # settings apply to all tasks in the queue which do not have retry settings
+ # explicitly set on the task and were created by the App Engine SDK. See
+ # [App Engine
+ # documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
+ #
+ # These settings determine when a failed task attempt is retried.
+ "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
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # `max_retry_duration` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [task_age_limit in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxAttempts": 42, # Number of attempts per task.
+ #
+ # Cloud Tasks will attempt the task `max_attempts` times (that is, if the
+ # first attempt fails, then there will be `max_attempts - 1` retries). Must
+ # be >= -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
+ # max_backoff up to
+ # max_attempts times.
+ #
+ # For example, if min_backoff is 10s,
+ # max_backoff is 300s, and
+ # `max_doublings` is 3, then the a task will first be retried in
+ # 10s. The retry interval will double three times, and then
+ # increase linearly by 2^3 * 10s. Finally, the task will retry at
+ # intervals of max_backoff until the
+ # task has been attempted max_attempts
+ # times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s,
+ # 240s, 300s, 300s, ....
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # 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).
+ },
+ "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.
@@ -2576,22 +2714,13 @@
# 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/.
# * `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.
+ "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
@@ -2606,12 +2735,12 @@
# retry_config controls task retries (the
# second attempt, third attempt, etc).
#
- # The queue's actual dispatch rate is the result of:
+ # 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.
+ # 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.
@@ -2621,7 +2750,7 @@
#
# 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
+ "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.
@@ -2636,7 +2765,18 @@
# 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.
+ "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.
+ #
+ # * 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).
+ "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
@@ -2649,7 +2789,7 @@
# 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
+ # the queue's bucket runs out of tokens. The bucket will be
# continuously refilled with new tokens based on
# max_dispatches_per_second.
#
@@ -2668,19 +2808,17 @@
# 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.
- #
- # * 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).
},
- "appEngineRoutingOverride": { # App Engine Routing. # Overrides for
+ "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.
+ },
+ "appEngineRoutingOverride": { # App Engine Routing. # Overrides for
# task-level app_engine_routing.
# These settings apply only to
# App Engine tasks in this queue.
@@ -2710,47 +2848,7 @@
# and the following scope:
#
# `https://www.googleapis.com/auth/cloud-platform`
- "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.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "service": "A String", # App service.
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -2766,125 +2864,46 @@
# service,
# version, and
# instance are the empty string.
- },
- "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.
- "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.
- # Retry settings cannot be set on individual tasks.
- # * For tasks created using the App Engine SDK: the queue-level retry
- # settings apply to all tasks in the queue which do not have retry settings
- # explicitly set on the task and were created by the App Engine SDK. See
- # [App Engine
- # 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
- # retrying a failed task, measured from when the task was first
- # attempted. Once `max_retry_duration` time has passed *and* the
- # task has been attempted max_attempts
- # times, no further attempts will be made and the task will be
- # deleted.
+ "instance": "A String", # App instance.
#
- # If zero, then the task age is unlimited.
+ # By default, the task is sent to an instance which is available when
+ # the task is attempted.
#
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
+ # 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).
+ "version": "A String", # App version.
#
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
#
- # `max_retry_duration` will be truncated to the nearest second.
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
#
- # 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.
+ # 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.
#
- # A task's retry interval starts at
- # min_backoff, then doubles
- # `max_doublings` times, then increases linearly, and finally
- # retries at intervals of
- # max_backoff up to
- # max_attempts times.
- #
- # For example, if min_backoff is 10s,
- # max_backoff is 300s, and
- # `max_doublings` is 3, then the a task will first be retried in
- # 10s. The retry interval will double three times, and then
- # increase linearly by 2^3 * 10s. Finally, the task will retry at
- # intervals of max_backoff until the
- # task has been attempted max_attempts
- # times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s,
- # 240s, 300s, 300s, ....
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- #
- # 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.
- #
- # 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).
- "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).
- "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).
+ # For more information, see
+ # [How Requests are
+ # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
},
}</pre>
</div>
@@ -2918,7 +2937,126 @@
{ # 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,
+ "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.
+ # Retry settings cannot be set on individual tasks.
+ # * For tasks created using the App Engine SDK: the queue-level retry
+ # settings apply to all tasks in the queue which do not have retry settings
+ # explicitly set on the task and were created by the App Engine SDK. See
+ # [App Engine
+ # documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
+ #
+ # These settings determine when a failed task attempt is retried.
+ "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
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # `max_retry_duration` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [task_age_limit in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxAttempts": 42, # Number of attempts per task.
+ #
+ # Cloud Tasks will attempt the task `max_attempts` times (that is, if the
+ # first attempt fails, then there will be `max_attempts - 1` retries). Must
+ # be >= -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
+ # max_backoff up to
+ # max_attempts times.
+ #
+ # For example, if min_backoff is 10s,
+ # max_backoff is 300s, and
+ # `max_doublings` is 3, then the a task will first be retried in
+ # 10s. The retry interval will double three times, and then
+ # increase linearly by 2^3 * 10s. Finally, the task will retry at
+ # intervals of max_backoff until the
+ # task has been attempted max_attempts
+ # times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s,
+ # 240s, 300s, 300s, ....
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # 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).
+ },
+ "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.
@@ -2931,22 +3069,13 @@
# 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/.
# * `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.
+ "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
@@ -2961,12 +3090,12 @@
# retry_config controls task retries (the
# second attempt, third attempt, etc).
#
- # The queue's actual dispatch rate is the result of:
+ # 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.
+ # 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.
@@ -2976,7 +3105,7 @@
#
# 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
+ "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.
@@ -2991,7 +3120,18 @@
# 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.
+ "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.
+ #
+ # * 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).
+ "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
@@ -3004,7 +3144,7 @@
# 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
+ # the queue's bucket runs out of tokens. The bucket will be
# continuously refilled with new tokens based on
# max_dispatches_per_second.
#
@@ -3023,19 +3163,17 @@
# 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.
- #
- # * 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).
},
- "appEngineRoutingOverride": { # App Engine Routing. # Overrides for
+ "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.
+ },
+ "appEngineRoutingOverride": { # App Engine Routing. # Overrides for
# task-level app_engine_routing.
# These settings apply only to
# App Engine tasks in this queue.
@@ -3065,47 +3203,7 @@
# and the following scope:
#
# `https://www.googleapis.com/auth/cloud-platform`
- "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.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "service": "A String", # App service.
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -3121,125 +3219,46 @@
# service,
# version, and
# instance are the empty string.
- },
- "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.
- "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.
- # Retry settings cannot be set on individual tasks.
- # * For tasks created using the App Engine SDK: the queue-level retry
- # settings apply to all tasks in the queue which do not have retry settings
- # explicitly set on the task and were created by the App Engine SDK. See
- # [App Engine
- # 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
- # retrying a failed task, measured from when the task was first
- # attempted. Once `max_retry_duration` time has passed *and* the
- # task has been attempted max_attempts
- # times, no further attempts will be made and the task will be
- # deleted.
+ "instance": "A String", # App instance.
#
- # If zero, then the task age is unlimited.
+ # By default, the task is sent to an instance which is available when
+ # the task is attempted.
#
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
+ # 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).
+ "version": "A String", # App version.
#
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
#
- # `max_retry_duration` will be truncated to the nearest second.
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
#
- # 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.
+ # 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.
#
- # A task's retry interval starts at
- # min_backoff, then doubles
- # `max_doublings` times, then increases linearly, and finally
- # retries at intervals of
- # max_backoff up to
- # max_attempts times.
- #
- # For example, if min_backoff is 10s,
- # max_backoff is 300s, and
- # `max_doublings` is 3, then the a task will first be retried in
- # 10s. The retry interval will double three times, and then
- # increase linearly by 2^3 * 10s. Finally, the task will retry at
- # intervals of max_backoff until the
- # task has been attempted max_attempts
- # times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s,
- # 240s, 300s, 300s, ....
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- #
- # 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.
- #
- # 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).
- "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).
- "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).
+ # For more information, see
+ # [How Requests are
+ # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
},
}</pre>
</div>
@@ -3251,7 +3270,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
@@ -3280,7 +3299,126 @@
{ # 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,
+ "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.
+ # Retry settings cannot be set on individual tasks.
+ # * For tasks created using the App Engine SDK: the queue-level retry
+ # settings apply to all tasks in the queue which do not have retry settings
+ # explicitly set on the task and were created by the App Engine SDK. See
+ # [App Engine
+ # documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
+ #
+ # These settings determine when a failed task attempt is retried.
+ "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
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # `max_retry_duration` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [task_age_limit in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxAttempts": 42, # Number of attempts per task.
+ #
+ # Cloud Tasks will attempt the task `max_attempts` times (that is, if the
+ # first attempt fails, then there will be `max_attempts - 1` retries). Must
+ # be >= -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
+ # max_backoff up to
+ # max_attempts times.
+ #
+ # For example, if min_backoff is 10s,
+ # max_backoff is 300s, and
+ # `max_doublings` is 3, then the a task will first be retried in
+ # 10s. The retry interval will double three times, and then
+ # increase linearly by 2^3 * 10s. Finally, the task will retry at
+ # intervals of max_backoff until the
+ # task has been attempted max_attempts
+ # times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s,
+ # 240s, 300s, 300s, ....
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # 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).
+ },
+ "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.
@@ -3293,22 +3431,13 @@
# 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/.
# * `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.
+ "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
@@ -3323,12 +3452,12 @@
# retry_config controls task retries (the
# second attempt, third attempt, etc).
#
- # The queue's actual dispatch rate is the result of:
+ # 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.
+ # 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.
@@ -3338,7 +3467,7 @@
#
# 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
+ "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.
@@ -3353,7 +3482,18 @@
# 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.
+ "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.
+ #
+ # * 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).
+ "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
@@ -3366,7 +3506,7 @@
# 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
+ # the queue's bucket runs out of tokens. The bucket will be
# continuously refilled with new tokens based on
# max_dispatches_per_second.
#
@@ -3385,19 +3525,17 @@
# 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.
- #
- # * 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).
},
- "appEngineRoutingOverride": { # App Engine Routing. # Overrides for
+ "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.
+ },
+ "appEngineRoutingOverride": { # App Engine Routing. # Overrides for
# task-level app_engine_routing.
# These settings apply only to
# App Engine tasks in this queue.
@@ -3427,47 +3565,7 @@
# and the following scope:
#
# `https://www.googleapis.com/auth/cloud-platform`
- "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.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "service": "A String", # App service.
+ "service": "A String", # App service.
#
# By default, the task is sent to the service which is the default
# service when the task is attempted.
@@ -3483,125 +3581,46 @@
# service,
# version, and
# instance are the empty string.
- },
- "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.
- "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.
- # Retry settings cannot be set on individual tasks.
- # * For tasks created using the App Engine SDK: the queue-level retry
- # settings apply to all tasks in the queue which do not have retry settings
- # explicitly set on the task and were created by the App Engine SDK. See
- # [App Engine
- # 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
- # retrying a failed task, measured from when the task was first
- # attempted. Once `max_retry_duration` time has passed *and* the
- # task has been attempted max_attempts
- # times, no further attempts will be made and the task will be
- # deleted.
+ "instance": "A String", # App instance.
#
- # If zero, then the task age is unlimited.
+ # By default, the task is sent to an instance which is available when
+ # the task is attempted.
#
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
+ # 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).
+ "version": "A String", # App version.
#
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
#
- # `max_retry_duration` will be truncated to the nearest second.
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
#
- # 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.
+ # 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.
#
- # A task's retry interval starts at
- # min_backoff, then doubles
- # `max_doublings` times, then increases linearly, and finally
- # retries at intervals of
- # max_backoff up to
- # max_attempts times.
- #
- # For example, if min_backoff is 10s,
- # max_backoff is 300s, and
- # `max_doublings` is 3, then the a task will first be retried in
- # 10s. The retry interval will double three times, and then
- # increase linearly by 2^3 * 10s. Finally, the task will retry at
- # intervals of max_backoff until the
- # task has been attempted max_attempts
- # times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s,
- # 240s, 300s, 300s, ....
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- #
- # 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.
- #
- # 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).
- "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).
- "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).
+ # For more information, see
+ # [How Requests are
+ # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
},
}</pre>
</div>
@@ -3627,7 +3646,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.
@@ -3640,36 +3659,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:**
@@ -3687,63 +3710,53 @@
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
- # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
# - etag: BwWWja0YfJA=
# - version: 3
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "role": "A String", # Role that is assigned to `members`.
- # 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.
- # 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"
- #
- # Example (Equality):
- #
- # 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'"
- #
- # Example (Data Manipulation):
- #
- # title: "Notification string"
- # description: "Create a notification string with a timestamp."
- # expression: "'New message received at ' + string(document.create_time)"
- #
- # The exact variables and functions that may be referenced within an expression
- # are determined by the service that evaluates it. See the service
- # documentation for additional information.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
- # its purpose. This can be used e.g. in UIs which allow to enter the
- # expression.
- },
- "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
@@ -3786,43 +3799,64 @@
# * `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`.
+ "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"
+ #
+ # Example (Equality):
+ #
+ # 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'"
+ #
+ # Example (Data Manipulation):
+ #
+ # 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.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ },
},
],
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
- # prevent simultaneous updates of a policy from overwriting each other.
- # It is strongly suggested that systems make use of the `etag` in the
- # read-modify-write cycle to perform policy updates in order to avoid race
- # conditions: An `etag` is returned in the response to `getIamPolicy`, and
- # systems are expected to put that etag in the request to `setIamPolicy` to
- # ensure that their change will be applied to the same version of the policy.
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
},
}
@@ -3844,36 +3878,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:**
@@ -3891,63 +3929,53 @@
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
- # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
# - etag: BwWWja0YfJA=
# - version: 3
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "role": "A String", # Role that is assigned to `members`.
- # 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.
- # 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"
- #
- # Example (Equality):
- #
- # 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'"
- #
- # Example (Data Manipulation):
- #
- # title: "Notification string"
- # description: "Create a notification string with a timestamp."
- # expression: "'New message received at ' + string(document.create_time)"
- #
- # The exact variables and functions that may be referenced within an expression
- # are determined by the service that evaluates it. See the service
- # documentation for additional information.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
- # its purpose. This can be used e.g. in UIs which allow to enter the
- # expression.
- },
- "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
@@ -3990,43 +4018,64 @@
# * `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`.
+ "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"
+ #
+ # Example (Equality):
+ #
+ # 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'"
+ #
+ # Example (Data Manipulation):
+ #
+ # 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.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ },
},
],
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
- # prevent simultaneous updates of a policy from overwriting each other.
- # It is strongly suggested that systems make use of the `etag` in the
- # read-modify-write cycle to perform policy updates in order to avoid race
- # conditions: An `etag` is returned in the response to `getIamPolicy`, and
- # systems are expected to put that etag in the request to `setIamPolicy` to
- # ensure that their change will be applied to the same version of the policy.
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
}</pre>
</div>
@@ -4038,7 +4087,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.
@@ -4047,11 +4096,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",
],
}
@@ -4064,9 +4113,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>