docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/cloudtasks_v2.projects.locations.queues.html b/docs/dyn/cloudtasks_v2.projects.locations.queues.html
index 8a0283a..071c4ee 100644
--- a/docs/dyn/cloudtasks_v2.projects.locations.queues.html
+++ b/docs/dyn/cloudtasks_v2.projects.locations.queues.html
@@ -142,586 +142,14 @@
The object takes the form of:
{ # 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.
- "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.
- #
- # The queue name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the queue's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
- # hyphens (-). The maximum length is 100 characters.
- "rateLimits": { # Rate limits. # Rate limits for task dispatches.
- #
- # rate_limits and retry_config are
- # related because they both control task attempts. However they control task
- # attempts in different ways:
- #
- # * rate_limits controls the total rate of
- # dispatches from a queue (i.e. all traffic dispatched from the
- # queue, regardless of whether the dispatch is from a first
- # attempt or a retry).
- # * retry_config controls what happens to
- # particular a task after its first attempt fails. That is,
- # retry_config controls task retries (the
- # second attempt, third attempt, etc).
- #
- # The queue's actual dispatch rate is the result of:
- #
- # * Number of tasks in the queue
- # * User-specified throttling: rate_limits,
- # retry_config, and the
- # queue's state.
- # * System throttling due to `429` (Too Many Requests) or `503` (Service
- # Unavailable) responses from the worker, high error rates, or to smooth
- # sudden large traffic spikes.
- #
- # This message determines the maximum rate that tasks can be dispatched by a
- # queue, regardless of whether the dispatch is a first task attempt or a retry.
- #
- # Note: The debugging command, RunTask, will run a task
- # even if the queue has reached its RateLimits.
- "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
- # to be dispatched for this queue. After this threshold has been
- # reached, Cloud Tasks stops dispatching tasks until the number of
- # concurrent requests decreases.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- #
- # The maximum allowed value is 5,000.
- #
- #
- # This field has the same meaning as
- # [max_concurrent_requests in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
- "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
- # allows the queue to have a high rate so processing starts shortly
- # after a task is enqueued, but still limits resource usage when
- # many tasks are enqueued in a short period of time.
- #
- # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
- # algorithm is used to control the rate of task dispatches. Each
- # queue has a token bucket that holds tokens, up to the maximum
- # specified by `max_burst_size`. Each time a task is dispatched, a
- # token is removed from the bucket. Tasks will be dispatched until
- # the queue's bucket runs out of tokens. The bucket will be
- # continuously refilled with new tokens based on
- # max_dispatches_per_second.
- #
- # Cloud Tasks will pick the value of `max_burst_size` based on the
- # value of
- # max_dispatches_per_second.
- #
- # For queues that were created or updated using
- # `queue.yaml/xml`, `max_burst_size` is equal to
- # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
- # Since `max_burst_size` is output only, if
- # UpdateQueue is called on a queue
- # created by `queue.yaml/xml`, `max_burst_size` will be reset based
- # on the value of
- # max_dispatches_per_second,
- # regardless of whether
- # max_dispatches_per_second
- # is updated.
- },
- "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.
- # Http tasks are not affected.
- #
- # If set, `app_engine_routing_override` is used for all
- # App Engine tasks in the queue, no matter what the
- # setting is for the
- # task-level app_engine_routing.
- #
- # Defines routing characteristics specific to App Engine - service, version,
- # and instance.
- #
- # For more information about services, versions, and instances see
- # [An Overview of App
- # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
- # [Microservices Architecture on Google App
- # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
- # [App Engine Standard request
- # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
- # and [App Engine Flex request
- # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- #
- # Using AppEngineRouting requires
- # [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
- # Google IAM permission for the project
- # and the following scope:
- #
- # `https://www.googleapis.com/auth/cloud-platform`
- "service": "A String", # App service.
- #
- # By default, the task is sent to the service which is the default
- # service 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.
- "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).
- "version": "A String", # App version.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "host": "A String", # Output only. The host that the task is sent to.
- #
- # 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).
- },
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # 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.
- "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.
- #
- # The queue name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the queue's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
- # hyphens (-). The maximum length is 100 characters.
- "rateLimits": { # Rate limits. # Rate limits for task dispatches.
- #
- # rate_limits and retry_config are
- # related because they both control task attempts. However they control task
- # attempts in different ways:
- #
- # * rate_limits controls the total rate of
- # dispatches from a queue (i.e. all traffic dispatched from the
- # queue, regardless of whether the dispatch is from a first
- # attempt or a retry).
- # * retry_config controls what happens to
- # particular a task after its first attempt fails. That is,
- # retry_config controls task retries (the
- # second attempt, third attempt, etc).
- #
- # The queue's actual dispatch rate is the result of:
- #
- # * Number of tasks in the queue
- # * User-specified throttling: rate_limits,
- # retry_config, and the
- # queue's state.
- # * System throttling due to `429` (Too Many Requests) or `503` (Service
- # Unavailable) responses from the worker, high error rates, or to smooth
- # sudden large traffic spikes.
- #
- # This message determines the maximum rate that tasks can be dispatched by a
- # queue, regardless of whether the dispatch is a first task attempt or a retry.
- #
- # Note: The debugging command, RunTask, will run a task
- # even if the queue has reached its RateLimits.
- "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
- # to be dispatched for this queue. After this threshold has been
- # reached, Cloud Tasks stops dispatching tasks until the number of
- # concurrent requests decreases.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- #
- # The maximum allowed value is 5,000.
- #
- #
- # This field has the same meaning as
- # [max_concurrent_requests in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
- "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
- # allows the queue to have a high rate so processing starts shortly
- # after a task is enqueued, but still limits resource usage when
- # many tasks are enqueued in a short period of time.
- #
- # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
- # algorithm is used to control the rate of task dispatches. Each
- # queue has a token bucket that holds tokens, up to the maximum
- # specified by `max_burst_size`. Each time a task is dispatched, a
- # token is removed from the bucket. Tasks will be dispatched until
- # the queue's bucket runs out of tokens. The bucket will be
- # continuously refilled with new tokens based on
- # max_dispatches_per_second.
- #
- # Cloud Tasks will pick the value of `max_burst_size` based on the
- # value of
- # max_dispatches_per_second.
- #
- # For queues that were created or updated using
- # `queue.yaml/xml`, `max_burst_size` is equal to
- # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
- # Since `max_burst_size` is output only, if
- # UpdateQueue is called on a queue
- # created by `queue.yaml/xml`, `max_burst_size` will be reset based
- # on the value of
- # max_dispatches_per_second,
- # regardless of whether
- # max_dispatches_per_second
- # is updated.
- },
- "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.
# Http tasks are not affected.
- #
+ #
# If set, `app_engine_routing_override` is used for all
# App Engine tasks in the queue, no matter what the
# setting is for the
@@ -803,7 +231,579 @@
# [How Requests are
# Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
},
- }</pre>
+ "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.
+ #
+ # 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).
+ "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).
+ },
+ "state": "A String", # Output only. The state of the queue.
+ #
+ # `state` can only be changed by called
+ # PauseQueue,
+ # ResumeQueue, or uploading
+ # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
+ # UpdateQueue cannot be used to change `state`.
+ "name": "A String", # Caller-specified and required in CreateQueue,
+ # after which it becomes output only.
+ #
+ # The queue name.
+ #
+ # The queue name must have the following format:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the queue's location.
+ # The list of available locations can be obtained by calling
+ # ListLocations.
+ # For more information, see https://cloud.google.com/about/locations/.
+ # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
+ # hyphens (-). The maximum length is 100 characters.
+ "rateLimits": { # Rate limits. # Rate limits for task dispatches.
+ #
+ # rate_limits and retry_config are
+ # related because they both control task attempts. However they control task
+ # attempts in different ways:
+ #
+ # * rate_limits controls the total rate of
+ # dispatches from a queue (i.e. all traffic dispatched from the
+ # queue, regardless of whether the dispatch is from a first
+ # attempt or a retry).
+ # * retry_config controls what happens to
+ # particular a task after its first attempt fails. That is,
+ # retry_config controls task retries (the
+ # second attempt, third attempt, etc).
+ #
+ # The queue's actual dispatch rate is the result of:
+ #
+ # * Number of tasks in the queue
+ # * User-specified throttling: rate_limits,
+ # retry_config, and the
+ # queue's state.
+ # * System throttling due to `429` (Too Many Requests) or `503` (Service
+ # Unavailable) responses from the worker, high error rates, or to smooth
+ # sudden large traffic spikes.
+ #
+ # This message determines the maximum rate that tasks can be dispatched by a
+ # queue, regardless of whether the dispatch is a first task attempt or a retry.
+ #
+ # Note: The debugging command, RunTask, will run a task
+ # even if the queue has reached its RateLimits.
+ "maxBurstSize": 42, # Output only. The max burst size.
+ #
+ # Max burst size limits how fast tasks in queue are processed when
+ # many tasks are in the queue and the rate is high. This field
+ # allows the queue to have a high rate so processing starts shortly
+ # after a task is enqueued, but still limits resource usage when
+ # many tasks are enqueued in a short period of time.
+ #
+ # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
+ # algorithm is used to control the rate of task dispatches. Each
+ # queue has a token bucket that holds tokens, up to the maximum
+ # specified by `max_burst_size`. Each time a task is dispatched, a
+ # token is removed from the bucket. Tasks will be dispatched until
+ # the queue's bucket runs out of tokens. The bucket will be
+ # continuously refilled with new tokens based on
+ # max_dispatches_per_second.
+ #
+ # Cloud Tasks will pick the value of `max_burst_size` based on the
+ # value of
+ # max_dispatches_per_second.
+ #
+ # For queues that were created or updated using
+ # `queue.yaml/xml`, `max_burst_size` is equal to
+ # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
+ # Since `max_burst_size` is output only, if
+ # UpdateQueue is called on a queue
+ # created by `queue.yaml/xml`, `max_burst_size` will be reset based
+ # on the value of
+ # max_dispatches_per_second,
+ # regardless of whether
+ # max_dispatches_per_second
+ # is updated.
+ "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
+ # to be dispatched for this queue. After this threshold has been
+ # reached, Cloud Tasks stops dispatching tasks until the number of
+ # concurrent requests decreases.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # The maximum allowed value is 5,000.
+ #
+ #
+ # This field has the same meaning as
+ # [max_concurrent_requests in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
+ "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).
+ },
+ "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.
+ },
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # 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.
+ "appEngineRoutingOverride": { # App Engine Routing. # Overrides for
+ # task-level app_engine_routing.
+ # These settings apply only to
+ # App Engine tasks in this queue.
+ # Http tasks are not affected.
+ #
+ # If set, `app_engine_routing_override` is used for all
+ # App Engine tasks in the queue, no matter what the
+ # setting is for the
+ # task-level app_engine_routing.
+ #
+ # Defines routing characteristics specific to App Engine - service, version,
+ # and instance.
+ #
+ # For more information about services, versions, and instances see
+ # [An Overview of App
+ # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
+ # [Microservices Architecture on Google App
+ # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
+ # [App Engine Standard request
+ # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
+ # and [App Engine Flex request
+ # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
+ #
+ # Using AppEngineRouting requires
+ # [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
+ # Google IAM permission for the project
+ # and the following scope:
+ #
+ # `https://www.googleapis.com/auth/cloud-platform`
+ "service": "A String", # App service.
+ #
+ # By default, the task is sent to the service which is the default
+ # service 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.
+ "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).
+ "version": "A String", # App version.
+ #
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
+ #
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
+ #
+ # 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).
+ },
+ "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.
+ #
+ # 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).
+ "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).
+ },
+ "state": "A String", # Output only. The state of the queue.
+ #
+ # `state` can only be changed by called
+ # PauseQueue,
+ # ResumeQueue, or uploading
+ # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
+ # UpdateQueue cannot be used to change `state`.
+ "name": "A String", # Caller-specified and required in CreateQueue,
+ # after which it becomes output only.
+ #
+ # The queue name.
+ #
+ # The queue name must have the following format:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the queue's location.
+ # The list of available locations can be obtained by calling
+ # ListLocations.
+ # For more information, see https://cloud.google.com/about/locations/.
+ # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
+ # hyphens (-). The maximum length is 100 characters.
+ "rateLimits": { # Rate limits. # Rate limits for task dispatches.
+ #
+ # rate_limits and retry_config are
+ # related because they both control task attempts. However they control task
+ # attempts in different ways:
+ #
+ # * rate_limits controls the total rate of
+ # dispatches from a queue (i.e. all traffic dispatched from the
+ # queue, regardless of whether the dispatch is from a first
+ # attempt or a retry).
+ # * retry_config controls what happens to
+ # particular a task after its first attempt fails. That is,
+ # retry_config controls task retries (the
+ # second attempt, third attempt, etc).
+ #
+ # The queue's actual dispatch rate is the result of:
+ #
+ # * Number of tasks in the queue
+ # * User-specified throttling: rate_limits,
+ # retry_config, and the
+ # queue's state.
+ # * System throttling due to `429` (Too Many Requests) or `503` (Service
+ # Unavailable) responses from the worker, high error rates, or to smooth
+ # sudden large traffic spikes.
+ #
+ # This message determines the maximum rate that tasks can be dispatched by a
+ # queue, regardless of whether the dispatch is a first task attempt or a retry.
+ #
+ # Note: The debugging command, RunTask, will run a task
+ # even if the queue has reached its RateLimits.
+ "maxBurstSize": 42, # Output only. The max burst size.
+ #
+ # Max burst size limits how fast tasks in queue are processed when
+ # many tasks are in the queue and the rate is high. This field
+ # allows the queue to have a high rate so processing starts shortly
+ # after a task is enqueued, but still limits resource usage when
+ # many tasks are enqueued in a short period of time.
+ #
+ # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
+ # algorithm is used to control the rate of task dispatches. Each
+ # queue has a token bucket that holds tokens, up to the maximum
+ # specified by `max_burst_size`. Each time a task is dispatched, a
+ # token is removed from the bucket. Tasks will be dispatched until
+ # the queue's bucket runs out of tokens. The bucket will be
+ # continuously refilled with new tokens based on
+ # max_dispatches_per_second.
+ #
+ # Cloud Tasks will pick the value of `max_burst_size` based on the
+ # value of
+ # max_dispatches_per_second.
+ #
+ # For queues that were created or updated using
+ # `queue.yaml/xml`, `max_burst_size` is equal to
+ # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
+ # Since `max_burst_size` is output only, if
+ # UpdateQueue is called on a queue
+ # created by `queue.yaml/xml`, `max_burst_size` will be reset based
+ # on the value of
+ # max_dispatches_per_second,
+ # regardless of whether
+ # max_dispatches_per_second
+ # is updated.
+ "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
+ # to be dispatched for this queue. After this threshold has been
+ # reached, Cloud Tasks stops dispatching tasks until the number of
+ # concurrent requests decreases.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # The maximum allowed value is 5,000.
+ #
+ #
+ # This field has the same meaning as
+ # [max_concurrent_requests in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
+ "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).
+ },
+ "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
+ # field is unset, then no logs are written.
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ "samplingRatio": 3.14, # Specifies the fraction of operations to write to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ # This field may contain any value between 0.0 and 1.0, inclusive.
+ # 0.0 is the default and means that no operations are logged.
+ },
+ }</pre>
</div>
<div class="method">
@@ -861,332 +861,332 @@
An object of the form:
{ # 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.
- "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.
+ # how those tasks are dispatched. Configurable properties include rate limits,
+ # retry options, queue types, and others.
+ "appEngineRoutingOverride": { # App Engine Routing. # Overrides for
+ # task-level app_engine_routing.
+ # These settings apply only to
+ # App Engine tasks in this queue.
+ # Http tasks are not affected.
#
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
+ # If set, `app_engine_routing_override` is used for all
+ # App Engine tasks in the queue, no matter what the
+ # setting is for the
+ # task-level app_engine_routing.
#
+ # Defines routing characteristics specific to App Engine - service, version,
+ # and instance.
#
- # `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.
- #
- # The queue name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the queue's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
- # hyphens (-). The maximum length is 100 characters.
- "rateLimits": { # Rate limits. # Rate limits for task dispatches.
- #
- # rate_limits and retry_config are
- # related because they both control task attempts. However they control task
- # attempts in different ways:
- #
- # * rate_limits controls the total rate of
- # dispatches from a queue (i.e. all traffic dispatched from the
- # queue, regardless of whether the dispatch is from a first
- # attempt or a retry).
- # * retry_config controls what happens to
- # particular a task after its first attempt fails. That is,
- # retry_config controls task retries (the
- # second attempt, third attempt, etc).
- #
- # The queue's actual dispatch rate is the result of:
- #
- # * Number of tasks in the queue
- # * User-specified throttling: rate_limits,
- # retry_config, and the
- # queue's state.
- # * System throttling due to `429` (Too Many Requests) or `503` (Service
- # Unavailable) responses from the worker, high error rates, or to smooth
- # sudden large traffic spikes.
- #
- # This message determines the maximum rate that tasks can be dispatched by a
- # queue, regardless of whether the dispatch is a first task attempt or a retry.
- #
- # Note: The debugging command, RunTask, will run a task
- # even if the queue has reached its RateLimits.
- "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
- # to be dispatched for this queue. After this threshold has been
- # reached, Cloud Tasks stops dispatching tasks until the number of
- # concurrent requests decreases.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- #
- # The maximum allowed value is 5,000.
- #
- #
- # This field has the same meaning as
- # [max_concurrent_requests in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
- "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
- # allows the queue to have a high rate so processing starts shortly
- # after a task is enqueued, but still limits resource usage when
- # many tasks are enqueued in a short period of time.
- #
- # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
- # algorithm is used to control the rate of task dispatches. Each
- # queue has a token bucket that holds tokens, up to the maximum
- # specified by `max_burst_size`. Each time a task is dispatched, a
- # token is removed from the bucket. Tasks will be dispatched until
- # the queue's bucket runs out of tokens. The bucket will be
- # continuously refilled with new tokens based on
- # max_dispatches_per_second.
- #
- # Cloud Tasks will pick the value of `max_burst_size` based on the
- # value of
- # max_dispatches_per_second.
- #
- # For queues that were created or updated using
- # `queue.yaml/xml`, `max_burst_size` is equal to
- # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
- # Since `max_burst_size` is output only, if
- # UpdateQueue is called on a queue
- # created by `queue.yaml/xml`, `max_burst_size` will be reset based
- # on the value of
- # max_dispatches_per_second,
- # regardless of whether
- # max_dispatches_per_second
- # is updated.
- },
- "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.
- # Http tasks are not affected.
- #
- # If set, `app_engine_routing_override` is used for all
- # App Engine tasks in the queue, no matter what the
- # setting is for the
- # task-level app_engine_routing.
- #
- # Defines routing characteristics specific to App Engine - service, version,
- # and instance.
- #
- # For more information about services, versions, and instances see
- # [An Overview of App
- # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
- # [Microservices Architecture on Google App
- # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
- # [App Engine Standard request
- # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
- # and [App Engine Flex request
- # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- #
- # Using AppEngineRouting requires
- # [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
- # Google IAM permission for the project
- # and the following scope:
- #
- # `https://www.googleapis.com/auth/cloud-platform`
- "service": "A String", # App service.
- #
- # By default, the task is sent to the service which is the default
- # service 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.
- "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
+ # For more information about services, versions, and instances see
+ # [An Overview of App
+ # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
+ # [Microservices Architecture on Google App
+ # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
# [App Engine Standard request
- # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
+ # 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.
+ # Using AppEngineRouting requires
+ # [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
+ # Google IAM permission for the project
+ # and the following scope:
#
- # 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.
+ # `https://www.googleapis.com/auth/cloud-platform`
+ "service": "A String", # App service.
+ #
+ # By default, the task is sent to the service which is the default
+ # service 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.
+ "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).
+ "version": "A String", # App version.
+ #
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
+ #
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
+ #
+ # 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).
+ },
+ "purgeTime": "A String", # Output only. The last time this queue was purged.
#
- # 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.
+ # All tasks that were created before this time
+ # were purged.
#
- # For more information, see
- # [How Requests are
- # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
- },
- }</pre>
+ # 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.
+ #
+ # 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).
+ "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).
+ },
+ "state": "A String", # Output only. The state of the queue.
+ #
+ # `state` can only be changed by called
+ # PauseQueue,
+ # ResumeQueue, or uploading
+ # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
+ # UpdateQueue cannot be used to change `state`.
+ "name": "A String", # Caller-specified and required in CreateQueue,
+ # after which it becomes output only.
+ #
+ # The queue name.
+ #
+ # The queue name must have the following format:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the queue's location.
+ # The list of available locations can be obtained by calling
+ # ListLocations.
+ # For more information, see https://cloud.google.com/about/locations/.
+ # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
+ # hyphens (-). The maximum length is 100 characters.
+ "rateLimits": { # Rate limits. # Rate limits for task dispatches.
+ #
+ # rate_limits and retry_config are
+ # related because they both control task attempts. However they control task
+ # attempts in different ways:
+ #
+ # * rate_limits controls the total rate of
+ # dispatches from a queue (i.e. all traffic dispatched from the
+ # queue, regardless of whether the dispatch is from a first
+ # attempt or a retry).
+ # * retry_config controls what happens to
+ # particular a task after its first attempt fails. That is,
+ # retry_config controls task retries (the
+ # second attempt, third attempt, etc).
+ #
+ # The queue's actual dispatch rate is the result of:
+ #
+ # * Number of tasks in the queue
+ # * User-specified throttling: rate_limits,
+ # retry_config, and the
+ # queue's state.
+ # * System throttling due to `429` (Too Many Requests) or `503` (Service
+ # Unavailable) responses from the worker, high error rates, or to smooth
+ # sudden large traffic spikes.
+ #
+ # This message determines the maximum rate that tasks can be dispatched by a
+ # queue, regardless of whether the dispatch is a first task attempt or a retry.
+ #
+ # Note: The debugging command, RunTask, will run a task
+ # even if the queue has reached its RateLimits.
+ "maxBurstSize": 42, # Output only. The max burst size.
+ #
+ # Max burst size limits how fast tasks in queue are processed when
+ # many tasks are in the queue and the rate is high. This field
+ # allows the queue to have a high rate so processing starts shortly
+ # after a task is enqueued, but still limits resource usage when
+ # many tasks are enqueued in a short period of time.
+ #
+ # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
+ # algorithm is used to control the rate of task dispatches. Each
+ # queue has a token bucket that holds tokens, up to the maximum
+ # specified by `max_burst_size`. Each time a task is dispatched, a
+ # token is removed from the bucket. Tasks will be dispatched until
+ # the queue's bucket runs out of tokens. The bucket will be
+ # continuously refilled with new tokens based on
+ # max_dispatches_per_second.
+ #
+ # Cloud Tasks will pick the value of `max_burst_size` based on the
+ # value of
+ # max_dispatches_per_second.
+ #
+ # For queues that were created or updated using
+ # `queue.yaml/xml`, `max_burst_size` is equal to
+ # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
+ # Since `max_burst_size` is output only, if
+ # UpdateQueue is called on a queue
+ # created by `queue.yaml/xml`, `max_burst_size` will be reset based
+ # on the value of
+ # max_dispatches_per_second,
+ # regardless of whether
+ # max_dispatches_per_second
+ # is updated.
+ "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
+ # to be dispatched for this queue. After this threshold has been
+ # reached, Cloud Tasks stops dispatching tasks until the number of
+ # concurrent requests decreases.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # The maximum allowed value is 5,000.
+ #
+ #
+ # This field has the same meaning as
+ # [max_concurrent_requests in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
+ "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).
+ },
+ "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
+ # field is unset, then no logs are written.
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ "samplingRatio": 3.14, # Specifies the fraction of operations to write to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ # This field may contain any value between 0.0 and 1.0, inclusive.
+ # 0.0 is the default and means that no operations are logged.
+ },
+ }</pre>
</div>
<div class="method">
@@ -1340,6 +1340,60 @@
# `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.
+ #
+ # 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.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "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.
+ },
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
@@ -1385,60 +1439,6 @@
#
"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.
- },
},
],
}</pre>
@@ -1488,335 +1488,6 @@
An object of the form:
{ # Response message for ListQueues.
- "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.
- "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.
- #
- # The queue name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the queue's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
- # hyphens (-). The maximum length is 100 characters.
- "rateLimits": { # Rate limits. # Rate limits for task dispatches.
- #
- # rate_limits and retry_config are
- # related because they both control task attempts. However they control task
- # attempts in different ways:
- #
- # * rate_limits controls the total rate of
- # dispatches from a queue (i.e. all traffic dispatched from the
- # queue, regardless of whether the dispatch is from a first
- # attempt or a retry).
- # * retry_config controls what happens to
- # particular a task after its first attempt fails. That is,
- # retry_config controls task retries (the
- # second attempt, third attempt, etc).
- #
- # The queue's actual dispatch rate is the result of:
- #
- # * Number of tasks in the queue
- # * User-specified throttling: rate_limits,
- # retry_config, and the
- # queue's state.
- # * System throttling due to `429` (Too Many Requests) or `503` (Service
- # Unavailable) responses from the worker, high error rates, or to smooth
- # sudden large traffic spikes.
- #
- # This message determines the maximum rate that tasks can be dispatched by a
- # queue, regardless of whether the dispatch is a first task attempt or a retry.
- #
- # Note: The debugging command, RunTask, will run a task
- # even if the queue has reached its RateLimits.
- "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
- # to be dispatched for this queue. After this threshold has been
- # reached, Cloud Tasks stops dispatching tasks until the number of
- # concurrent requests decreases.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- #
- # The maximum allowed value is 5,000.
- #
- #
- # This field has the same meaning as
- # [max_concurrent_requests in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
- "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
- # allows the queue to have a high rate so processing starts shortly
- # after a task is enqueued, but still limits resource usage when
- # many tasks are enqueued in a short period of time.
- #
- # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
- # algorithm is used to control the rate of task dispatches. Each
- # queue has a token bucket that holds tokens, up to the maximum
- # specified by `max_burst_size`. Each time a task is dispatched, a
- # token is removed from the bucket. Tasks will be dispatched until
- # the queue's bucket runs out of tokens. The bucket will be
- # continuously refilled with new tokens based on
- # max_dispatches_per_second.
- #
- # Cloud Tasks will pick the value of `max_burst_size` based on the
- # value of
- # max_dispatches_per_second.
- #
- # For queues that were created or updated using
- # `queue.yaml/xml`, `max_burst_size` is equal to
- # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
- # Since `max_burst_size` is output only, if
- # UpdateQueue is called on a queue
- # created by `queue.yaml/xml`, `max_burst_size` will be reset based
- # on the value of
- # max_dispatches_per_second,
- # regardless of whether
- # max_dispatches_per_second
- # is updated.
- },
- "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.
- # Http tasks are not affected.
- #
- # If set, `app_engine_routing_override` is used for all
- # App Engine tasks in the queue, no matter what the
- # setting is for the
- # task-level app_engine_routing.
- #
- # Defines routing characteristics specific to App Engine - service, version,
- # and instance.
- #
- # For more information about services, versions, and instances see
- # [An Overview of App
- # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
- # [Microservices Architecture on Google App
- # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
- # [App Engine Standard request
- # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
- # and [App Engine Flex request
- # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- #
- # Using AppEngineRouting requires
- # [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
- # Google IAM permission for the project
- # and the following scope:
- #
- # `https://www.googleapis.com/auth/cloud-platform`
- "service": "A String", # App service.
- #
- # By default, the task is sent to the service which is the default
- # service 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.
- "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).
- "version": "A String", # App version.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "host": "A String", # Output only. The host that the task is sent to.
- #
- # 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).
- },
- },
- ],
"nextPageToken": "A String", # A token to retrieve next page of results.
#
# To return the next page of results, call
@@ -1826,6 +1497,335 @@
# 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.
+ { # 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.
+ "appEngineRoutingOverride": { # App Engine Routing. # Overrides for
+ # task-level app_engine_routing.
+ # These settings apply only to
+ # App Engine tasks in this queue.
+ # Http tasks are not affected.
+ #
+ # If set, `app_engine_routing_override` is used for all
+ # App Engine tasks in the queue, no matter what the
+ # setting is for the
+ # task-level app_engine_routing.
+ #
+ # Defines routing characteristics specific to App Engine - service, version,
+ # and instance.
+ #
+ # For more information about services, versions, and instances see
+ # [An Overview of App
+ # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
+ # [Microservices Architecture on Google App
+ # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
+ # [App Engine Standard request
+ # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
+ # and [App Engine Flex request
+ # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
+ #
+ # Using AppEngineRouting requires
+ # [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
+ # Google IAM permission for the project
+ # and the following scope:
+ #
+ # `https://www.googleapis.com/auth/cloud-platform`
+ "service": "A String", # App service.
+ #
+ # By default, the task is sent to the service which is the default
+ # service 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.
+ "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).
+ "version": "A String", # App version.
+ #
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
+ #
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
+ #
+ # 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).
+ },
+ "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.
+ #
+ # 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).
+ "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).
+ },
+ "state": "A String", # Output only. The state of the queue.
+ #
+ # `state` can only be changed by called
+ # PauseQueue,
+ # ResumeQueue, or uploading
+ # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
+ # UpdateQueue cannot be used to change `state`.
+ "name": "A String", # Caller-specified and required in CreateQueue,
+ # after which it becomes output only.
+ #
+ # The queue name.
+ #
+ # The queue name must have the following format:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the queue's location.
+ # The list of available locations can be obtained by calling
+ # ListLocations.
+ # For more information, see https://cloud.google.com/about/locations/.
+ # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
+ # hyphens (-). The maximum length is 100 characters.
+ "rateLimits": { # Rate limits. # Rate limits for task dispatches.
+ #
+ # rate_limits and retry_config are
+ # related because they both control task attempts. However they control task
+ # attempts in different ways:
+ #
+ # * rate_limits controls the total rate of
+ # dispatches from a queue (i.e. all traffic dispatched from the
+ # queue, regardless of whether the dispatch is from a first
+ # attempt or a retry).
+ # * retry_config controls what happens to
+ # particular a task after its first attempt fails. That is,
+ # retry_config controls task retries (the
+ # second attempt, third attempt, etc).
+ #
+ # The queue's actual dispatch rate is the result of:
+ #
+ # * Number of tasks in the queue
+ # * User-specified throttling: rate_limits,
+ # retry_config, and the
+ # queue's state.
+ # * System throttling due to `429` (Too Many Requests) or `503` (Service
+ # Unavailable) responses from the worker, high error rates, or to smooth
+ # sudden large traffic spikes.
+ #
+ # This message determines the maximum rate that tasks can be dispatched by a
+ # queue, regardless of whether the dispatch is a first task attempt or a retry.
+ #
+ # Note: The debugging command, RunTask, will run a task
+ # even if the queue has reached its RateLimits.
+ "maxBurstSize": 42, # Output only. The max burst size.
+ #
+ # Max burst size limits how fast tasks in queue are processed when
+ # many tasks are in the queue and the rate is high. This field
+ # allows the queue to have a high rate so processing starts shortly
+ # after a task is enqueued, but still limits resource usage when
+ # many tasks are enqueued in a short period of time.
+ #
+ # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
+ # algorithm is used to control the rate of task dispatches. Each
+ # queue has a token bucket that holds tokens, up to the maximum
+ # specified by `max_burst_size`. Each time a task is dispatched, a
+ # token is removed from the bucket. Tasks will be dispatched until
+ # the queue's bucket runs out of tokens. The bucket will be
+ # continuously refilled with new tokens based on
+ # max_dispatches_per_second.
+ #
+ # Cloud Tasks will pick the value of `max_burst_size` based on the
+ # value of
+ # max_dispatches_per_second.
+ #
+ # For queues that were created or updated using
+ # `queue.yaml/xml`, `max_burst_size` is equal to
+ # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
+ # Since `max_burst_size` is output only, if
+ # UpdateQueue is called on a queue
+ # created by `queue.yaml/xml`, `max_burst_size` will be reset based
+ # on the value of
+ # max_dispatches_per_second,
+ # regardless of whether
+ # max_dispatches_per_second
+ # is updated.
+ "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
+ # to be dispatched for this queue. After this threshold has been
+ # reached, Cloud Tasks stops dispatching tasks until the number of
+ # concurrent requests decreases.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # The maximum allowed value is 5,000.
+ #
+ #
+ # This field has the same meaning as
+ # [max_concurrent_requests in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
+ "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).
+ },
+ "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
+ # field is unset, then no logs are written.
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ "samplingRatio": 3.14, # Specifies the fraction of operations to write to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ # This field may contain any value between 0.0 and 1.0, inclusive.
+ # 0.0 is the default and means that no operations are logged.
+ },
+ },
+ ],
}</pre>
</div>
@@ -1885,589 +1885,14 @@
The object takes the form of:
{ # 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.
- "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.
- #
- # The queue name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the queue's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
- # hyphens (-). The maximum length is 100 characters.
- "rateLimits": { # Rate limits. # Rate limits for task dispatches.
- #
- # rate_limits and retry_config are
- # related because they both control task attempts. However they control task
- # attempts in different ways:
- #
- # * rate_limits controls the total rate of
- # dispatches from a queue (i.e. all traffic dispatched from the
- # queue, regardless of whether the dispatch is from a first
- # attempt or a retry).
- # * retry_config controls what happens to
- # particular a task after its first attempt fails. That is,
- # retry_config controls task retries (the
- # second attempt, third attempt, etc).
- #
- # The queue's actual dispatch rate is the result of:
- #
- # * Number of tasks in the queue
- # * User-specified throttling: rate_limits,
- # retry_config, and the
- # queue's state.
- # * System throttling due to `429` (Too Many Requests) or `503` (Service
- # Unavailable) responses from the worker, high error rates, or to smooth
- # sudden large traffic spikes.
- #
- # This message determines the maximum rate that tasks can be dispatched by a
- # queue, regardless of whether the dispatch is a first task attempt or a retry.
- #
- # Note: The debugging command, RunTask, will run a task
- # even if the queue has reached its RateLimits.
- "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
- # to be dispatched for this queue. After this threshold has been
- # reached, Cloud Tasks stops dispatching tasks until the number of
- # concurrent requests decreases.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- #
- # The maximum allowed value is 5,000.
- #
- #
- # This field has the same meaning as
- # [max_concurrent_requests in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
- "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
- # allows the queue to have a high rate so processing starts shortly
- # after a task is enqueued, but still limits resource usage when
- # many tasks are enqueued in a short period of time.
- #
- # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
- # algorithm is used to control the rate of task dispatches. Each
- # queue has a token bucket that holds tokens, up to the maximum
- # specified by `max_burst_size`. Each time a task is dispatched, a
- # token is removed from the bucket. Tasks will be dispatched until
- # the queue's bucket runs out of tokens. The bucket will be
- # continuously refilled with new tokens based on
- # max_dispatches_per_second.
- #
- # Cloud Tasks will pick the value of `max_burst_size` based on the
- # value of
- # max_dispatches_per_second.
- #
- # For queues that were created or updated using
- # `queue.yaml/xml`, `max_burst_size` is equal to
- # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
- # Since `max_burst_size` is output only, if
- # UpdateQueue is called on a queue
- # created by `queue.yaml/xml`, `max_burst_size` will be reset based
- # on the value of
- # max_dispatches_per_second,
- # regardless of whether
- # max_dispatches_per_second
- # is updated.
- },
- "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.
- # Http tasks are not affected.
- #
- # If set, `app_engine_routing_override` is used for all
- # App Engine tasks in the queue, no matter what the
- # setting is for the
- # task-level app_engine_routing.
- #
- # Defines routing characteristics specific to App Engine - service, version,
- # and instance.
- #
- # For more information about services, versions, and instances see
- # [An Overview of App
- # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
- # [Microservices Architecture on Google App
- # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
- # [App Engine Standard request
- # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
- # and [App Engine Flex request
- # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- #
- # Using AppEngineRouting requires
- # [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
- # Google IAM permission for the project
- # and the following scope:
- #
- # `https://www.googleapis.com/auth/cloud-platform`
- "service": "A String", # App service.
- #
- # By default, the task is sent to the service which is the default
- # service 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.
- "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).
- "version": "A String", # App version.
- #
- # By default, the task is sent to the version which is the default
- # version when the task is attempted.
- #
- # For some queues or tasks which were created using the App Engine
- # Task Queue API, host is not parsable
- # into service,
- # version, and
- # instance. For example, some tasks
- # which were created using the App Engine SDK use a custom domain
- # name; custom domains are not parsed by Cloud Tasks. If
- # host is not parsable, then
- # service,
- # version, and
- # instance are the empty string.
- "host": "A String", # Output only. The host that the task is sent to.
- #
- # 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).
- },
-}
-
- updateMask: string, A mask used to specify which fields of the queue are being updated.
-
-If empty, then all fields will be updated.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # 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.
- "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.
- #
- # The queue name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the queue's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
- # hyphens (-). The maximum length is 100 characters.
- "rateLimits": { # Rate limits. # Rate limits for task dispatches.
- #
- # rate_limits and retry_config are
- # related because they both control task attempts. However they control task
- # attempts in different ways:
- #
- # * rate_limits controls the total rate of
- # dispatches from a queue (i.e. all traffic dispatched from the
- # queue, regardless of whether the dispatch is from a first
- # attempt or a retry).
- # * retry_config controls what happens to
- # particular a task after its first attempt fails. That is,
- # retry_config controls task retries (the
- # second attempt, third attempt, etc).
- #
- # The queue's actual dispatch rate is the result of:
- #
- # * Number of tasks in the queue
- # * User-specified throttling: rate_limits,
- # retry_config, and the
- # queue's state.
- # * System throttling due to `429` (Too Many Requests) or `503` (Service
- # Unavailable) responses from the worker, high error rates, or to smooth
- # sudden large traffic spikes.
- #
- # This message determines the maximum rate that tasks can be dispatched by a
- # queue, regardless of whether the dispatch is a first task attempt or a retry.
- #
- # Note: The debugging command, RunTask, will run a task
- # even if the queue has reached its RateLimits.
- "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
- # to be dispatched for this queue. After this threshold has been
- # reached, Cloud Tasks stops dispatching tasks until the number of
- # concurrent requests decreases.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- #
- # The maximum allowed value is 5,000.
- #
- #
- # This field has the same meaning as
- # [max_concurrent_requests in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
- "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
- # allows the queue to have a high rate so processing starts shortly
- # after a task is enqueued, but still limits resource usage when
- # many tasks are enqueued in a short period of time.
- #
- # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
- # algorithm is used to control the rate of task dispatches. Each
- # queue has a token bucket that holds tokens, up to the maximum
- # specified by `max_burst_size`. Each time a task is dispatched, a
- # token is removed from the bucket. Tasks will be dispatched until
- # the queue's bucket runs out of tokens. The bucket will be
- # continuously refilled with new tokens based on
- # max_dispatches_per_second.
- #
- # Cloud Tasks will pick the value of `max_burst_size` based on the
- # value of
- # max_dispatches_per_second.
- #
- # For queues that were created or updated using
- # `queue.yaml/xml`, `max_burst_size` is equal to
- # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
- # Since `max_burst_size` is output only, if
- # UpdateQueue is called on a queue
- # created by `queue.yaml/xml`, `max_burst_size` will be reset based
- # on the value of
- # max_dispatches_per_second,
- # regardless of whether
- # max_dispatches_per_second
- # is updated.
- },
- "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.
# Http tasks are not affected.
- #
+ #
# If set, `app_engine_routing_override` is used for all
# App Engine tasks in the queue, no matter what the
# setting is for the
@@ -2549,7 +1974,582 @@
# [How Requests are
# Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
},
- }</pre>
+ "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.
+ #
+ # 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).
+ "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).
+ },
+ "state": "A String", # Output only. The state of the queue.
+ #
+ # `state` can only be changed by called
+ # PauseQueue,
+ # ResumeQueue, or uploading
+ # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
+ # UpdateQueue cannot be used to change `state`.
+ "name": "A String", # Caller-specified and required in CreateQueue,
+ # after which it becomes output only.
+ #
+ # The queue name.
+ #
+ # The queue name must have the following format:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the queue's location.
+ # The list of available locations can be obtained by calling
+ # ListLocations.
+ # For more information, see https://cloud.google.com/about/locations/.
+ # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
+ # hyphens (-). The maximum length is 100 characters.
+ "rateLimits": { # Rate limits. # Rate limits for task dispatches.
+ #
+ # rate_limits and retry_config are
+ # related because they both control task attempts. However they control task
+ # attempts in different ways:
+ #
+ # * rate_limits controls the total rate of
+ # dispatches from a queue (i.e. all traffic dispatched from the
+ # queue, regardless of whether the dispatch is from a first
+ # attempt or a retry).
+ # * retry_config controls what happens to
+ # particular a task after its first attempt fails. That is,
+ # retry_config controls task retries (the
+ # second attempt, third attempt, etc).
+ #
+ # The queue's actual dispatch rate is the result of:
+ #
+ # * Number of tasks in the queue
+ # * User-specified throttling: rate_limits,
+ # retry_config, and the
+ # queue's state.
+ # * System throttling due to `429` (Too Many Requests) or `503` (Service
+ # Unavailable) responses from the worker, high error rates, or to smooth
+ # sudden large traffic spikes.
+ #
+ # This message determines the maximum rate that tasks can be dispatched by a
+ # queue, regardless of whether the dispatch is a first task attempt or a retry.
+ #
+ # Note: The debugging command, RunTask, will run a task
+ # even if the queue has reached its RateLimits.
+ "maxBurstSize": 42, # Output only. The max burst size.
+ #
+ # Max burst size limits how fast tasks in queue are processed when
+ # many tasks are in the queue and the rate is high. This field
+ # allows the queue to have a high rate so processing starts shortly
+ # after a task is enqueued, but still limits resource usage when
+ # many tasks are enqueued in a short period of time.
+ #
+ # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
+ # algorithm is used to control the rate of task dispatches. Each
+ # queue has a token bucket that holds tokens, up to the maximum
+ # specified by `max_burst_size`. Each time a task is dispatched, a
+ # token is removed from the bucket. Tasks will be dispatched until
+ # the queue's bucket runs out of tokens. The bucket will be
+ # continuously refilled with new tokens based on
+ # max_dispatches_per_second.
+ #
+ # Cloud Tasks will pick the value of `max_burst_size` based on the
+ # value of
+ # max_dispatches_per_second.
+ #
+ # For queues that were created or updated using
+ # `queue.yaml/xml`, `max_burst_size` is equal to
+ # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
+ # Since `max_burst_size` is output only, if
+ # UpdateQueue is called on a queue
+ # created by `queue.yaml/xml`, `max_burst_size` will be reset based
+ # on the value of
+ # max_dispatches_per_second,
+ # regardless of whether
+ # max_dispatches_per_second
+ # is updated.
+ "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
+ # to be dispatched for this queue. After this threshold has been
+ # reached, Cloud Tasks stops dispatching tasks until the number of
+ # concurrent requests decreases.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # The maximum allowed value is 5,000.
+ #
+ #
+ # This field has the same meaning as
+ # [max_concurrent_requests in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
+ "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).
+ },
+ "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.
+ },
+ }
+
+ updateMask: string, A mask used to specify which fields of the queue are being updated.
+
+If empty, then all fields will be updated.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # 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.
+ "appEngineRoutingOverride": { # App Engine Routing. # Overrides for
+ # task-level app_engine_routing.
+ # These settings apply only to
+ # App Engine tasks in this queue.
+ # Http tasks are not affected.
+ #
+ # If set, `app_engine_routing_override` is used for all
+ # App Engine tasks in the queue, no matter what the
+ # setting is for the
+ # task-level app_engine_routing.
+ #
+ # Defines routing characteristics specific to App Engine - service, version,
+ # and instance.
+ #
+ # For more information about services, versions, and instances see
+ # [An Overview of App
+ # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
+ # [Microservices Architecture on Google App
+ # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
+ # [App Engine Standard request
+ # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
+ # and [App Engine Flex request
+ # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
+ #
+ # Using AppEngineRouting requires
+ # [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
+ # Google IAM permission for the project
+ # and the following scope:
+ #
+ # `https://www.googleapis.com/auth/cloud-platform`
+ "service": "A String", # App service.
+ #
+ # By default, the task is sent to the service which is the default
+ # service 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.
+ "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).
+ "version": "A String", # App version.
+ #
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
+ #
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
+ #
+ # 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).
+ },
+ "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.
+ #
+ # 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).
+ "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).
+ },
+ "state": "A String", # Output only. The state of the queue.
+ #
+ # `state` can only be changed by called
+ # PauseQueue,
+ # ResumeQueue, or uploading
+ # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
+ # UpdateQueue cannot be used to change `state`.
+ "name": "A String", # Caller-specified and required in CreateQueue,
+ # after which it becomes output only.
+ #
+ # The queue name.
+ #
+ # The queue name must have the following format:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the queue's location.
+ # The list of available locations can be obtained by calling
+ # ListLocations.
+ # For more information, see https://cloud.google.com/about/locations/.
+ # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
+ # hyphens (-). The maximum length is 100 characters.
+ "rateLimits": { # Rate limits. # Rate limits for task dispatches.
+ #
+ # rate_limits and retry_config are
+ # related because they both control task attempts. However they control task
+ # attempts in different ways:
+ #
+ # * rate_limits controls the total rate of
+ # dispatches from a queue (i.e. all traffic dispatched from the
+ # queue, regardless of whether the dispatch is from a first
+ # attempt or a retry).
+ # * retry_config controls what happens to
+ # particular a task after its first attempt fails. That is,
+ # retry_config controls task retries (the
+ # second attempt, third attempt, etc).
+ #
+ # The queue's actual dispatch rate is the result of:
+ #
+ # * Number of tasks in the queue
+ # * User-specified throttling: rate_limits,
+ # retry_config, and the
+ # queue's state.
+ # * System throttling due to `429` (Too Many Requests) or `503` (Service
+ # Unavailable) responses from the worker, high error rates, or to smooth
+ # sudden large traffic spikes.
+ #
+ # This message determines the maximum rate that tasks can be dispatched by a
+ # queue, regardless of whether the dispatch is a first task attempt or a retry.
+ #
+ # Note: The debugging command, RunTask, will run a task
+ # even if the queue has reached its RateLimits.
+ "maxBurstSize": 42, # Output only. The max burst size.
+ #
+ # Max burst size limits how fast tasks in queue are processed when
+ # many tasks are in the queue and the rate is high. This field
+ # allows the queue to have a high rate so processing starts shortly
+ # after a task is enqueued, but still limits resource usage when
+ # many tasks are enqueued in a short period of time.
+ #
+ # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
+ # algorithm is used to control the rate of task dispatches. Each
+ # queue has a token bucket that holds tokens, up to the maximum
+ # specified by `max_burst_size`. Each time a task is dispatched, a
+ # token is removed from the bucket. Tasks will be dispatched until
+ # the queue's bucket runs out of tokens. The bucket will be
+ # continuously refilled with new tokens based on
+ # max_dispatches_per_second.
+ #
+ # Cloud Tasks will pick the value of `max_burst_size` based on the
+ # value of
+ # max_dispatches_per_second.
+ #
+ # For queues that were created or updated using
+ # `queue.yaml/xml`, `max_burst_size` is equal to
+ # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
+ # Since `max_burst_size` is output only, if
+ # UpdateQueue is called on a queue
+ # created by `queue.yaml/xml`, `max_burst_size` will be reset based
+ # on the value of
+ # max_dispatches_per_second,
+ # regardless of whether
+ # max_dispatches_per_second
+ # is updated.
+ "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
+ # to be dispatched for this queue. After this threshold has been
+ # reached, Cloud Tasks stops dispatching tasks until the number of
+ # concurrent requests decreases.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # The maximum allowed value is 5,000.
+ #
+ #
+ # This field has the same meaning as
+ # [max_concurrent_requests in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
+ "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).
+ },
+ "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
+ # field is unset, then no logs are written.
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ "samplingRatio": 3.14, # Specifies the fraction of operations to write to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ # This field may contain any value between 0.0 and 1.0, inclusive.
+ # 0.0 is the default and means that no operations are logged.
+ },
+ }</pre>
</div>
<div class="method">
@@ -2580,332 +2580,332 @@
An object of the form:
{ # 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.
- "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.
+ # how those tasks are dispatched. Configurable properties include rate limits,
+ # retry options, queue types, and others.
+ "appEngineRoutingOverride": { # App Engine Routing. # Overrides for
+ # task-level app_engine_routing.
+ # These settings apply only to
+ # App Engine tasks in this queue.
+ # Http tasks are not affected.
#
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
+ # If set, `app_engine_routing_override` is used for all
+ # App Engine tasks in the queue, no matter what the
+ # setting is for the
+ # task-level app_engine_routing.
#
+ # Defines routing characteristics specific to App Engine - service, version,
+ # and instance.
#
- # `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.
- #
- # The queue name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the queue's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
- # hyphens (-). The maximum length is 100 characters.
- "rateLimits": { # Rate limits. # Rate limits for task dispatches.
- #
- # rate_limits and retry_config are
- # related because they both control task attempts. However they control task
- # attempts in different ways:
- #
- # * rate_limits controls the total rate of
- # dispatches from a queue (i.e. all traffic dispatched from the
- # queue, regardless of whether the dispatch is from a first
- # attempt or a retry).
- # * retry_config controls what happens to
- # particular a task after its first attempt fails. That is,
- # retry_config controls task retries (the
- # second attempt, third attempt, etc).
- #
- # The queue's actual dispatch rate is the result of:
- #
- # * Number of tasks in the queue
- # * User-specified throttling: rate_limits,
- # retry_config, and the
- # queue's state.
- # * System throttling due to `429` (Too Many Requests) or `503` (Service
- # Unavailable) responses from the worker, high error rates, or to smooth
- # sudden large traffic spikes.
- #
- # This message determines the maximum rate that tasks can be dispatched by a
- # queue, regardless of whether the dispatch is a first task attempt or a retry.
- #
- # Note: The debugging command, RunTask, will run a task
- # even if the queue has reached its RateLimits.
- "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
- # to be dispatched for this queue. After this threshold has been
- # reached, Cloud Tasks stops dispatching tasks until the number of
- # concurrent requests decreases.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- #
- # The maximum allowed value is 5,000.
- #
- #
- # This field has the same meaning as
- # [max_concurrent_requests in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
- "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
- # allows the queue to have a high rate so processing starts shortly
- # after a task is enqueued, but still limits resource usage when
- # many tasks are enqueued in a short period of time.
- #
- # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
- # algorithm is used to control the rate of task dispatches. Each
- # queue has a token bucket that holds tokens, up to the maximum
- # specified by `max_burst_size`. Each time a task is dispatched, a
- # token is removed from the bucket. Tasks will be dispatched until
- # the queue's bucket runs out of tokens. The bucket will be
- # continuously refilled with new tokens based on
- # max_dispatches_per_second.
- #
- # Cloud Tasks will pick the value of `max_burst_size` based on the
- # value of
- # max_dispatches_per_second.
- #
- # For queues that were created or updated using
- # `queue.yaml/xml`, `max_burst_size` is equal to
- # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
- # Since `max_burst_size` is output only, if
- # UpdateQueue is called on a queue
- # created by `queue.yaml/xml`, `max_burst_size` will be reset based
- # on the value of
- # max_dispatches_per_second,
- # regardless of whether
- # max_dispatches_per_second
- # is updated.
- },
- "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.
- # Http tasks are not affected.
- #
- # If set, `app_engine_routing_override` is used for all
- # App Engine tasks in the queue, no matter what the
- # setting is for the
- # task-level app_engine_routing.
- #
- # Defines routing characteristics specific to App Engine - service, version,
- # and instance.
- #
- # For more information about services, versions, and instances see
- # [An Overview of App
- # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
- # [Microservices Architecture on Google App
- # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
- # [App Engine Standard request
- # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
- # and [App Engine Flex request
- # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- #
- # Using AppEngineRouting requires
- # [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
- # Google IAM permission for the project
- # and the following scope:
- #
- # `https://www.googleapis.com/auth/cloud-platform`
- "service": "A String", # App service.
- #
- # By default, the task is sent to the service which is the default
- # service 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.
- "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
+ # For more information about services, versions, and instances see
+ # [An Overview of App
+ # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
+ # [Microservices Architecture on Google App
+ # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
# [App Engine Standard request
- # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
+ # 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.
+ # Using AppEngineRouting requires
+ # [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
+ # Google IAM permission for the project
+ # and the following scope:
#
- # 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.
+ # `https://www.googleapis.com/auth/cloud-platform`
+ "service": "A String", # App service.
+ #
+ # By default, the task is sent to the service which is the default
+ # service 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.
+ "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).
+ "version": "A String", # App version.
+ #
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
+ #
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
+ #
+ # 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).
+ },
+ "purgeTime": "A String", # Output only. The last time this queue was purged.
#
- # 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.
+ # All tasks that were created before this time
+ # were purged.
#
- # For more information, see
- # [How Requests are
- # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
- },
- }</pre>
+ # 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.
+ #
+ # 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).
+ "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).
+ },
+ "state": "A String", # Output only. The state of the queue.
+ #
+ # `state` can only be changed by called
+ # PauseQueue,
+ # ResumeQueue, or uploading
+ # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
+ # UpdateQueue cannot be used to change `state`.
+ "name": "A String", # Caller-specified and required in CreateQueue,
+ # after which it becomes output only.
+ #
+ # The queue name.
+ #
+ # The queue name must have the following format:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the queue's location.
+ # The list of available locations can be obtained by calling
+ # ListLocations.
+ # For more information, see https://cloud.google.com/about/locations/.
+ # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
+ # hyphens (-). The maximum length is 100 characters.
+ "rateLimits": { # Rate limits. # Rate limits for task dispatches.
+ #
+ # rate_limits and retry_config are
+ # related because they both control task attempts. However they control task
+ # attempts in different ways:
+ #
+ # * rate_limits controls the total rate of
+ # dispatches from a queue (i.e. all traffic dispatched from the
+ # queue, regardless of whether the dispatch is from a first
+ # attempt or a retry).
+ # * retry_config controls what happens to
+ # particular a task after its first attempt fails. That is,
+ # retry_config controls task retries (the
+ # second attempt, third attempt, etc).
+ #
+ # The queue's actual dispatch rate is the result of:
+ #
+ # * Number of tasks in the queue
+ # * User-specified throttling: rate_limits,
+ # retry_config, and the
+ # queue's state.
+ # * System throttling due to `429` (Too Many Requests) or `503` (Service
+ # Unavailable) responses from the worker, high error rates, or to smooth
+ # sudden large traffic spikes.
+ #
+ # This message determines the maximum rate that tasks can be dispatched by a
+ # queue, regardless of whether the dispatch is a first task attempt or a retry.
+ #
+ # Note: The debugging command, RunTask, will run a task
+ # even if the queue has reached its RateLimits.
+ "maxBurstSize": 42, # Output only. The max burst size.
+ #
+ # Max burst size limits how fast tasks in queue are processed when
+ # many tasks are in the queue and the rate is high. This field
+ # allows the queue to have a high rate so processing starts shortly
+ # after a task is enqueued, but still limits resource usage when
+ # many tasks are enqueued in a short period of time.
+ #
+ # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
+ # algorithm is used to control the rate of task dispatches. Each
+ # queue has a token bucket that holds tokens, up to the maximum
+ # specified by `max_burst_size`. Each time a task is dispatched, a
+ # token is removed from the bucket. Tasks will be dispatched until
+ # the queue's bucket runs out of tokens. The bucket will be
+ # continuously refilled with new tokens based on
+ # max_dispatches_per_second.
+ #
+ # Cloud Tasks will pick the value of `max_burst_size` based on the
+ # value of
+ # max_dispatches_per_second.
+ #
+ # For queues that were created or updated using
+ # `queue.yaml/xml`, `max_burst_size` is equal to
+ # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
+ # Since `max_burst_size` is output only, if
+ # UpdateQueue is called on a queue
+ # created by `queue.yaml/xml`, `max_burst_size` will be reset based
+ # on the value of
+ # max_dispatches_per_second,
+ # regardless of whether
+ # max_dispatches_per_second
+ # is updated.
+ "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
+ # to be dispatched for this queue. After this threshold has been
+ # reached, Cloud Tasks stops dispatching tasks until the number of
+ # concurrent requests decreases.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # The maximum allowed value is 5,000.
+ #
+ #
+ # This field has the same meaning as
+ # [max_concurrent_requests in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
+ "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).
+ },
+ "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
+ # field is unset, then no logs are written.
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ "samplingRatio": 3.14, # Specifies the fraction of operations to write to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ # This field may contain any value between 0.0 and 1.0, inclusive.
+ # 0.0 is the default and means that no operations are logged.
+ },
+ }</pre>
</div>
<div class="method">
@@ -2935,332 +2935,332 @@
An object of the form:
{ # 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.
- "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.
+ # how those tasks are dispatched. Configurable properties include rate limits,
+ # retry options, queue types, and others.
+ "appEngineRoutingOverride": { # App Engine Routing. # Overrides for
+ # task-level app_engine_routing.
+ # These settings apply only to
+ # App Engine tasks in this queue.
+ # Http tasks are not affected.
#
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
+ # If set, `app_engine_routing_override` is used for all
+ # App Engine tasks in the queue, no matter what the
+ # setting is for the
+ # task-level app_engine_routing.
#
+ # Defines routing characteristics specific to App Engine - service, version,
+ # and instance.
#
- # `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.
- #
- # The queue name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the queue's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
- # hyphens (-). The maximum length is 100 characters.
- "rateLimits": { # Rate limits. # Rate limits for task dispatches.
- #
- # rate_limits and retry_config are
- # related because they both control task attempts. However they control task
- # attempts in different ways:
- #
- # * rate_limits controls the total rate of
- # dispatches from a queue (i.e. all traffic dispatched from the
- # queue, regardless of whether the dispatch is from a first
- # attempt or a retry).
- # * retry_config controls what happens to
- # particular a task after its first attempt fails. That is,
- # retry_config controls task retries (the
- # second attempt, third attempt, etc).
- #
- # The queue's actual dispatch rate is the result of:
- #
- # * Number of tasks in the queue
- # * User-specified throttling: rate_limits,
- # retry_config, and the
- # queue's state.
- # * System throttling due to `429` (Too Many Requests) or `503` (Service
- # Unavailable) responses from the worker, high error rates, or to smooth
- # sudden large traffic spikes.
- #
- # This message determines the maximum rate that tasks can be dispatched by a
- # queue, regardless of whether the dispatch is a first task attempt or a retry.
- #
- # Note: The debugging command, RunTask, will run a task
- # even if the queue has reached its RateLimits.
- "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
- # to be dispatched for this queue. After this threshold has been
- # reached, Cloud Tasks stops dispatching tasks until the number of
- # concurrent requests decreases.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- #
- # The maximum allowed value is 5,000.
- #
- #
- # This field has the same meaning as
- # [max_concurrent_requests in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
- "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
- # allows the queue to have a high rate so processing starts shortly
- # after a task is enqueued, but still limits resource usage when
- # many tasks are enqueued in a short period of time.
- #
- # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
- # algorithm is used to control the rate of task dispatches. Each
- # queue has a token bucket that holds tokens, up to the maximum
- # specified by `max_burst_size`. Each time a task is dispatched, a
- # token is removed from the bucket. Tasks will be dispatched until
- # the queue's bucket runs out of tokens. The bucket will be
- # continuously refilled with new tokens based on
- # max_dispatches_per_second.
- #
- # Cloud Tasks will pick the value of `max_burst_size` based on the
- # value of
- # max_dispatches_per_second.
- #
- # For queues that were created or updated using
- # `queue.yaml/xml`, `max_burst_size` is equal to
- # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
- # Since `max_burst_size` is output only, if
- # UpdateQueue is called on a queue
- # created by `queue.yaml/xml`, `max_burst_size` will be reset based
- # on the value of
- # max_dispatches_per_second,
- # regardless of whether
- # max_dispatches_per_second
- # is updated.
- },
- "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.
- # Http tasks are not affected.
- #
- # If set, `app_engine_routing_override` is used for all
- # App Engine tasks in the queue, no matter what the
- # setting is for the
- # task-level app_engine_routing.
- #
- # Defines routing characteristics specific to App Engine - service, version,
- # and instance.
- #
- # For more information about services, versions, and instances see
- # [An Overview of App
- # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
- # [Microservices Architecture on Google App
- # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
- # [App Engine Standard request
- # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
- # and [App Engine Flex request
- # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- #
- # Using AppEngineRouting requires
- # [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
- # Google IAM permission for the project
- # and the following scope:
- #
- # `https://www.googleapis.com/auth/cloud-platform`
- "service": "A String", # App service.
- #
- # By default, the task is sent to the service which is the default
- # service 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.
- "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
+ # For more information about services, versions, and instances see
+ # [An Overview of App
+ # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
+ # [Microservices Architecture on Google App
+ # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
# [App Engine Standard request
- # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
+ # 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.
+ # Using AppEngineRouting requires
+ # [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
+ # Google IAM permission for the project
+ # and the following scope:
#
- # 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.
+ # `https://www.googleapis.com/auth/cloud-platform`
+ "service": "A String", # App service.
+ #
+ # By default, the task is sent to the service which is the default
+ # service 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.
+ "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).
+ "version": "A String", # App version.
+ #
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
+ #
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
+ #
+ # 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).
+ },
+ "purgeTime": "A String", # Output only. The last time this queue was purged.
#
- # 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.
+ # All tasks that were created before this time
+ # were purged.
#
- # For more information, see
- # [How Requests are
- # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
- },
- }</pre>
+ # 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.
+ #
+ # 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).
+ "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).
+ },
+ "state": "A String", # Output only. The state of the queue.
+ #
+ # `state` can only be changed by called
+ # PauseQueue,
+ # ResumeQueue, or uploading
+ # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
+ # UpdateQueue cannot be used to change `state`.
+ "name": "A String", # Caller-specified and required in CreateQueue,
+ # after which it becomes output only.
+ #
+ # The queue name.
+ #
+ # The queue name must have the following format:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the queue's location.
+ # The list of available locations can be obtained by calling
+ # ListLocations.
+ # For more information, see https://cloud.google.com/about/locations/.
+ # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
+ # hyphens (-). The maximum length is 100 characters.
+ "rateLimits": { # Rate limits. # Rate limits for task dispatches.
+ #
+ # rate_limits and retry_config are
+ # related because they both control task attempts. However they control task
+ # attempts in different ways:
+ #
+ # * rate_limits controls the total rate of
+ # dispatches from a queue (i.e. all traffic dispatched from the
+ # queue, regardless of whether the dispatch is from a first
+ # attempt or a retry).
+ # * retry_config controls what happens to
+ # particular a task after its first attempt fails. That is,
+ # retry_config controls task retries (the
+ # second attempt, third attempt, etc).
+ #
+ # The queue's actual dispatch rate is the result of:
+ #
+ # * Number of tasks in the queue
+ # * User-specified throttling: rate_limits,
+ # retry_config, and the
+ # queue's state.
+ # * System throttling due to `429` (Too Many Requests) or `503` (Service
+ # Unavailable) responses from the worker, high error rates, or to smooth
+ # sudden large traffic spikes.
+ #
+ # This message determines the maximum rate that tasks can be dispatched by a
+ # queue, regardless of whether the dispatch is a first task attempt or a retry.
+ #
+ # Note: The debugging command, RunTask, will run a task
+ # even if the queue has reached its RateLimits.
+ "maxBurstSize": 42, # Output only. The max burst size.
+ #
+ # Max burst size limits how fast tasks in queue are processed when
+ # many tasks are in the queue and the rate is high. This field
+ # allows the queue to have a high rate so processing starts shortly
+ # after a task is enqueued, but still limits resource usage when
+ # many tasks are enqueued in a short period of time.
+ #
+ # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
+ # algorithm is used to control the rate of task dispatches. Each
+ # queue has a token bucket that holds tokens, up to the maximum
+ # specified by `max_burst_size`. Each time a task is dispatched, a
+ # token is removed from the bucket. Tasks will be dispatched until
+ # the queue's bucket runs out of tokens. The bucket will be
+ # continuously refilled with new tokens based on
+ # max_dispatches_per_second.
+ #
+ # Cloud Tasks will pick the value of `max_burst_size` based on the
+ # value of
+ # max_dispatches_per_second.
+ #
+ # For queues that were created or updated using
+ # `queue.yaml/xml`, `max_burst_size` is equal to
+ # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
+ # Since `max_burst_size` is output only, if
+ # UpdateQueue is called on a queue
+ # created by `queue.yaml/xml`, `max_burst_size` will be reset based
+ # on the value of
+ # max_dispatches_per_second,
+ # regardless of whether
+ # max_dispatches_per_second
+ # is updated.
+ "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
+ # to be dispatched for this queue. After this threshold has been
+ # reached, Cloud Tasks stops dispatching tasks until the number of
+ # concurrent requests decreases.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # The maximum allowed value is 5,000.
+ #
+ #
+ # This field has the same meaning as
+ # [max_concurrent_requests in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
+ "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).
+ },
+ "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
+ # field is unset, then no logs are written.
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ "samplingRatio": 3.14, # Specifies the fraction of operations to write to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ # This field may contain any value between 0.0 and 1.0, inclusive.
+ # 0.0 is the default and means that no operations are logged.
+ },
+ }</pre>
</div>
<div class="method">
@@ -3297,332 +3297,332 @@
An object of the form:
{ # 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.
- "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.
+ # how those tasks are dispatched. Configurable properties include rate limits,
+ # retry options, queue types, and others.
+ "appEngineRoutingOverride": { # App Engine Routing. # Overrides for
+ # task-level app_engine_routing.
+ # These settings apply only to
+ # App Engine tasks in this queue.
+ # Http tasks are not affected.
#
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
+ # If set, `app_engine_routing_override` is used for all
+ # App Engine tasks in the queue, no matter what the
+ # setting is for the
+ # task-level app_engine_routing.
#
+ # Defines routing characteristics specific to App Engine - service, version,
+ # and instance.
#
- # `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.
- #
- # The queue name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the queue's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
- # hyphens (-). The maximum length is 100 characters.
- "rateLimits": { # Rate limits. # Rate limits for task dispatches.
- #
- # rate_limits and retry_config are
- # related because they both control task attempts. However they control task
- # attempts in different ways:
- #
- # * rate_limits controls the total rate of
- # dispatches from a queue (i.e. all traffic dispatched from the
- # queue, regardless of whether the dispatch is from a first
- # attempt or a retry).
- # * retry_config controls what happens to
- # particular a task after its first attempt fails. That is,
- # retry_config controls task retries (the
- # second attempt, third attempt, etc).
- #
- # The queue's actual dispatch rate is the result of:
- #
- # * Number of tasks in the queue
- # * User-specified throttling: rate_limits,
- # retry_config, and the
- # queue's state.
- # * System throttling due to `429` (Too Many Requests) or `503` (Service
- # Unavailable) responses from the worker, high error rates, or to smooth
- # sudden large traffic spikes.
- #
- # This message determines the maximum rate that tasks can be dispatched by a
- # queue, regardless of whether the dispatch is a first task attempt or a retry.
- #
- # Note: The debugging command, RunTask, will run a task
- # even if the queue has reached its RateLimits.
- "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
- # to be dispatched for this queue. After this threshold has been
- # reached, Cloud Tasks stops dispatching tasks until the number of
- # concurrent requests decreases.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- #
- # The maximum allowed value is 5,000.
- #
- #
- # This field has the same meaning as
- # [max_concurrent_requests in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
- "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
- # allows the queue to have a high rate so processing starts shortly
- # after a task is enqueued, but still limits resource usage when
- # many tasks are enqueued in a short period of time.
- #
- # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
- # algorithm is used to control the rate of task dispatches. Each
- # queue has a token bucket that holds tokens, up to the maximum
- # specified by `max_burst_size`. Each time a task is dispatched, a
- # token is removed from the bucket. Tasks will be dispatched until
- # the queue's bucket runs out of tokens. The bucket will be
- # continuously refilled with new tokens based on
- # max_dispatches_per_second.
- #
- # Cloud Tasks will pick the value of `max_burst_size` based on the
- # value of
- # max_dispatches_per_second.
- #
- # For queues that were created or updated using
- # `queue.yaml/xml`, `max_burst_size` is equal to
- # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
- # Since `max_burst_size` is output only, if
- # UpdateQueue is called on a queue
- # created by `queue.yaml/xml`, `max_burst_size` will be reset based
- # on the value of
- # max_dispatches_per_second,
- # regardless of whether
- # max_dispatches_per_second
- # is updated.
- },
- "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.
- # Http tasks are not affected.
- #
- # If set, `app_engine_routing_override` is used for all
- # App Engine tasks in the queue, no matter what the
- # setting is for the
- # task-level app_engine_routing.
- #
- # Defines routing characteristics specific to App Engine - service, version,
- # and instance.
- #
- # For more information about services, versions, and instances see
- # [An Overview of App
- # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
- # [Microservices Architecture on Google App
- # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
- # [App Engine Standard request
- # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
- # and [App Engine Flex request
- # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- #
- # Using AppEngineRouting requires
- # [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
- # Google IAM permission for the project
- # and the following scope:
- #
- # `https://www.googleapis.com/auth/cloud-platform`
- "service": "A String", # App service.
- #
- # By default, the task is sent to the service which is the default
- # service 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.
- "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
+ # For more information about services, versions, and instances see
+ # [An Overview of App
+ # Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
+ # [Microservices Architecture on Google App
+ # Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
# [App Engine Standard request
- # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
+ # 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.
+ # Using AppEngineRouting requires
+ # [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
+ # Google IAM permission for the project
+ # and the following scope:
#
- # 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.
+ # `https://www.googleapis.com/auth/cloud-platform`
+ "service": "A String", # App service.
+ #
+ # By default, the task is sent to the service which is the default
+ # service 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.
+ "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).
+ "version": "A String", # App version.
+ #
+ # By default, the task is sent to the version which is the default
+ # version when the task is attempted.
+ #
+ # For some queues or tasks which were created using the App Engine
+ # Task Queue API, host is not parsable
+ # into service,
+ # version, and
+ # instance. For example, some tasks
+ # which were created using the App Engine SDK use a custom domain
+ # name; custom domains are not parsed by Cloud Tasks. If
+ # host is not parsable, then
+ # service,
+ # version, and
+ # instance are the empty string.
+ "host": "A String", # Output only. The host that the task is sent to.
+ #
+ # 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).
+ },
+ "purgeTime": "A String", # Output only. The last time this queue was purged.
#
- # 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.
+ # All tasks that were created before this time
+ # were purged.
#
- # For more information, see
- # [How Requests are
- # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
- },
- }</pre>
+ # 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.
+ #
+ # 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).
+ "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).
+ },
+ "state": "A String", # Output only. The state of the queue.
+ #
+ # `state` can only be changed by called
+ # PauseQueue,
+ # ResumeQueue, or uploading
+ # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
+ # UpdateQueue cannot be used to change `state`.
+ "name": "A String", # Caller-specified and required in CreateQueue,
+ # after which it becomes output only.
+ #
+ # The queue name.
+ #
+ # The queue name must have the following format:
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
+ #
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+ # hyphens (-), colons (:), or periods (.).
+ # For more information, see
+ # [Identifying
+ # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+ # * `LOCATION_ID` is the canonical ID for the queue's location.
+ # The list of available locations can be obtained by calling
+ # ListLocations.
+ # For more information, see https://cloud.google.com/about/locations/.
+ # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
+ # hyphens (-). The maximum length is 100 characters.
+ "rateLimits": { # Rate limits. # Rate limits for task dispatches.
+ #
+ # rate_limits and retry_config are
+ # related because they both control task attempts. However they control task
+ # attempts in different ways:
+ #
+ # * rate_limits controls the total rate of
+ # dispatches from a queue (i.e. all traffic dispatched from the
+ # queue, regardless of whether the dispatch is from a first
+ # attempt or a retry).
+ # * retry_config controls what happens to
+ # particular a task after its first attempt fails. That is,
+ # retry_config controls task retries (the
+ # second attempt, third attempt, etc).
+ #
+ # The queue's actual dispatch rate is the result of:
+ #
+ # * Number of tasks in the queue
+ # * User-specified throttling: rate_limits,
+ # retry_config, and the
+ # queue's state.
+ # * System throttling due to `429` (Too Many Requests) or `503` (Service
+ # Unavailable) responses from the worker, high error rates, or to smooth
+ # sudden large traffic spikes.
+ #
+ # This message determines the maximum rate that tasks can be dispatched by a
+ # queue, regardless of whether the dispatch is a first task attempt or a retry.
+ #
+ # Note: The debugging command, RunTask, will run a task
+ # even if the queue has reached its RateLimits.
+ "maxBurstSize": 42, # Output only. The max burst size.
+ #
+ # Max burst size limits how fast tasks in queue are processed when
+ # many tasks are in the queue and the rate is high. This field
+ # allows the queue to have a high rate so processing starts shortly
+ # after a task is enqueued, but still limits resource usage when
+ # many tasks are enqueued in a short period of time.
+ #
+ # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
+ # algorithm is used to control the rate of task dispatches. Each
+ # queue has a token bucket that holds tokens, up to the maximum
+ # specified by `max_burst_size`. Each time a task is dispatched, a
+ # token is removed from the bucket. Tasks will be dispatched until
+ # the queue's bucket runs out of tokens. The bucket will be
+ # continuously refilled with new tokens based on
+ # max_dispatches_per_second.
+ #
+ # Cloud Tasks will pick the value of `max_burst_size` based on the
+ # value of
+ # max_dispatches_per_second.
+ #
+ # For queues that were created or updated using
+ # `queue.yaml/xml`, `max_burst_size` is equal to
+ # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
+ # Since `max_burst_size` is output only, if
+ # UpdateQueue is called on a queue
+ # created by `queue.yaml/xml`, `max_burst_size` will be reset based
+ # on the value of
+ # max_dispatches_per_second,
+ # regardless of whether
+ # max_dispatches_per_second
+ # is updated.
+ "maxConcurrentDispatches": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
+ # to be dispatched for this queue. After this threshold has been
+ # reached, Cloud Tasks stops dispatching tasks until the number of
+ # concurrent requests decreases.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ #
+ # The maximum allowed value is 5,000.
+ #
+ #
+ # This field has the same meaning as
+ # [max_concurrent_requests in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
+ "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).
+ },
+ "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
+ # field is unset, then no logs are written.
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ "samplingRatio": 3.14, # Specifies the fraction of operations to write to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ # This field may contain any value between 0.0 and 1.0, inclusive.
+ # 0.0 is the default and means that no operations are logged.
+ },
+ }</pre>
</div>
<div class="method">
@@ -3756,6 +3756,60 @@
# `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.
+ #
+ # 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.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "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.
+ },
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
@@ -3801,60 +3855,6 @@
#
"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.
- },
},
],
},
@@ -3975,6 +3975,60 @@
# `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.
+ #
+ # 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.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "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.
+ },
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
@@ -4020,60 +4074,6 @@
#
"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.
- },
},
],
}</pre>