docs: update generated docs (#981)
diff --git a/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.html b/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.html
index ff1a3a2..f4320f4 100644
--- a/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.html
+++ b/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.html
@@ -92,7 +92,7 @@
<code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the access control policy for a Queue.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists queues.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -144,144 +144,6 @@
{ # A queue is a container of related tasks. Queues are configured to manage
# how those tasks are dispatched. Configurable properties include rate limits,
# retry options, target types, and others.
- "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.
- "state": "A String", # Output only. The state of the queue.
- #
- # `state` can only be changed by called
- # PauseQueue,
- # ResumeQueue, or uploading
- # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
- # UpdateQueue cannot be used to change `state`.
- "retryConfig": { # Retry config. # Settings that determine the retry behavior.
- #
- # * For tasks created using Cloud Tasks: the queue-level retry settings
- # apply to all tasks in the queue that were created using Cloud Tasks.
- # 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 how 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.
- #
- # This field is output only for pull queues.
- #
- #
- # `min_backoff` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [min_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxBackoff": "A String", # A task will be scheduled for retry between
- # min_backoff and
- # max_backoff duration after it fails,
- # if the queue's RetryConfig specifies that the task should be
- # retried.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- # This field is output only for pull queues.
- #
- #
- # `max_backoff` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [max_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
- # retrying a failed task, measured from when the task was first
- # attempted. Once `max_retry_duration` time has passed *and* the
- # task has been attempted max_attempts
- # times, no further attempts will be made and the task will be
- # deleted.
- #
- # If zero, then the task age is unlimited.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- # This field is output only for pull queues.
- #
- #
- # `max_retry_duration` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [task_age_limit in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxDoublings": 42, # The time between retries will double `max_doublings` times.
- #
- # A task's retry interval starts at
- # min_backoff, then doubles
- # `max_doublings` times, then increases linearly, and finally
- # retries at intervals of
- # 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 is output only for pull queues.
- #
- #
- # This field has the same meaning as
- # [max_doublings in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxAttempts": 42, # The maximum number of attempts for a task.
- #
- # Cloud Tasks will attempt the task `max_attempts` times (that
- # is, if the first attempt fails, then there will be
- # `max_attempts - 1` retries). Must be > 0.
- "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
- },
- "name": "A String", # Caller-specified and required in CreateQueue,
- # after which it becomes output only.
- #
- # The queue name.
- #
- # The queue name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the queue's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
- # hyphens (-). The maximum length is 100 characters.
"rateLimits": { # Rate limits. # Rate limits for task dispatches.
#
# rate_limits and
@@ -303,21 +165,25 @@
#
# Note: The debugging command, RunTask, will run a task
# even if the queue has reached its RateLimits.
- "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
+ "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
+ # to be dispatched for this queue. After this threshold has been
+ # reached, Cloud Tasks stops dispatching tasks until the number of
+ # concurrent requests decreases.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # * For App Engine queues, the maximum allowed value
- # is 500.
- # * This field is output only for pull queues. In addition to the
- # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
- # LeaseTasks requests are allowed per pull queue.
+ #
+ # The maximum allowed value is 5,000.
+ #
+ # This field is output only for
+ # pull queues and always -1, which indicates no limit. No other
+ # queue types can have `max_concurrent_tasks` set to -1.
#
#
# This field has the same meaning as
- # [rate in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
+ # [max_concurrent_requests in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
"maxBurstSize": 42, # Output only. The max burst size.
#
# Max burst size limits how fast tasks in queue are processed when
@@ -350,29 +216,122 @@
# regardless of whether
# max_tasks_dispatched_per_second
# is updated.
- "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
- # to be dispatched for this queue. After this threshold has been
- # reached, Cloud Tasks stops dispatching tasks until the number of
- # concurrent requests decreases.
+ "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- #
- # The maximum allowed value is 5,000.
- #
- # This field is output only for
- # pull queues and always -1, which indicates no limit. No other
- # queue types can have `max_concurrent_tasks` set to -1.
+ # * For App Engine queues, the maximum allowed value
+ # is 500.
+ # * This field is output only for pull queues. In addition to the
+ # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
+ # LeaseTasks requests are allowed per pull queue.
#
#
# This field has the same meaning as
- # [max_concurrent_requests in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
+ # [rate in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
},
- "pullTarget": { # Pull target. # Pull target.
+ "retryConfig": { # Retry config. # Settings that determine the retry behavior.
#
- # A pull queue is a queue that has a PullTarget.
+ # * 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 how a failed task attempt is retried.
+ "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 is output only for pull queues.
+ #
+ #
+ # 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.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `min_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [min_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ # retrying a failed task, measured from when the task was first
+ # attempted. Once `max_retry_duration` time has passed *and* the
+ # task has been attempted max_attempts
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_retry_duration` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [task_age_limit in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
+ "maxAttempts": 42, # The maximum number of attempts for a task.
+ #
+ # Cloud Tasks will attempt the task `max_attempts` times (that
+ # is, if the first attempt fails, then there will be
+ # `max_attempts - 1` retries). Must be > 0.
+ "maxBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [max_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
},
"appEngineHttpTarget": { # App Engine HTTP target. # App Engine HTTP target.
#
@@ -408,19 +367,22 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "instance": "A String", # App instance.
+ "service": "A String", # App service.
#
- # By default, the task is sent to an instance which is available when
- # the task is attempted.
+ # By default, the task is sent to the service which is the default
+ # service 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).
+ # 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.
"version": "A String", # App version.
#
# By default, the task is sent to the version which is the default
@@ -498,24 +460,62 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "service": "A String", # App service.
+ "instance": "A String", # App instance.
#
- # By default, the task is sent to the service which is the default
- # service when the task is attempted.
+ # By default, the task is sent to an instance which is available 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.
+ # 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).
},
},
+ "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.
+ "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`.
+ "pullTarget": { # Pull target. # Pull target.
+ #
+ # A pull queue is a queue that has a PullTarget.
+ },
+ "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.
}
x__xgafv: string, V1 error format.
@@ -529,144 +529,6 @@
{ # A queue is a container of related tasks. Queues are configured to manage
# how those tasks are dispatched. Configurable properties include rate limits,
# retry options, target types, and others.
- "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.
- "state": "A String", # Output only. The state of the queue.
- #
- # `state` can only be changed by called
- # PauseQueue,
- # ResumeQueue, or uploading
- # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
- # UpdateQueue cannot be used to change `state`.
- "retryConfig": { # Retry config. # Settings that determine the retry behavior.
- #
- # * For tasks created using Cloud Tasks: the queue-level retry settings
- # apply to all tasks in the queue that were created using Cloud Tasks.
- # 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 how 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.
- #
- # This field is output only for pull queues.
- #
- #
- # `min_backoff` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [min_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxBackoff": "A String", # A task will be scheduled for retry between
- # min_backoff and
- # max_backoff duration after it fails,
- # if the queue's RetryConfig specifies that the task should be
- # retried.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- # This field is output only for pull queues.
- #
- #
- # `max_backoff` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [max_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
- # retrying a failed task, measured from when the task was first
- # attempted. Once `max_retry_duration` time has passed *and* the
- # task has been attempted max_attempts
- # times, no further attempts will be made and the task will be
- # deleted.
- #
- # If zero, then the task age is unlimited.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- # This field is output only for pull queues.
- #
- #
- # `max_retry_duration` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [task_age_limit in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxDoublings": 42, # The time between retries will double `max_doublings` times.
- #
- # A task's retry interval starts at
- # min_backoff, then doubles
- # `max_doublings` times, then increases linearly, and finally
- # retries at intervals of
- # 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 is output only for pull queues.
- #
- #
- # This field has the same meaning as
- # [max_doublings in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxAttempts": 42, # The maximum number of attempts for a task.
- #
- # Cloud Tasks will attempt the task `max_attempts` times (that
- # is, if the first attempt fails, then there will be
- # `max_attempts - 1` retries). Must be > 0.
- "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
- },
- "name": "A String", # Caller-specified and required in CreateQueue,
- # after which it becomes output only.
- #
- # The queue name.
- #
- # The queue name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the queue's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
- # hyphens (-). The maximum length is 100 characters.
"rateLimits": { # Rate limits. # Rate limits for task dispatches.
#
# rate_limits and
@@ -688,21 +550,25 @@
#
# Note: The debugging command, RunTask, will run a task
# even if the queue has reached its RateLimits.
- "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
+ "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
+ # to be dispatched for this queue. After this threshold has been
+ # reached, Cloud Tasks stops dispatching tasks until the number of
+ # concurrent requests decreases.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # * For App Engine queues, the maximum allowed value
- # is 500.
- # * This field is output only for pull queues. In addition to the
- # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
- # LeaseTasks requests are allowed per pull queue.
+ #
+ # The maximum allowed value is 5,000.
+ #
+ # This field is output only for
+ # pull queues and always -1, which indicates no limit. No other
+ # queue types can have `max_concurrent_tasks` set to -1.
#
#
# This field has the same meaning as
- # [rate in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
+ # [max_concurrent_requests in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
"maxBurstSize": 42, # Output only. The max burst size.
#
# Max burst size limits how fast tasks in queue are processed when
@@ -735,29 +601,122 @@
# regardless of whether
# max_tasks_dispatched_per_second
# is updated.
- "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
- # to be dispatched for this queue. After this threshold has been
- # reached, Cloud Tasks stops dispatching tasks until the number of
- # concurrent requests decreases.
+ "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- #
- # The maximum allowed value is 5,000.
- #
- # This field is output only for
- # pull queues and always -1, which indicates no limit. No other
- # queue types can have `max_concurrent_tasks` set to -1.
+ # * For App Engine queues, the maximum allowed value
+ # is 500.
+ # * This field is output only for pull queues. In addition to the
+ # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
+ # LeaseTasks requests are allowed per pull queue.
#
#
# This field has the same meaning as
- # [max_concurrent_requests in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
+ # [rate in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
},
- "pullTarget": { # Pull target. # Pull target.
+ "retryConfig": { # Retry config. # Settings that determine the retry behavior.
#
- # A pull queue is a queue that has a PullTarget.
+ # * 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 how a failed task attempt is retried.
+ "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 is output only for pull queues.
+ #
+ #
+ # 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.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `min_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [min_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ # retrying a failed task, measured from when the task was first
+ # attempted. Once `max_retry_duration` time has passed *and* the
+ # task has been attempted max_attempts
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_retry_duration` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [task_age_limit in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
+ "maxAttempts": 42, # The maximum number of attempts for a task.
+ #
+ # Cloud Tasks will attempt the task `max_attempts` times (that
+ # is, if the first attempt fails, then there will be
+ # `max_attempts - 1` retries). Must be > 0.
+ "maxBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [max_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
},
"appEngineHttpTarget": { # App Engine HTTP target. # App Engine HTTP target.
#
@@ -793,19 +752,22 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "instance": "A String", # App instance.
+ "service": "A String", # App service.
#
- # By default, the task is sent to an instance which is available when
- # the task is attempted.
+ # By default, the task is sent to the service which is the default
+ # service 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).
+ # 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.
"version": "A String", # App version.
#
# By default, the task is sent to the version which is the default
@@ -883,24 +845,62 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "service": "A String", # App service.
+ "instance": "A String", # App instance.
#
- # By default, the task is sent to the service which is the default
- # service when the task is attempted.
+ # By default, the task is sent to an instance which is available 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.
+ # 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).
},
},
+ "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.
+ "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`.
+ "pullTarget": { # Pull target. # Pull target.
+ #
+ # A pull queue is a queue that has a PullTarget.
+ },
+ "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.
}</pre>
</div>
@@ -963,144 +963,6 @@
{ # A queue is a container of related tasks. Queues are configured to manage
# how those tasks are dispatched. Configurable properties include rate limits,
# retry options, target types, and others.
- "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.
- "state": "A String", # Output only. The state of the queue.
- #
- # `state` can only be changed by called
- # PauseQueue,
- # ResumeQueue, or uploading
- # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
- # UpdateQueue cannot be used to change `state`.
- "retryConfig": { # Retry config. # Settings that determine the retry behavior.
- #
- # * For tasks created using Cloud Tasks: the queue-level retry settings
- # apply to all tasks in the queue that were created using Cloud Tasks.
- # 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 how 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.
- #
- # This field is output only for pull queues.
- #
- #
- # `min_backoff` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [min_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxBackoff": "A String", # A task will be scheduled for retry between
- # min_backoff and
- # max_backoff duration after it fails,
- # if the queue's RetryConfig specifies that the task should be
- # retried.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- # This field is output only for pull queues.
- #
- #
- # `max_backoff` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [max_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
- # retrying a failed task, measured from when the task was first
- # attempted. Once `max_retry_duration` time has passed *and* the
- # task has been attempted max_attempts
- # times, no further attempts will be made and the task will be
- # deleted.
- #
- # If zero, then the task age is unlimited.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- # This field is output only for pull queues.
- #
- #
- # `max_retry_duration` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [task_age_limit in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxDoublings": 42, # The time between retries will double `max_doublings` times.
- #
- # A task's retry interval starts at
- # min_backoff, then doubles
- # `max_doublings` times, then increases linearly, and finally
- # retries at intervals of
- # 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 is output only for pull queues.
- #
- #
- # This field has the same meaning as
- # [max_doublings in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxAttempts": 42, # The maximum number of attempts for a task.
- #
- # Cloud Tasks will attempt the task `max_attempts` times (that
- # is, if the first attempt fails, then there will be
- # `max_attempts - 1` retries). Must be > 0.
- "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
- },
- "name": "A String", # Caller-specified and required in CreateQueue,
- # after which it becomes output only.
- #
- # The queue name.
- #
- # The queue name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the queue's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
- # hyphens (-). The maximum length is 100 characters.
"rateLimits": { # Rate limits. # Rate limits for task dispatches.
#
# rate_limits and
@@ -1122,21 +984,25 @@
#
# Note: The debugging command, RunTask, will run a task
# even if the queue has reached its RateLimits.
- "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
+ "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
+ # to be dispatched for this queue. After this threshold has been
+ # reached, Cloud Tasks stops dispatching tasks until the number of
+ # concurrent requests decreases.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # * For App Engine queues, the maximum allowed value
- # is 500.
- # * This field is output only for pull queues. In addition to the
- # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
- # LeaseTasks requests are allowed per pull queue.
+ #
+ # The maximum allowed value is 5,000.
+ #
+ # This field is output only for
+ # pull queues and always -1, which indicates no limit. No other
+ # queue types can have `max_concurrent_tasks` set to -1.
#
#
# This field has the same meaning as
- # [rate in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
+ # [max_concurrent_requests in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
"maxBurstSize": 42, # Output only. The max burst size.
#
# Max burst size limits how fast tasks in queue are processed when
@@ -1169,29 +1035,122 @@
# regardless of whether
# max_tasks_dispatched_per_second
# is updated.
- "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
- # to be dispatched for this queue. After this threshold has been
- # reached, Cloud Tasks stops dispatching tasks until the number of
- # concurrent requests decreases.
+ "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- #
- # The maximum allowed value is 5,000.
- #
- # This field is output only for
- # pull queues and always -1, which indicates no limit. No other
- # queue types can have `max_concurrent_tasks` set to -1.
+ # * For App Engine queues, the maximum allowed value
+ # is 500.
+ # * This field is output only for pull queues. In addition to the
+ # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
+ # LeaseTasks requests are allowed per pull queue.
#
#
# This field has the same meaning as
- # [max_concurrent_requests in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
+ # [rate in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
},
- "pullTarget": { # Pull target. # Pull target.
+ "retryConfig": { # Retry config. # Settings that determine the retry behavior.
#
- # A pull queue is a queue that has a PullTarget.
+ # * 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 how a failed task attempt is retried.
+ "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 is output only for pull queues.
+ #
+ #
+ # 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.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `min_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [min_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ # retrying a failed task, measured from when the task was first
+ # attempted. Once `max_retry_duration` time has passed *and* the
+ # task has been attempted max_attempts
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_retry_duration` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [task_age_limit in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
+ "maxAttempts": 42, # The maximum number of attempts for a task.
+ #
+ # Cloud Tasks will attempt the task `max_attempts` times (that
+ # is, if the first attempt fails, then there will be
+ # `max_attempts - 1` retries). Must be > 0.
+ "maxBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [max_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
},
"appEngineHttpTarget": { # App Engine HTTP target. # App Engine HTTP target.
#
@@ -1227,19 +1186,22 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "instance": "A String", # App instance.
+ "service": "A String", # App service.
#
- # By default, the task is sent to an instance which is available when
- # the task is attempted.
+ # By default, the task is sent to the service which is the default
+ # service 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).
+ # 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.
"version": "A String", # App version.
#
# By default, the task is sent to the version which is the default
@@ -1317,24 +1279,62 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "service": "A String", # App service.
+ "instance": "A String", # App instance.
#
- # By default, the task is sent to the service which is the default
- # service when the task is attempted.
+ # By default, the task is sent to an instance which is available 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.
+ # 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).
},
},
+ "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.
+ "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`.
+ "pullTarget": { # Pull target. # Pull target.
+ #
+ # A pull queue is a queue that has a PullTarget.
+ },
+ "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.
}</pre>
</div>
@@ -1461,86 +1461,12 @@
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
- #
- # To learn which resources support conditions in their IAM policies, see the
- # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "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.
- "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.
- "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.
- },
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
@@ -1586,15 +1512,89 @@
#
"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.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ },
},
],
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists queues.
Queues are returned in lexicographical order.
@@ -1602,21 +1602,6 @@
Args:
parent: string, Required. The location name.
For example: `projects/PROJECT_ID/locations/LOCATION_ID` (required)
- pageToken: string, A token identifying the page of results to return.
-
-To request the first page results, page_token must be empty. To
-request the next page of results, page_token must be the value of
-next_page_token returned
-from the previous call to ListQueues
-method. It is an error to switch the value of the
-filter while iterating through pages.
- pageSize: integer, Requested page size.
-
-The maximum page size is 9800. If unspecified, the page size will
-be the maximum. Fewer queues than requested might be returned,
-even if more queues exist; use the
-next_page_token in the
-response to determine if more queues exist.
filter: string, `filter` can be used to specify a subset of queues. Any Queue
field can be used as a filter and several operators as supported.
For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as
@@ -1628,6 +1613,21 @@
Note that using filters might cause fewer queues than the
requested_page size to be returned.
+ pageSize: integer, Requested page size.
+
+The maximum page size is 9800. If unspecified, the page size will
+be the maximum. Fewer queues than requested might be returned,
+even if more queues exist; use the
+next_page_token in the
+response to determine if more queues exist.
+ pageToken: string, A token identifying the page of results to return.
+
+To request the first page results, page_token must be empty. To
+request the next page of results, page_token must be the value of
+next_page_token returned
+from the previous call to ListQueues
+method. It is an error to switch the value of the
+filter while iterating through pages.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -1637,148 +1637,19 @@
An object of the form:
{ # Response message for ListQueues.
+ "nextPageToken": "A String", # A token to retrieve next page of results.
+ #
+ # To return the next page of results, call
+ # ListQueues with this value as the
+ # page_token.
+ #
+ # If the next_page_token is empty, there are no more results.
+ #
+ # The page token is valid for only 2 hours.
"queues": [ # The list of queues.
{ # A queue is a container of related tasks. Queues are configured to manage
# how those tasks are dispatched. Configurable properties include rate limits,
# retry options, target types, and others.
- "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.
- "state": "A String", # Output only. The state of the queue.
- #
- # `state` can only be changed by called
- # PauseQueue,
- # ResumeQueue, or uploading
- # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
- # UpdateQueue cannot be used to change `state`.
- "retryConfig": { # Retry config. # Settings that determine the retry behavior.
- #
- # * For tasks created using Cloud Tasks: the queue-level retry settings
- # apply to all tasks in the queue that were created using Cloud Tasks.
- # 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 how 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.
- #
- # This field is output only for pull queues.
- #
- #
- # `min_backoff` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [min_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxBackoff": "A String", # A task will be scheduled for retry between
- # min_backoff and
- # max_backoff duration after it fails,
- # if the queue's RetryConfig specifies that the task should be
- # retried.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- # This field is output only for pull queues.
- #
- #
- # `max_backoff` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [max_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
- # retrying a failed task, measured from when the task was first
- # attempted. Once `max_retry_duration` time has passed *and* the
- # task has been attempted max_attempts
- # times, no further attempts will be made and the task will be
- # deleted.
- #
- # If zero, then the task age is unlimited.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- # This field is output only for pull queues.
- #
- #
- # `max_retry_duration` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [task_age_limit in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxDoublings": 42, # The time between retries will double `max_doublings` times.
- #
- # A task's retry interval starts at
- # min_backoff, then doubles
- # `max_doublings` times, then increases linearly, and finally
- # retries at intervals of
- # 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 is output only for pull queues.
- #
- #
- # This field has the same meaning as
- # [max_doublings in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxAttempts": 42, # The maximum number of attempts for a task.
- #
- # Cloud Tasks will attempt the task `max_attempts` times (that
- # is, if the first attempt fails, then there will be
- # `max_attempts - 1` retries). Must be > 0.
- "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
- },
- "name": "A String", # Caller-specified and required in CreateQueue,
- # after which it becomes output only.
- #
- # The queue name.
- #
- # The queue name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the queue's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
- # hyphens (-). The maximum length is 100 characters.
"rateLimits": { # Rate limits. # Rate limits for task dispatches.
#
# rate_limits and
@@ -1800,21 +1671,25 @@
#
# Note: The debugging command, RunTask, will run a task
# even if the queue has reached its RateLimits.
- "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
+ "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
+ # to be dispatched for this queue. After this threshold has been
+ # reached, Cloud Tasks stops dispatching tasks until the number of
+ # concurrent requests decreases.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # * For App Engine queues, the maximum allowed value
- # is 500.
- # * This field is output only for pull queues. In addition to the
- # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
- # LeaseTasks requests are allowed per pull queue.
+ #
+ # The maximum allowed value is 5,000.
+ #
+ # This field is output only for
+ # pull queues and always -1, which indicates no limit. No other
+ # queue types can have `max_concurrent_tasks` set to -1.
#
#
# This field has the same meaning as
- # [rate in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
+ # [max_concurrent_requests in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
"maxBurstSize": 42, # Output only. The max burst size.
#
# Max burst size limits how fast tasks in queue are processed when
@@ -1847,29 +1722,122 @@
# regardless of whether
# max_tasks_dispatched_per_second
# is updated.
- "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
- # to be dispatched for this queue. After this threshold has been
- # reached, Cloud Tasks stops dispatching tasks until the number of
- # concurrent requests decreases.
+ "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- #
- # The maximum allowed value is 5,000.
- #
- # This field is output only for
- # pull queues and always -1, which indicates no limit. No other
- # queue types can have `max_concurrent_tasks` set to -1.
+ # * For App Engine queues, the maximum allowed value
+ # is 500.
+ # * This field is output only for pull queues. In addition to the
+ # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
+ # LeaseTasks requests are allowed per pull queue.
#
#
# This field has the same meaning as
- # [max_concurrent_requests in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
+ # [rate in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
},
- "pullTarget": { # Pull target. # Pull target.
+ "retryConfig": { # Retry config. # Settings that determine the retry behavior.
#
- # A pull queue is a queue that has a PullTarget.
+ # * 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 how a failed task attempt is retried.
+ "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 is output only for pull queues.
+ #
+ #
+ # 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.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `min_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [min_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ # retrying a failed task, measured from when the task was first
+ # attempted. Once `max_retry_duration` time has passed *and* the
+ # task has been attempted max_attempts
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_retry_duration` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [task_age_limit in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
+ "maxAttempts": 42, # The maximum number of attempts for a task.
+ #
+ # Cloud Tasks will attempt the task `max_attempts` times (that
+ # is, if the first attempt fails, then there will be
+ # `max_attempts - 1` retries). Must be > 0.
+ "maxBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [max_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
},
"appEngineHttpTarget": { # App Engine HTTP target. # App Engine HTTP target.
#
@@ -1905,19 +1873,22 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "instance": "A String", # App instance.
+ "service": "A String", # App service.
#
- # By default, the task is sent to an instance which is available when
- # the task is attempted.
+ # By default, the task is sent to the service which is the default
+ # service 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).
+ # 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.
"version": "A String", # App version.
#
# By default, the task is sent to the version which is the default
@@ -1995,35 +1966,64 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "service": "A String", # App service.
+ "instance": "A String", # App instance.
#
- # By default, the task is sent to the service which is the default
- # service when the task is attempted.
+ # By default, the task is sent to an instance which is available 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.
+ # 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).
},
},
+ "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.
+ "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`.
+ "pullTarget": { # Pull target. # Pull target.
+ #
+ # A pull queue is a queue that has a PullTarget.
+ },
+ "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.
},
],
- "nextPageToken": "A String", # A token to retrieve next page of results.
- #
- # To return the next page of results, call
- # ListQueues with this value as the
- # page_token.
- #
- # If the next_page_token is empty, there are no more results.
- #
- # The page token is valid for only 2 hours.
}</pre>
</div>
@@ -2085,144 +2085,6 @@
{ # A queue is a container of related tasks. Queues are configured to manage
# how those tasks are dispatched. Configurable properties include rate limits,
# retry options, target types, and others.
- "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.
- "state": "A String", # Output only. The state of the queue.
- #
- # `state` can only be changed by called
- # PauseQueue,
- # ResumeQueue, or uploading
- # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
- # UpdateQueue cannot be used to change `state`.
- "retryConfig": { # Retry config. # Settings that determine the retry behavior.
- #
- # * For tasks created using Cloud Tasks: the queue-level retry settings
- # apply to all tasks in the queue that were created using Cloud Tasks.
- # 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 how 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.
- #
- # This field is output only for pull queues.
- #
- #
- # `min_backoff` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [min_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxBackoff": "A String", # A task will be scheduled for retry between
- # min_backoff and
- # max_backoff duration after it fails,
- # if the queue's RetryConfig specifies that the task should be
- # retried.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- # This field is output only for pull queues.
- #
- #
- # `max_backoff` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [max_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
- # retrying a failed task, measured from when the task was first
- # attempted. Once `max_retry_duration` time has passed *and* the
- # task has been attempted max_attempts
- # times, no further attempts will be made and the task will be
- # deleted.
- #
- # If zero, then the task age is unlimited.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- # This field is output only for pull queues.
- #
- #
- # `max_retry_duration` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [task_age_limit in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxDoublings": 42, # The time between retries will double `max_doublings` times.
- #
- # A task's retry interval starts at
- # min_backoff, then doubles
- # `max_doublings` times, then increases linearly, and finally
- # retries at intervals of
- # 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 is output only for pull queues.
- #
- #
- # This field has the same meaning as
- # [max_doublings in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxAttempts": 42, # The maximum number of attempts for a task.
- #
- # Cloud Tasks will attempt the task `max_attempts` times (that
- # is, if the first attempt fails, then there will be
- # `max_attempts - 1` retries). Must be > 0.
- "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
- },
- "name": "A String", # Caller-specified and required in CreateQueue,
- # after which it becomes output only.
- #
- # The queue name.
- #
- # The queue name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the queue's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
- # hyphens (-). The maximum length is 100 characters.
"rateLimits": { # Rate limits. # Rate limits for task dispatches.
#
# rate_limits and
@@ -2244,21 +2106,25 @@
#
# Note: The debugging command, RunTask, will run a task
# even if the queue has reached its RateLimits.
- "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
+ "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
+ # to be dispatched for this queue. After this threshold has been
+ # reached, Cloud Tasks stops dispatching tasks until the number of
+ # concurrent requests decreases.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # * For App Engine queues, the maximum allowed value
- # is 500.
- # * This field is output only for pull queues. In addition to the
- # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
- # LeaseTasks requests are allowed per pull queue.
+ #
+ # The maximum allowed value is 5,000.
+ #
+ # This field is output only for
+ # pull queues and always -1, which indicates no limit. No other
+ # queue types can have `max_concurrent_tasks` set to -1.
#
#
# This field has the same meaning as
- # [rate in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
+ # [max_concurrent_requests in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
"maxBurstSize": 42, # Output only. The max burst size.
#
# Max burst size limits how fast tasks in queue are processed when
@@ -2291,29 +2157,122 @@
# regardless of whether
# max_tasks_dispatched_per_second
# is updated.
- "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
- # to be dispatched for this queue. After this threshold has been
- # reached, Cloud Tasks stops dispatching tasks until the number of
- # concurrent requests decreases.
+ "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- #
- # The maximum allowed value is 5,000.
- #
- # This field is output only for
- # pull queues and always -1, which indicates no limit. No other
- # queue types can have `max_concurrent_tasks` set to -1.
+ # * For App Engine queues, the maximum allowed value
+ # is 500.
+ # * This field is output only for pull queues. In addition to the
+ # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
+ # LeaseTasks requests are allowed per pull queue.
#
#
# This field has the same meaning as
- # [max_concurrent_requests in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
+ # [rate in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
},
- "pullTarget": { # Pull target. # Pull target.
+ "retryConfig": { # Retry config. # Settings that determine the retry behavior.
#
- # A pull queue is a queue that has a PullTarget.
+ # * 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 how a failed task attempt is retried.
+ "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 is output only for pull queues.
+ #
+ #
+ # 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.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `min_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [min_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ # retrying a failed task, measured from when the task was first
+ # attempted. Once `max_retry_duration` time has passed *and* the
+ # task has been attempted max_attempts
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_retry_duration` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [task_age_limit in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
+ "maxAttempts": 42, # The maximum number of attempts for a task.
+ #
+ # Cloud Tasks will attempt the task `max_attempts` times (that
+ # is, if the first attempt fails, then there will be
+ # `max_attempts - 1` retries). Must be > 0.
+ "maxBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [max_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
},
"appEngineHttpTarget": { # App Engine HTTP target. # App Engine HTTP target.
#
@@ -2349,19 +2308,22 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "instance": "A String", # App instance.
+ "service": "A String", # App service.
#
- # By default, the task is sent to an instance which is available when
- # the task is attempted.
+ # By default, the task is sent to the service which is the default
+ # service 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).
+ # 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.
"version": "A String", # App version.
#
# By default, the task is sent to the version which is the default
@@ -2439,24 +2401,62 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "service": "A String", # App service.
+ "instance": "A String", # App instance.
#
- # By default, the task is sent to the service which is the default
- # service when the task is attempted.
+ # By default, the task is sent to an instance which is available 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.
+ # 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).
},
},
+ "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.
+ "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`.
+ "pullTarget": { # Pull target. # Pull target.
+ #
+ # A pull queue is a queue that has a PullTarget.
+ },
+ "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.
}
updateMask: string, A mask used to specify which fields of the queue are being updated.
@@ -2473,144 +2473,6 @@
{ # A queue is a container of related tasks. Queues are configured to manage
# how those tasks are dispatched. Configurable properties include rate limits,
# retry options, target types, and others.
- "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.
- "state": "A String", # Output only. The state of the queue.
- #
- # `state` can only be changed by called
- # PauseQueue,
- # ResumeQueue, or uploading
- # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
- # UpdateQueue cannot be used to change `state`.
- "retryConfig": { # Retry config. # Settings that determine the retry behavior.
- #
- # * For tasks created using Cloud Tasks: the queue-level retry settings
- # apply to all tasks in the queue that were created using Cloud Tasks.
- # 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 how 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.
- #
- # This field is output only for pull queues.
- #
- #
- # `min_backoff` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [min_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxBackoff": "A String", # A task will be scheduled for retry between
- # min_backoff and
- # max_backoff duration after it fails,
- # if the queue's RetryConfig specifies that the task should be
- # retried.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- # This field is output only for pull queues.
- #
- #
- # `max_backoff` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [max_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
- # retrying a failed task, measured from when the task was first
- # attempted. Once `max_retry_duration` time has passed *and* the
- # task has been attempted max_attempts
- # times, no further attempts will be made and the task will be
- # deleted.
- #
- # If zero, then the task age is unlimited.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- # This field is output only for pull queues.
- #
- #
- # `max_retry_duration` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [task_age_limit in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxDoublings": 42, # The time between retries will double `max_doublings` times.
- #
- # A task's retry interval starts at
- # min_backoff, then doubles
- # `max_doublings` times, then increases linearly, and finally
- # retries at intervals of
- # 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 is output only for pull queues.
- #
- #
- # This field has the same meaning as
- # [max_doublings in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxAttempts": 42, # The maximum number of attempts for a task.
- #
- # Cloud Tasks will attempt the task `max_attempts` times (that
- # is, if the first attempt fails, then there will be
- # `max_attempts - 1` retries). Must be > 0.
- "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
- },
- "name": "A String", # Caller-specified and required in CreateQueue,
- # after which it becomes output only.
- #
- # The queue name.
- #
- # The queue name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the queue's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
- # hyphens (-). The maximum length is 100 characters.
"rateLimits": { # Rate limits. # Rate limits for task dispatches.
#
# rate_limits and
@@ -2632,21 +2494,25 @@
#
# Note: The debugging command, RunTask, will run a task
# even if the queue has reached its RateLimits.
- "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
+ "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
+ # to be dispatched for this queue. After this threshold has been
+ # reached, Cloud Tasks stops dispatching tasks until the number of
+ # concurrent requests decreases.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # * For App Engine queues, the maximum allowed value
- # is 500.
- # * This field is output only for pull queues. In addition to the
- # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
- # LeaseTasks requests are allowed per pull queue.
+ #
+ # The maximum allowed value is 5,000.
+ #
+ # This field is output only for
+ # pull queues and always -1, which indicates no limit. No other
+ # queue types can have `max_concurrent_tasks` set to -1.
#
#
# This field has the same meaning as
- # [rate in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
+ # [max_concurrent_requests in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
"maxBurstSize": 42, # Output only. The max burst size.
#
# Max burst size limits how fast tasks in queue are processed when
@@ -2679,29 +2545,122 @@
# regardless of whether
# max_tasks_dispatched_per_second
# is updated.
- "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
- # to be dispatched for this queue. After this threshold has been
- # reached, Cloud Tasks stops dispatching tasks until the number of
- # concurrent requests decreases.
+ "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- #
- # The maximum allowed value is 5,000.
- #
- # This field is output only for
- # pull queues and always -1, which indicates no limit. No other
- # queue types can have `max_concurrent_tasks` set to -1.
+ # * For App Engine queues, the maximum allowed value
+ # is 500.
+ # * This field is output only for pull queues. In addition to the
+ # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
+ # LeaseTasks requests are allowed per pull queue.
#
#
# This field has the same meaning as
- # [max_concurrent_requests in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
+ # [rate in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
},
- "pullTarget": { # Pull target. # Pull target.
+ "retryConfig": { # Retry config. # Settings that determine the retry behavior.
#
- # A pull queue is a queue that has a PullTarget.
+ # * 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 how a failed task attempt is retried.
+ "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 is output only for pull queues.
+ #
+ #
+ # 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.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `min_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [min_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ # retrying a failed task, measured from when the task was first
+ # attempted. Once `max_retry_duration` time has passed *and* the
+ # task has been attempted max_attempts
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_retry_duration` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [task_age_limit in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
+ "maxAttempts": 42, # The maximum number of attempts for a task.
+ #
+ # Cloud Tasks will attempt the task `max_attempts` times (that
+ # is, if the first attempt fails, then there will be
+ # `max_attempts - 1` retries). Must be > 0.
+ "maxBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [max_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
},
"appEngineHttpTarget": { # App Engine HTTP target. # App Engine HTTP target.
#
@@ -2737,19 +2696,22 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "instance": "A String", # App instance.
+ "service": "A String", # App service.
#
- # By default, the task is sent to an instance which is available when
- # the task is attempted.
+ # By default, the task is sent to the service which is the default
+ # service 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).
+ # 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.
"version": "A String", # App version.
#
# By default, the task is sent to the version which is the default
@@ -2827,24 +2789,62 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "service": "A String", # App service.
+ "instance": "A String", # App instance.
#
- # By default, the task is sent to the service which is the default
- # service when the task is attempted.
+ # By default, the task is sent to an instance which is available 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.
+ # 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).
},
},
+ "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.
+ "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`.
+ "pullTarget": { # Pull target. # Pull target.
+ #
+ # A pull queue is a queue that has a PullTarget.
+ },
+ "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.
}</pre>
</div>
@@ -2878,144 +2878,6 @@
{ # A queue is a container of related tasks. Queues are configured to manage
# how those tasks are dispatched. Configurable properties include rate limits,
# retry options, target types, and others.
- "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.
- "state": "A String", # Output only. The state of the queue.
- #
- # `state` can only be changed by called
- # PauseQueue,
- # ResumeQueue, or uploading
- # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
- # UpdateQueue cannot be used to change `state`.
- "retryConfig": { # Retry config. # Settings that determine the retry behavior.
- #
- # * For tasks created using Cloud Tasks: the queue-level retry settings
- # apply to all tasks in the queue that were created using Cloud Tasks.
- # 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 how 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.
- #
- # This field is output only for pull queues.
- #
- #
- # `min_backoff` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [min_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxBackoff": "A String", # A task will be scheduled for retry between
- # min_backoff and
- # max_backoff duration after it fails,
- # if the queue's RetryConfig specifies that the task should be
- # retried.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- # This field is output only for pull queues.
- #
- #
- # `max_backoff` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [max_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
- # retrying a failed task, measured from when the task was first
- # attempted. Once `max_retry_duration` time has passed *and* the
- # task has been attempted max_attempts
- # times, no further attempts will be made and the task will be
- # deleted.
- #
- # If zero, then the task age is unlimited.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- # This field is output only for pull queues.
- #
- #
- # `max_retry_duration` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [task_age_limit in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxDoublings": 42, # The time between retries will double `max_doublings` times.
- #
- # A task's retry interval starts at
- # min_backoff, then doubles
- # `max_doublings` times, then increases linearly, and finally
- # retries at intervals of
- # 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 is output only for pull queues.
- #
- #
- # This field has the same meaning as
- # [max_doublings in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxAttempts": 42, # The maximum number of attempts for a task.
- #
- # Cloud Tasks will attempt the task `max_attempts` times (that
- # is, if the first attempt fails, then there will be
- # `max_attempts - 1` retries). Must be > 0.
- "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
- },
- "name": "A String", # Caller-specified and required in CreateQueue,
- # after which it becomes output only.
- #
- # The queue name.
- #
- # The queue name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the queue's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
- # hyphens (-). The maximum length is 100 characters.
"rateLimits": { # Rate limits. # Rate limits for task dispatches.
#
# rate_limits and
@@ -3037,21 +2899,25 @@
#
# Note: The debugging command, RunTask, will run a task
# even if the queue has reached its RateLimits.
- "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
+ "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
+ # to be dispatched for this queue. After this threshold has been
+ # reached, Cloud Tasks stops dispatching tasks until the number of
+ # concurrent requests decreases.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # * For App Engine queues, the maximum allowed value
- # is 500.
- # * This field is output only for pull queues. In addition to the
- # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
- # LeaseTasks requests are allowed per pull queue.
+ #
+ # The maximum allowed value is 5,000.
+ #
+ # This field is output only for
+ # pull queues and always -1, which indicates no limit. No other
+ # queue types can have `max_concurrent_tasks` set to -1.
#
#
# This field has the same meaning as
- # [rate in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
+ # [max_concurrent_requests in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
"maxBurstSize": 42, # Output only. The max burst size.
#
# Max burst size limits how fast tasks in queue are processed when
@@ -3084,29 +2950,122 @@
# regardless of whether
# max_tasks_dispatched_per_second
# is updated.
- "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
- # to be dispatched for this queue. After this threshold has been
- # reached, Cloud Tasks stops dispatching tasks until the number of
- # concurrent requests decreases.
+ "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- #
- # The maximum allowed value is 5,000.
- #
- # This field is output only for
- # pull queues and always -1, which indicates no limit. No other
- # queue types can have `max_concurrent_tasks` set to -1.
+ # * For App Engine queues, the maximum allowed value
+ # is 500.
+ # * This field is output only for pull queues. In addition to the
+ # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
+ # LeaseTasks requests are allowed per pull queue.
#
#
# This field has the same meaning as
- # [max_concurrent_requests in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
+ # [rate in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
},
- "pullTarget": { # Pull target. # Pull target.
+ "retryConfig": { # Retry config. # Settings that determine the retry behavior.
#
- # A pull queue is a queue that has a PullTarget.
+ # * 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 how a failed task attempt is retried.
+ "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 is output only for pull queues.
+ #
+ #
+ # 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.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `min_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [min_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ # retrying a failed task, measured from when the task was first
+ # attempted. Once `max_retry_duration` time has passed *and* the
+ # task has been attempted max_attempts
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_retry_duration` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [task_age_limit in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
+ "maxAttempts": 42, # The maximum number of attempts for a task.
+ #
+ # Cloud Tasks will attempt the task `max_attempts` times (that
+ # is, if the first attempt fails, then there will be
+ # `max_attempts - 1` retries). Must be > 0.
+ "maxBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [max_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
},
"appEngineHttpTarget": { # App Engine HTTP target. # App Engine HTTP target.
#
@@ -3142,19 +3101,22 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "instance": "A String", # App instance.
+ "service": "A String", # App service.
#
- # By default, the task is sent to an instance which is available when
- # the task is attempted.
+ # By default, the task is sent to the service which is the default
+ # service 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).
+ # 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.
"version": "A String", # App version.
#
# By default, the task is sent to the version which is the default
@@ -3232,24 +3194,62 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "service": "A String", # App service.
+ "instance": "A String", # App instance.
#
- # By default, the task is sent to the service which is the default
- # service when the task is attempted.
+ # By default, the task is sent to an instance which is available 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.
+ # 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).
},
},
+ "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.
+ "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`.
+ "pullTarget": { # Pull target. # Pull target.
+ #
+ # A pull queue is a queue that has a PullTarget.
+ },
+ "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.
}</pre>
</div>
@@ -3282,144 +3282,6 @@
{ # A queue is a container of related tasks. Queues are configured to manage
# how those tasks are dispatched. Configurable properties include rate limits,
# retry options, target types, and others.
- "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.
- "state": "A String", # Output only. The state of the queue.
- #
- # `state` can only be changed by called
- # PauseQueue,
- # ResumeQueue, or uploading
- # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
- # UpdateQueue cannot be used to change `state`.
- "retryConfig": { # Retry config. # Settings that determine the retry behavior.
- #
- # * For tasks created using Cloud Tasks: the queue-level retry settings
- # apply to all tasks in the queue that were created using Cloud Tasks.
- # 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 how 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.
- #
- # This field is output only for pull queues.
- #
- #
- # `min_backoff` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [min_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxBackoff": "A String", # A task will be scheduled for retry between
- # min_backoff and
- # max_backoff duration after it fails,
- # if the queue's RetryConfig specifies that the task should be
- # retried.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- # This field is output only for pull queues.
- #
- #
- # `max_backoff` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [max_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
- # retrying a failed task, measured from when the task was first
- # attempted. Once `max_retry_duration` time has passed *and* the
- # task has been attempted max_attempts
- # times, no further attempts will be made and the task will be
- # deleted.
- #
- # If zero, then the task age is unlimited.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- # This field is output only for pull queues.
- #
- #
- # `max_retry_duration` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [task_age_limit in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxDoublings": 42, # The time between retries will double `max_doublings` times.
- #
- # A task's retry interval starts at
- # min_backoff, then doubles
- # `max_doublings` times, then increases linearly, and finally
- # retries at intervals of
- # 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 is output only for pull queues.
- #
- #
- # This field has the same meaning as
- # [max_doublings in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxAttempts": 42, # The maximum number of attempts for a task.
- #
- # Cloud Tasks will attempt the task `max_attempts` times (that
- # is, if the first attempt fails, then there will be
- # `max_attempts - 1` retries). Must be > 0.
- "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
- },
- "name": "A String", # Caller-specified and required in CreateQueue,
- # after which it becomes output only.
- #
- # The queue name.
- #
- # The queue name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the queue's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
- # hyphens (-). The maximum length is 100 characters.
"rateLimits": { # Rate limits. # Rate limits for task dispatches.
#
# rate_limits and
@@ -3441,21 +3303,25 @@
#
# Note: The debugging command, RunTask, will run a task
# even if the queue has reached its RateLimits.
- "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
+ "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
+ # to be dispatched for this queue. After this threshold has been
+ # reached, Cloud Tasks stops dispatching tasks until the number of
+ # concurrent requests decreases.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # * For App Engine queues, the maximum allowed value
- # is 500.
- # * This field is output only for pull queues. In addition to the
- # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
- # LeaseTasks requests are allowed per pull queue.
+ #
+ # The maximum allowed value is 5,000.
+ #
+ # This field is output only for
+ # pull queues and always -1, which indicates no limit. No other
+ # queue types can have `max_concurrent_tasks` set to -1.
#
#
# This field has the same meaning as
- # [rate in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
+ # [max_concurrent_requests in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
"maxBurstSize": 42, # Output only. The max burst size.
#
# Max burst size limits how fast tasks in queue are processed when
@@ -3488,29 +3354,122 @@
# regardless of whether
# max_tasks_dispatched_per_second
# is updated.
- "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
- # to be dispatched for this queue. After this threshold has been
- # reached, Cloud Tasks stops dispatching tasks until the number of
- # concurrent requests decreases.
+ "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- #
- # The maximum allowed value is 5,000.
- #
- # This field is output only for
- # pull queues and always -1, which indicates no limit. No other
- # queue types can have `max_concurrent_tasks` set to -1.
+ # * For App Engine queues, the maximum allowed value
+ # is 500.
+ # * This field is output only for pull queues. In addition to the
+ # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
+ # LeaseTasks requests are allowed per pull queue.
#
#
# This field has the same meaning as
- # [max_concurrent_requests in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
+ # [rate in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
},
- "pullTarget": { # Pull target. # Pull target.
+ "retryConfig": { # Retry config. # Settings that determine the retry behavior.
#
- # A pull queue is a queue that has a PullTarget.
+ # * 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 how a failed task attempt is retried.
+ "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 is output only for pull queues.
+ #
+ #
+ # 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.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `min_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [min_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ # retrying a failed task, measured from when the task was first
+ # attempted. Once `max_retry_duration` time has passed *and* the
+ # task has been attempted max_attempts
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_retry_duration` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [task_age_limit in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
+ "maxAttempts": 42, # The maximum number of attempts for a task.
+ #
+ # Cloud Tasks will attempt the task `max_attempts` times (that
+ # is, if the first attempt fails, then there will be
+ # `max_attempts - 1` retries). Must be > 0.
+ "maxBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [max_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
},
"appEngineHttpTarget": { # App Engine HTTP target. # App Engine HTTP target.
#
@@ -3546,19 +3505,22 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "instance": "A String", # App instance.
+ "service": "A String", # App service.
#
- # By default, the task is sent to an instance which is available when
- # the task is attempted.
+ # By default, the task is sent to the service which is the default
+ # service 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).
+ # 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.
"version": "A String", # App version.
#
# By default, the task is sent to the version which is the default
@@ -3636,24 +3598,62 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "service": "A String", # App service.
+ "instance": "A String", # App instance.
#
- # By default, the task is sent to the service which is the default
- # service when the task is attempted.
+ # By default, the task is sent to an instance which is available 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.
+ # 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).
},
},
+ "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.
+ "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`.
+ "pullTarget": { # Pull target. # Pull target.
+ #
+ # A pull queue is a queue that has a PullTarget.
+ },
+ "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.
}</pre>
</div>
@@ -3693,144 +3693,6 @@
{ # A queue is a container of related tasks. Queues are configured to manage
# how those tasks are dispatched. Configurable properties include rate limits,
# retry options, target types, and others.
- "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.
- "state": "A String", # Output only. The state of the queue.
- #
- # `state` can only be changed by called
- # PauseQueue,
- # ResumeQueue, or uploading
- # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
- # UpdateQueue cannot be used to change `state`.
- "retryConfig": { # Retry config. # Settings that determine the retry behavior.
- #
- # * For tasks created using Cloud Tasks: the queue-level retry settings
- # apply to all tasks in the queue that were created using Cloud Tasks.
- # 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 how 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.
- #
- # This field is output only for pull queues.
- #
- #
- # `min_backoff` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [min_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxBackoff": "A String", # A task will be scheduled for retry between
- # min_backoff and
- # max_backoff duration after it fails,
- # if the queue's RetryConfig specifies that the task should be
- # retried.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- # This field is output only for pull queues.
- #
- #
- # `max_backoff` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [max_backoff_seconds in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
- # retrying a failed task, measured from when the task was first
- # attempted. Once `max_retry_duration` time has passed *and* the
- # task has been attempted max_attempts
- # times, no further attempts will be made and the task will be
- # deleted.
- #
- # If zero, then the task age is unlimited.
- #
- # If unspecified when the queue is created, Cloud Tasks will pick the
- # default.
- #
- # This field is output only for pull queues.
- #
- #
- # `max_retry_duration` will be truncated to the nearest second.
- #
- # This field has the same meaning as
- # [task_age_limit in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxDoublings": 42, # The time between retries will double `max_doublings` times.
- #
- # A task's retry interval starts at
- # min_backoff, then doubles
- # `max_doublings` times, then increases linearly, and finally
- # retries at intervals of
- # 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 is output only for pull queues.
- #
- #
- # This field has the same meaning as
- # [max_doublings in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "maxAttempts": 42, # The maximum number of attempts for a task.
- #
- # Cloud Tasks will attempt the task `max_attempts` times (that
- # is, if the first attempt fails, then there will be
- # `max_attempts - 1` retries). Must be > 0.
- "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
- },
- "name": "A String", # Caller-specified and required in CreateQueue,
- # after which it becomes output only.
- #
- # The queue name.
- #
- # The queue name must have the following format:
- # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
- #
- # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
- # hyphens (-), colons (:), or periods (.).
- # For more information, see
- # [Identifying
- # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
- # * `LOCATION_ID` is the canonical ID for the queue's location.
- # The list of available locations can be obtained by calling
- # ListLocations.
- # For more information, see https://cloud.google.com/about/locations/.
- # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
- # hyphens (-). The maximum length is 100 characters.
"rateLimits": { # Rate limits. # Rate limits for task dispatches.
#
# rate_limits and
@@ -3852,21 +3714,25 @@
#
# Note: The debugging command, RunTask, will run a task
# even if the queue has reached its RateLimits.
- "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
+ "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
+ # to be dispatched for this queue. After this threshold has been
+ # reached, Cloud Tasks stops dispatching tasks until the number of
+ # concurrent requests decreases.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # * For App Engine queues, the maximum allowed value
- # is 500.
- # * This field is output only for pull queues. In addition to the
- # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
- # LeaseTasks requests are allowed per pull queue.
+ #
+ # The maximum allowed value is 5,000.
+ #
+ # This field is output only for
+ # pull queues and always -1, which indicates no limit. No other
+ # queue types can have `max_concurrent_tasks` set to -1.
#
#
# This field has the same meaning as
- # [rate in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
+ # [max_concurrent_requests in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
"maxBurstSize": 42, # Output only. The max burst size.
#
# Max burst size limits how fast tasks in queue are processed when
@@ -3899,29 +3765,122 @@
# regardless of whether
# max_tasks_dispatched_per_second
# is updated.
- "maxConcurrentTasks": 42, # The maximum number of concurrent tasks that Cloud Tasks allows
- # to be dispatched for this queue. After this threshold has been
- # reached, Cloud Tasks stops dispatching tasks until the number of
- # concurrent requests decreases.
+ "maxTasksDispatchedPerSecond": 3.14, # The maximum rate at which tasks are dispatched from this queue.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- #
- # The maximum allowed value is 5,000.
- #
- # This field is output only for
- # pull queues and always -1, which indicates no limit. No other
- # queue types can have `max_concurrent_tasks` set to -1.
+ # * For App Engine queues, the maximum allowed value
+ # is 500.
+ # * This field is output only for pull queues. In addition to the
+ # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
+ # LeaseTasks requests are allowed per pull queue.
#
#
# This field has the same meaning as
- # [max_concurrent_requests in
- # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
+ # [rate in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
},
- "pullTarget": { # Pull target. # Pull target.
+ "retryConfig": { # Retry config. # Settings that determine the retry behavior.
#
- # A pull queue is a queue that has a PullTarget.
+ # * 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 how a failed task attempt is retried.
+ "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 is output only for pull queues.
+ #
+ #
+ # 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.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `min_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [min_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ # retrying a failed task, measured from when the task was first
+ # attempted. Once `max_retry_duration` time has passed *and* the
+ # task has been attempted max_attempts
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_retry_duration` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [task_age_limit in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+ "unlimitedAttempts": True or False, # If true, then the number of attempts is unlimited.
+ "maxAttempts": 42, # The maximum number of attempts for a task.
+ #
+ # Cloud Tasks will attempt the task `max_attempts` times (that
+ # is, if the first attempt fails, then there will be
+ # `max_attempts - 1` retries). Must be > 0.
+ "maxBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
+ #
+ # If unspecified when the queue is created, Cloud Tasks will pick the
+ # default.
+ #
+ # This field is output only for pull queues.
+ #
+ #
+ # `max_backoff` will be truncated to the nearest second.
+ #
+ # This field has the same meaning as
+ # [max_backoff_seconds in
+ # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
},
"appEngineHttpTarget": { # App Engine HTTP target. # App Engine HTTP target.
#
@@ -3957,19 +3916,22 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
- "instance": "A String", # App instance.
+ "service": "A String", # App service.
#
- # By default, the task is sent to an instance which is available when
- # the task is attempted.
+ # By default, the task is sent to the service which is the default
+ # service 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).
+ # 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.
"version": "A String", # App version.
#
# By default, the task is sent to the version which is the default
@@ -4047,24 +4009,62 @@
# instance is invalid, then the task
# will be sent to the default version of the default service when
# the task is attempted.
- "service": "A String", # App service.
+ "instance": "A String", # App instance.
#
- # By default, the task is sent to the service which is the default
- # service when the task is attempted.
+ # By default, the task is sent to an instance which is available 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.
+ # 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).
},
},
+ "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.
+ "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`.
+ "pullTarget": { # Pull target. # Pull target.
+ #
+ # A pull queue is a queue that has a PullTarget.
+ },
+ "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.
}</pre>
</div>
@@ -4171,86 +4171,12 @@
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
- #
- # To learn which resources support conditions in their IAM policies, see the
- # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "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.
- "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.
- "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.
- },
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
@@ -4296,10 +4222,84 @@
#
"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.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ },
},
],
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
},
}
@@ -4390,86 +4390,12 @@
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
- #
- # To learn which resources support conditions in their IAM policies, see the
- # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "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.
- "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.
- "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.
- },
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
@@ -4515,10 +4441,84 @@
#
"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.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ },
},
],
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}</pre>
</div>