chore: regens API reference docs (#889)
diff --git a/docs/dyn/cloudtasks_v2.projects.locations.queues.html b/docs/dyn/cloudtasks_v2.projects.locations.queues.html
index 05bc348..07af78f 100644
--- a/docs/dyn/cloudtasks_v2.projects.locations.queues.html
+++ b/docs/dyn/cloudtasks_v2.projects.locations.queues.html
@@ -80,7 +80,7 @@
<p class="firstline">Returns the tasks Resource.</p>
<p class="toc_element">
- <code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a queue.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
@@ -92,13 +92,13 @@
<code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the access control policy for a Queue.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</a></code></p>
+ <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None, filter=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>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p>
+ <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a queue.</p>
<p class="toc_element">
<code><a href="#pause">pause(name, body=None, x__xgafv=None)</a></code></p>
@@ -110,14 +110,14 @@
<code><a href="#resume">resume(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Resume a queue.</p>
<p class="toc_element">
- <code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
+ <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the access control policy for a Queue. Replaces any existing</p>
<p class="toc_element">
- <code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
+ <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns permissions that a caller has on a Queue.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(parent, body, x__xgafv=None)</code>
+ <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates a queue.
Queues created with this method allow tasks to live for a maximum of 31
@@ -132,15 +132,13 @@
this method.
Args:
- parent: string, Required.
-
-The location name in which the queue will be created.
+ parent: string, Required. The location name in which the queue will be created.
For example: `projects/PROJECT_ID/locations/LOCATION_ID`
The list of allowed locations can be obtained by calling Cloud
Tasks' implementation of
ListLocations. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # A queue is a container of related tasks. Queues are configured to manage
@@ -165,6 +163,15 @@
# For more information, see https://cloud.google.com/about/locations/.
# * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
# hyphens (-). The maximum length is 100 characters.
+ "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
+ # field is unset, then no logs are written.
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ "samplingRatio": 3.14, # Specifies the fraction of operations to write to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ # This field may contain any value between 0.0 and 1.0, inclusive.
+ # 0.0 is the default and means that no operations are logged.
+ },
"rateLimits": { # Rate limits. # Rate limits for task dispatches.
#
# rate_limits and retry_config are
@@ -231,7 +238,7 @@
# value of
# max_dispatches_per_second.
#
- # For App Engine queues that were created or updated using
+ # For queues that were created or updated using
# `queue.yaml/xml`, `max_burst_size` is equal to
# [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
# Since `max_burst_size` is output only, if
@@ -247,8 +254,7 @@
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # * For App Engine queues, the maximum allowed value
- # is 500.
+ # * The maximum allowed value is 500.
#
#
# This field has the same meaning as
@@ -259,6 +265,7 @@
# task-level app_engine_routing.
# These settings apply only to
# App Engine tasks in this queue.
+ # Http tasks are not affected.
#
# If set, `app_engine_routing_override` is used for all
# App Engine tasks in the queue, no matter what the
@@ -277,6 +284,13 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
+ #
+ # Using AppEngineRouting requires
+ # [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
+ # Google IAM permission for the project
+ # and the following scope:
+ #
+ # `https://www.googleapis.com/auth/cloud-platform`
"instance": "A String", # App instance.
#
# By default, the task is sent to an instance which is available when
@@ -293,7 +307,7 @@
"host": "A String", # Output only. The host that the task is sent to.
#
# The host is constructed from the domain name of the app associated with
- # the queue's project ID (for example <app-id>.appspot.com), and the
+ # the queue's project ID (for example <app-id>.appspot.com), and the
# service, version,
# and instance. Tasks which were created using
# the App Engine SDK might have a custom domain name.
@@ -364,27 +378,30 @@
# documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
#
# These settings determine when a failed task attempt is retried.
- "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.
+ "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ # retrying a failed task, measured from when the task was first
+ # attempted. Once `max_retry_duration` time has passed *and* the
+ # task has been attempted max_attempts
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
#
- # `max_backoff` will be truncated to the nearest second.
+ # `max_retry_duration` will be truncated to the nearest second.
#
# This field has the same meaning as
- # [max_backoff_seconds in
+ # [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 retries at intervals of
+ # retries at intervals of
# max_backoff up to
# max_attempts times.
#
@@ -409,7 +426,7 @@
#
# Cloud Tasks will attempt the task `max_attempts` times (that is, if the
# first attempt fails, then there will be `max_attempts - 1` retries). Must
- # be >= -1.
+ # be >= -1.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
@@ -419,23 +436,20 @@
# This field has the same meaning as
# [task_retry_limit in
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "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.
+ "maxBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
#
- # `max_retry_duration` will be truncated to the nearest second.
+ # `max_backoff` will be truncated to the nearest second.
#
# This field has the same meaning as
- # [task_age_limit in
+ # [max_backoff_seconds in
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
"minBackoff": "A String", # A task will be scheduled for retry between
# min_backoff and
@@ -485,6 +499,15 @@
# For more information, see https://cloud.google.com/about/locations/.
# * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
# hyphens (-). The maximum length is 100 characters.
+ "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
+ # field is unset, then no logs are written.
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ "samplingRatio": 3.14, # Specifies the fraction of operations to write to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ # This field may contain any value between 0.0 and 1.0, inclusive.
+ # 0.0 is the default and means that no operations are logged.
+ },
"rateLimits": { # Rate limits. # Rate limits for task dispatches.
#
# rate_limits and retry_config are
@@ -551,7 +574,7 @@
# value of
# max_dispatches_per_second.
#
- # For App Engine queues that were created or updated using
+ # For queues that were created or updated using
# `queue.yaml/xml`, `max_burst_size` is equal to
# [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
# Since `max_burst_size` is output only, if
@@ -567,8 +590,7 @@
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # * For App Engine queues, the maximum allowed value
- # is 500.
+ # * The maximum allowed value is 500.
#
#
# This field has the same meaning as
@@ -579,6 +601,7 @@
# task-level app_engine_routing.
# These settings apply only to
# App Engine tasks in this queue.
+ # Http tasks are not affected.
#
# If set, `app_engine_routing_override` is used for all
# App Engine tasks in the queue, no matter what the
@@ -597,6 +620,13 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
+ #
+ # Using AppEngineRouting requires
+ # [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
+ # Google IAM permission for the project
+ # and the following scope:
+ #
+ # `https://www.googleapis.com/auth/cloud-platform`
"instance": "A String", # App instance.
#
# By default, the task is sent to an instance which is available when
@@ -613,7 +643,7 @@
"host": "A String", # Output only. The host that the task is sent to.
#
# The host is constructed from the domain name of the app associated with
- # the queue's project ID (for example <app-id>.appspot.com), and the
+ # the queue's project ID (for example <app-id>.appspot.com), and the
# service, version,
# and instance. Tasks which were created using
# the App Engine SDK might have a custom domain name.
@@ -684,27 +714,30 @@
# documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
#
# These settings determine when a failed task attempt is retried.
- "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.
+ "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ # retrying a failed task, measured from when the task was first
+ # attempted. Once `max_retry_duration` time has passed *and* the
+ # task has been attempted max_attempts
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
#
- # `max_backoff` will be truncated to the nearest second.
+ # `max_retry_duration` will be truncated to the nearest second.
#
# This field has the same meaning as
- # [max_backoff_seconds in
+ # [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 retries at intervals of
+ # retries at intervals of
# max_backoff up to
# max_attempts times.
#
@@ -729,7 +762,7 @@
#
# Cloud Tasks will attempt the task `max_attempts` times (that is, if the
# first attempt fails, then there will be `max_attempts - 1` retries). Must
- # be >= -1.
+ # be >= -1.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
@@ -739,23 +772,20 @@
# This field has the same meaning as
# [task_retry_limit in
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "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.
+ "maxBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
#
- # `max_retry_duration` will be truncated to the nearest second.
+ # `max_backoff` will be truncated to the nearest second.
#
# This field has the same meaning as
- # [task_age_limit in
+ # [max_backoff_seconds in
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
"minBackoff": "A String", # A task will be scheduled for retry between
# min_backoff and
@@ -793,9 +823,7 @@
this method.
Args:
- name: string, Required.
-
-The queue name. For example:
+ name: string, Required. The queue name. For example:
`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` (required)
x__xgafv: string, V1 error format.
Allowed values
@@ -822,9 +850,7 @@
<pre>Gets a queue.
Args:
- name: string, Required.
-
-The resource name of the queue. For example:
+ name: string, Required. The resource name of the queue. For example:
`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` (required)
x__xgafv: string, V1 error format.
Allowed values
@@ -856,6 +882,15 @@
# For more information, see https://cloud.google.com/about/locations/.
# * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
# hyphens (-). The maximum length is 100 characters.
+ "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
+ # field is unset, then no logs are written.
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ "samplingRatio": 3.14, # Specifies the fraction of operations to write to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ # This field may contain any value between 0.0 and 1.0, inclusive.
+ # 0.0 is the default and means that no operations are logged.
+ },
"rateLimits": { # Rate limits. # Rate limits for task dispatches.
#
# rate_limits and retry_config are
@@ -922,7 +957,7 @@
# value of
# max_dispatches_per_second.
#
- # For App Engine queues that were created or updated using
+ # For queues that were created or updated using
# `queue.yaml/xml`, `max_burst_size` is equal to
# [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
# Since `max_burst_size` is output only, if
@@ -938,8 +973,7 @@
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # * For App Engine queues, the maximum allowed value
- # is 500.
+ # * The maximum allowed value is 500.
#
#
# This field has the same meaning as
@@ -950,6 +984,7 @@
# task-level app_engine_routing.
# These settings apply only to
# App Engine tasks in this queue.
+ # Http tasks are not affected.
#
# If set, `app_engine_routing_override` is used for all
# App Engine tasks in the queue, no matter what the
@@ -968,6 +1003,13 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
+ #
+ # Using AppEngineRouting requires
+ # [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
+ # Google IAM permission for the project
+ # and the following scope:
+ #
+ # `https://www.googleapis.com/auth/cloud-platform`
"instance": "A String", # App instance.
#
# By default, the task is sent to an instance which is available when
@@ -984,7 +1026,7 @@
"host": "A String", # Output only. The host that the task is sent to.
#
# The host is constructed from the domain name of the app associated with
- # the queue's project ID (for example <app-id>.appspot.com), and the
+ # the queue's project ID (for example <app-id>.appspot.com), and the
# service, version,
# and instance. Tasks which were created using
# the App Engine SDK might have a custom domain name.
@@ -1055,27 +1097,30 @@
# documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
#
# These settings determine when a failed task attempt is retried.
- "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.
+ "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ # retrying a failed task, measured from when the task was first
+ # attempted. Once `max_retry_duration` time has passed *and* the
+ # task has been attempted max_attempts
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
#
- # `max_backoff` will be truncated to the nearest second.
+ # `max_retry_duration` will be truncated to the nearest second.
#
# This field has the same meaning as
- # [max_backoff_seconds in
+ # [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 retries at intervals of
+ # retries at intervals of
# max_backoff up to
# max_attempts times.
#
@@ -1100,7 +1145,7 @@
#
# Cloud Tasks will attempt the task `max_attempts` times (that is, if the
# first attempt fails, then there will be `max_attempts - 1` retries). Must
- # be >= -1.
+ # be >= -1.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
@@ -1110,23 +1155,20 @@
# This field has the same meaning as
# [task_retry_limit in
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "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.
+ "maxBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
#
- # `max_retry_duration` will be truncated to the nearest second.
+ # `max_backoff` will be truncated to the nearest second.
#
# This field has the same meaning as
- # [task_age_limit in
+ # [max_backoff_seconds in
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
"minBackoff": "A String", # A task will be scheduled for retry between
# min_backoff and
@@ -1166,6 +1208,17 @@
The object takes the form of:
{ # Request message for `GetIamPolicy` method.
+ "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to
+ # `GetIamPolicy`.
+ "requestedPolicyVersion": 42, # Optional. The policy format version to be returned.
+ #
+ # Valid values are 0, 1, and 3. Requests specifying an invalid value will be
+ # rejected.
+ #
+ # Requests for policies with any conditional bindings must specify version 3.
+ # Policies without any conditional bindings may specify any valid value or
+ # leave the field unset.
+ },
}
x__xgafv: string, V1 error format.
@@ -1176,56 +1229,119 @@
Returns:
An object of the form:
- { # Defines an Identity and Access Management (IAM) policy. It is used to
- # specify access control policies for Cloud Platform resources.
+ { # An Identity and Access Management (IAM) policy, which specifies access
+ # controls for Google Cloud resources.
#
#
- # A `Policy` consists of a list of `bindings`. A `binding` binds a list of
- # `members` to a `role`, where the members can be user accounts, Google groups,
- # Google domains, and service accounts. A `role` is a named list of permissions
- # defined by IAM.
+ # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+ # `members` to a single `role`. Members can be user accounts, service accounts,
+ # Google groups, and domains (such as G Suite). A `role` is a named list of
+ # permissions; each `role` can be an IAM predefined role or a user-created
+ # custom role.
#
- # **JSON Example**
+ # Optionally, a `binding` can specify a `condition`, which is a logical
+ # expression that allows access to a resource only if the expression evaluates
+ # to `true`. A condition can add constraints based on attributes of the
+ # request, the resource, or both.
+ #
+ # **JSON example:**
#
# {
# "bindings": [
# {
- # "role": "roles/owner",
+ # "role": "roles/resourcemanager.organizationAdmin",
# "members": [
# "user:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
- # "serviceAccount:my-other-app@appspot.gserviceaccount.com"
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
- # "role": "roles/viewer",
- # "members": ["user:sean@example.com"]
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": ["user:eve@example.com"],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # }
# }
- # ]
+ # ],
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
- # **YAML Example**
+ # **YAML example:**
#
# bindings:
# - members:
# - user:mike@example.com
# - group:admins@example.com
# - domain:google.com
- # - serviceAccount:my-other-app@appspot.gserviceaccount.com
- # role: roles/owner
+ # - serviceAccount:my-project-id@appspot.gserviceaccount.com
+ # role: roles/resourcemanager.organizationAdmin
# - members:
- # - user:sean@example.com
- # role: roles/viewer
- #
+ # - user:eve@example.com
+ # role: roles/resourcemanager.organizationViewer
+ # condition:
+ # title: expirable access
+ # description: Does not grant access after Sep 2020
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # - etag: BwWWja0YfJA=
+ # - version: 3
#
# For a description of IAM and its features, see the
- # [IAM developer's guide](https://cloud.google.com/iam/docs).
- "bindings": [ # Associates a list of `members` to a `role`.
- # `bindings` with no members will result in an error.
+ # [IAM documentation](https://cloud.google.com/iam/docs/).
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ # `condition` that determines how and when the `bindings` are applied. Each
+ # of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
"role": "A String", # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ # NOTE: An unsatisfied condition will not allow user access via current
+ # binding. Different bindings, including their conditions, are examined
+ # independently.
+ # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+ # are documented at https://github.com/google/cel-spec.
+ #
+ # Example (Comparison):
+ #
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ },
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
@@ -1236,7 +1352,7 @@
# who is authenticated with a Google account or a service account.
#
# * `user:{emailid}`: An email address that represents a specific Google
- # account. For example, `alice@gmail.com` .
+ # account. For example, `alice@example.com` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a service
@@ -1245,36 +1361,55 @@
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `admins@example.com`.
#
+ # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a user that has been recently deleted. For
+ # example, `alice@example.com?uid=123456789012345678901`. If the user is
+ # recovered, this value reverts to `user:{emailid}` and the recovered user
+ # retains the role in the binding.
+ #
+ # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+ # unique identifier) representing a service account that has been recently
+ # deleted. For example,
+ # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+ # If the service account is undeleted, this value reverts to
+ # `serviceAccount:{emailid}` and the undeleted service account retains the
+ # role in the binding.
+ #
+ # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a Google group that has been recently
+ # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+ # the group is recovered, this value reverts to `group:{emailid}` and the
+ # recovered group retains the role in the binding.
+ #
#
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
"A String",
],
- "condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
- # NOTE: An unsatisfied condition will not allow user access via current
- # binding. Different bindings, including their conditions, are examined
- # independently.
- #
- # title: "User account presence"
- # description: "Determines whether the request has a user account"
- # expression: "size(request.user) > 0"
- "description": "A String", # An 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.
- #
- # The application context of the containing message determines which
- # well-known feature set of CEL is supported.
- "location": "A String", # An optional string indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "title": "A String", # An 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.
- },
},
],
- "version": 42, # Deprecated.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
@@ -1283,29 +1418,22 @@
# systems are expected to put that etag in the request to `setIamPolicy` to
# ensure that their change will be applied to the same version of the policy.
#
- # If no `etag` is provided in the call to `setIamPolicy`, then the existing
- # policy is overwritten blindly.
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</code>
+ <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code>
<pre>Lists queues.
Queues are returned in lexicographical order.
Args:
- parent: string, Required.
-
-The location name.
+ parent: string, Required. The location name.
For example: `projects/PROJECT_ID/locations/LOCATION_ID` (required)
- pageSize: integer, Requested page size.
-
-The maximum page size is 9800. If unspecified, the page size will
-be the maximum. Fewer queues than requested might be returned,
-even if more queues exist; use the
-next_page_token in the
-response to determine if more queues exist.
pageToken: string, A token identifying the page of results to return.
To request the first page results, page_token must be empty. To
@@ -1318,9 +1446,16 @@
Allowed values
1 - v1 error format
2 - v2 error format
+ pageSize: integer, Requested page size.
+
+The maximum page size is 9800. If unspecified, the page size will
+be the maximum. Fewer queues than requested might be returned,
+even if more queues exist; use the
+next_page_token in the
+response to determine if more queues exist.
filter: string, `filter` can be used to specify a subset of queues. Any Queue
field can be used as a filter and several operators as supported.
-For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as
+For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as
described in
[Stackdriver's Advanced Logs
Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
@@ -1366,6 +1501,15 @@
# For more information, see https://cloud.google.com/about/locations/.
# * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
# hyphens (-). The maximum length is 100 characters.
+ "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
+ # field is unset, then no logs are written.
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ "samplingRatio": 3.14, # Specifies the fraction of operations to write to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ # This field may contain any value between 0.0 and 1.0, inclusive.
+ # 0.0 is the default and means that no operations are logged.
+ },
"rateLimits": { # Rate limits. # Rate limits for task dispatches.
#
# rate_limits and retry_config are
@@ -1432,7 +1576,7 @@
# value of
# max_dispatches_per_second.
#
- # For App Engine queues that were created or updated using
+ # For queues that were created or updated using
# `queue.yaml/xml`, `max_burst_size` is equal to
# [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
# Since `max_burst_size` is output only, if
@@ -1448,8 +1592,7 @@
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # * For App Engine queues, the maximum allowed value
- # is 500.
+ # * The maximum allowed value is 500.
#
#
# This field has the same meaning as
@@ -1460,6 +1603,7 @@
# task-level app_engine_routing.
# These settings apply only to
# App Engine tasks in this queue.
+ # Http tasks are not affected.
#
# If set, `app_engine_routing_override` is used for all
# App Engine tasks in the queue, no matter what the
@@ -1478,6 +1622,13 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
+ #
+ # Using AppEngineRouting requires
+ # [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
+ # Google IAM permission for the project
+ # and the following scope:
+ #
+ # `https://www.googleapis.com/auth/cloud-platform`
"instance": "A String", # App instance.
#
# By default, the task is sent to an instance which is available when
@@ -1494,7 +1645,7 @@
"host": "A String", # Output only. The host that the task is sent to.
#
# The host is constructed from the domain name of the app associated with
- # the queue's project ID (for example <app-id>.appspot.com), and the
+ # the queue's project ID (for example <app-id>.appspot.com), and the
# service, version,
# and instance. Tasks which were created using
# the App Engine SDK might have a custom domain name.
@@ -1565,27 +1716,30 @@
# documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
#
# These settings determine when a failed task attempt is retried.
- "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.
+ "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ # retrying a failed task, measured from when the task was first
+ # attempted. Once `max_retry_duration` time has passed *and* the
+ # task has been attempted max_attempts
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
#
- # `max_backoff` will be truncated to the nearest second.
+ # `max_retry_duration` will be truncated to the nearest second.
#
# This field has the same meaning as
- # [max_backoff_seconds in
+ # [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 retries at intervals of
+ # retries at intervals of
# max_backoff up to
# max_attempts times.
#
@@ -1610,7 +1764,7 @@
#
# Cloud Tasks will attempt the task `max_attempts` times (that is, if the
# first attempt fails, then there will be `max_attempts - 1` retries). Must
- # be >= -1.
+ # be >= -1.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
@@ -1620,23 +1774,20 @@
# This field has the same meaning as
# [task_retry_limit in
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "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.
+ "maxBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
#
- # `max_retry_duration` will be truncated to the nearest second.
+ # `max_backoff` will be truncated to the nearest second.
#
# This field has the same meaning as
- # [task_age_limit in
+ # [max_backoff_seconds in
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
"minBackoff": "A String", # A task will be scheduled for retry between
# min_backoff and
@@ -1674,7 +1825,7 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code>
+ <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates a queue.
This method creates the queue if it does not exist and updates
@@ -1711,7 +1862,7 @@
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. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # A queue is a container of related tasks. Queues are configured to manage
@@ -1736,6 +1887,15 @@
# For more information, see https://cloud.google.com/about/locations/.
# * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
# hyphens (-). The maximum length is 100 characters.
+ "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
+ # field is unset, then no logs are written.
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ "samplingRatio": 3.14, # Specifies the fraction of operations to write to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ # This field may contain any value between 0.0 and 1.0, inclusive.
+ # 0.0 is the default and means that no operations are logged.
+ },
"rateLimits": { # Rate limits. # Rate limits for task dispatches.
#
# rate_limits and retry_config are
@@ -1802,7 +1962,7 @@
# value of
# max_dispatches_per_second.
#
- # For App Engine queues that were created or updated using
+ # For queues that were created or updated using
# `queue.yaml/xml`, `max_burst_size` is equal to
# [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
# Since `max_burst_size` is output only, if
@@ -1818,8 +1978,7 @@
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # * For App Engine queues, the maximum allowed value
- # is 500.
+ # * The maximum allowed value is 500.
#
#
# This field has the same meaning as
@@ -1830,6 +1989,7 @@
# task-level app_engine_routing.
# These settings apply only to
# App Engine tasks in this queue.
+ # Http tasks are not affected.
#
# If set, `app_engine_routing_override` is used for all
# App Engine tasks in the queue, no matter what the
@@ -1848,6 +2008,13 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
+ #
+ # Using AppEngineRouting requires
+ # [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
+ # Google IAM permission for the project
+ # and the following scope:
+ #
+ # `https://www.googleapis.com/auth/cloud-platform`
"instance": "A String", # App instance.
#
# By default, the task is sent to an instance which is available when
@@ -1864,7 +2031,7 @@
"host": "A String", # Output only. The host that the task is sent to.
#
# The host is constructed from the domain name of the app associated with
- # the queue's project ID (for example <app-id>.appspot.com), and the
+ # the queue's project ID (for example <app-id>.appspot.com), and the
# service, version,
# and instance. Tasks which were created using
# the App Engine SDK might have a custom domain name.
@@ -1935,27 +2102,30 @@
# documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
#
# These settings determine when a failed task attempt is retried.
- "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.
+ "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ # retrying a failed task, measured from when the task was first
+ # attempted. Once `max_retry_duration` time has passed *and* the
+ # task has been attempted max_attempts
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
#
- # `max_backoff` will be truncated to the nearest second.
+ # `max_retry_duration` will be truncated to the nearest second.
#
# This field has the same meaning as
- # [max_backoff_seconds in
+ # [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 retries at intervals of
+ # retries at intervals of
# max_backoff up to
# max_attempts times.
#
@@ -1980,7 +2150,7 @@
#
# Cloud Tasks will attempt the task `max_attempts` times (that is, if the
# first attempt fails, then there will be `max_attempts - 1` retries). Must
- # be >= -1.
+ # be >= -1.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
@@ -1990,23 +2160,20 @@
# This field has the same meaning as
# [task_retry_limit in
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "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.
+ "maxBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
#
- # `max_retry_duration` will be truncated to the nearest second.
+ # `max_backoff` will be truncated to the nearest second.
#
# This field has the same meaning as
- # [task_age_limit in
+ # [max_backoff_seconds in
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
"minBackoff": "A String", # A task will be scheduled for retry between
# min_backoff and
@@ -2059,6 +2226,15 @@
# For more information, see https://cloud.google.com/about/locations/.
# * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
# hyphens (-). The maximum length is 100 characters.
+ "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
+ # field is unset, then no logs are written.
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ "samplingRatio": 3.14, # Specifies the fraction of operations to write to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ # This field may contain any value between 0.0 and 1.0, inclusive.
+ # 0.0 is the default and means that no operations are logged.
+ },
"rateLimits": { # Rate limits. # Rate limits for task dispatches.
#
# rate_limits and retry_config are
@@ -2125,7 +2301,7 @@
# value of
# max_dispatches_per_second.
#
- # For App Engine queues that were created or updated using
+ # For queues that were created or updated using
# `queue.yaml/xml`, `max_burst_size` is equal to
# [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
# Since `max_burst_size` is output only, if
@@ -2141,8 +2317,7 @@
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # * For App Engine queues, the maximum allowed value
- # is 500.
+ # * The maximum allowed value is 500.
#
#
# This field has the same meaning as
@@ -2153,6 +2328,7 @@
# task-level app_engine_routing.
# These settings apply only to
# App Engine tasks in this queue.
+ # Http tasks are not affected.
#
# If set, `app_engine_routing_override` is used for all
# App Engine tasks in the queue, no matter what the
@@ -2171,6 +2347,13 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
+ #
+ # Using AppEngineRouting requires
+ # [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
+ # Google IAM permission for the project
+ # and the following scope:
+ #
+ # `https://www.googleapis.com/auth/cloud-platform`
"instance": "A String", # App instance.
#
# By default, the task is sent to an instance which is available when
@@ -2187,7 +2370,7 @@
"host": "A String", # Output only. The host that the task is sent to.
#
# The host is constructed from the domain name of the app associated with
- # the queue's project ID (for example <app-id>.appspot.com), and the
+ # the queue's project ID (for example <app-id>.appspot.com), and the
# service, version,
# and instance. Tasks which were created using
# the App Engine SDK might have a custom domain name.
@@ -2258,27 +2441,30 @@
# documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
#
# These settings determine when a failed task attempt is retried.
- "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.
+ "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ # retrying a failed task, measured from when the task was first
+ # attempted. Once `max_retry_duration` time has passed *and* the
+ # task has been attempted max_attempts
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
#
- # `max_backoff` will be truncated to the nearest second.
+ # `max_retry_duration` will be truncated to the nearest second.
#
# This field has the same meaning as
- # [max_backoff_seconds in
+ # [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 retries at intervals of
+ # retries at intervals of
# max_backoff up to
# max_attempts times.
#
@@ -2303,7 +2489,7 @@
#
# Cloud Tasks will attempt the task `max_attempts` times (that is, if the
# first attempt fails, then there will be `max_attempts - 1` retries). Must
- # be >= -1.
+ # be >= -1.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
@@ -2313,23 +2499,20 @@
# This field has the same meaning as
# [task_retry_limit in
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "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.
+ "maxBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
#
- # `max_retry_duration` will be truncated to the nearest second.
+ # `max_backoff` will be truncated to the nearest second.
#
# This field has the same meaning as
- # [task_age_limit in
+ # [max_backoff_seconds in
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
"minBackoff": "A String", # A task will be scheduled for retry between
# min_backoff and
@@ -2361,9 +2544,7 @@
state is PAUSED.
Args:
- name: string, Required.
-
-The queue name. For example:
+ name: string, Required. The queue name. For example:
`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` (required)
body: object, The request body.
The object takes the form of:
@@ -2401,6 +2582,15 @@
# For more information, see https://cloud.google.com/about/locations/.
# * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
# hyphens (-). The maximum length is 100 characters.
+ "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
+ # field is unset, then no logs are written.
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ "samplingRatio": 3.14, # Specifies the fraction of operations to write to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ # This field may contain any value between 0.0 and 1.0, inclusive.
+ # 0.0 is the default and means that no operations are logged.
+ },
"rateLimits": { # Rate limits. # Rate limits for task dispatches.
#
# rate_limits and retry_config are
@@ -2467,7 +2657,7 @@
# value of
# max_dispatches_per_second.
#
- # For App Engine queues that were created or updated using
+ # For queues that were created or updated using
# `queue.yaml/xml`, `max_burst_size` is equal to
# [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
# Since `max_burst_size` is output only, if
@@ -2483,8 +2673,7 @@
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # * For App Engine queues, the maximum allowed value
- # is 500.
+ # * The maximum allowed value is 500.
#
#
# This field has the same meaning as
@@ -2495,6 +2684,7 @@
# task-level app_engine_routing.
# These settings apply only to
# App Engine tasks in this queue.
+ # Http tasks are not affected.
#
# If set, `app_engine_routing_override` is used for all
# App Engine tasks in the queue, no matter what the
@@ -2513,6 +2703,13 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
+ #
+ # Using AppEngineRouting requires
+ # [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
+ # Google IAM permission for the project
+ # and the following scope:
+ #
+ # `https://www.googleapis.com/auth/cloud-platform`
"instance": "A String", # App instance.
#
# By default, the task is sent to an instance which is available when
@@ -2529,7 +2726,7 @@
"host": "A String", # Output only. The host that the task is sent to.
#
# The host is constructed from the domain name of the app associated with
- # the queue's project ID (for example <app-id>.appspot.com), and the
+ # the queue's project ID (for example <app-id>.appspot.com), and the
# service, version,
# and instance. Tasks which were created using
# the App Engine SDK might have a custom domain name.
@@ -2600,27 +2797,30 @@
# documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
#
# These settings determine when a failed task attempt is retried.
- "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.
+ "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ # retrying a failed task, measured from when the task was first
+ # attempted. Once `max_retry_duration` time has passed *and* the
+ # task has been attempted max_attempts
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
#
- # `max_backoff` will be truncated to the nearest second.
+ # `max_retry_duration` will be truncated to the nearest second.
#
# This field has the same meaning as
- # [max_backoff_seconds in
+ # [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 retries at intervals of
+ # retries at intervals of
# max_backoff up to
# max_attempts times.
#
@@ -2645,7 +2845,7 @@
#
# Cloud Tasks will attempt the task `max_attempts` times (that is, if the
# first attempt fails, then there will be `max_attempts - 1` retries). Must
- # be >= -1.
+ # be >= -1.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
@@ -2655,23 +2855,20 @@
# This field has the same meaning as
# [task_retry_limit in
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "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.
+ "maxBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
#
- # `max_retry_duration` will be truncated to the nearest second.
+ # `max_backoff` will be truncated to the nearest second.
#
# This field has the same meaning as
- # [task_age_limit in
+ # [max_backoff_seconds in
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
"minBackoff": "A String", # A task will be scheduled for retry between
# min_backoff and
@@ -2702,9 +2899,7 @@
might be dispatched before the purge takes effect. A purge is irreversible.
Args:
- name: string, Required.
-
-The queue name. For example:
+ name: string, Required. The queue name. For example:
`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` (required)
body: object, The request body.
The object takes the form of:
@@ -2742,6 +2937,15 @@
# For more information, see https://cloud.google.com/about/locations/.
# * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
# hyphens (-). The maximum length is 100 characters.
+ "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
+ # field is unset, then no logs are written.
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ "samplingRatio": 3.14, # Specifies the fraction of operations to write to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ # This field may contain any value between 0.0 and 1.0, inclusive.
+ # 0.0 is the default and means that no operations are logged.
+ },
"rateLimits": { # Rate limits. # Rate limits for task dispatches.
#
# rate_limits and retry_config are
@@ -2808,7 +3012,7 @@
# value of
# max_dispatches_per_second.
#
- # For App Engine queues that were created or updated using
+ # For queues that were created or updated using
# `queue.yaml/xml`, `max_burst_size` is equal to
# [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
# Since `max_burst_size` is output only, if
@@ -2824,8 +3028,7 @@
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # * For App Engine queues, the maximum allowed value
- # is 500.
+ # * The maximum allowed value is 500.
#
#
# This field has the same meaning as
@@ -2836,6 +3039,7 @@
# task-level app_engine_routing.
# These settings apply only to
# App Engine tasks in this queue.
+ # Http tasks are not affected.
#
# If set, `app_engine_routing_override` is used for all
# App Engine tasks in the queue, no matter what the
@@ -2854,6 +3058,13 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
+ #
+ # Using AppEngineRouting requires
+ # [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
+ # Google IAM permission for the project
+ # and the following scope:
+ #
+ # `https://www.googleapis.com/auth/cloud-platform`
"instance": "A String", # App instance.
#
# By default, the task is sent to an instance which is available when
@@ -2870,7 +3081,7 @@
"host": "A String", # Output only. The host that the task is sent to.
#
# The host is constructed from the domain name of the app associated with
- # the queue's project ID (for example <app-id>.appspot.com), and the
+ # the queue's project ID (for example <app-id>.appspot.com), and the
# service, version,
# and instance. Tasks which were created using
# the App Engine SDK might have a custom domain name.
@@ -2941,27 +3152,30 @@
# documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
#
# These settings determine when a failed task attempt is retried.
- "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.
+ "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ # retrying a failed task, measured from when the task was first
+ # attempted. Once `max_retry_duration` time has passed *and* the
+ # task has been attempted max_attempts
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
#
- # `max_backoff` will be truncated to the nearest second.
+ # `max_retry_duration` will be truncated to the nearest second.
#
# This field has the same meaning as
- # [max_backoff_seconds in
+ # [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 retries at intervals of
+ # retries at intervals of
# max_backoff up to
# max_attempts times.
#
@@ -2986,7 +3200,7 @@
#
# Cloud Tasks will attempt the task `max_attempts` times (that is, if the
# first attempt fails, then there will be `max_attempts - 1` retries). Must
- # be >= -1.
+ # be >= -1.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
@@ -2996,23 +3210,20 @@
# This field has the same meaning as
# [task_retry_limit in
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "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.
+ "maxBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
#
- # `max_retry_duration` will be truncated to the nearest second.
+ # `max_backoff` will be truncated to the nearest second.
#
# This field has the same meaning as
- # [task_age_limit in
+ # [max_backoff_seconds in
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
"minBackoff": "A String", # A task will be scheduled for retry between
# min_backoff and
@@ -3050,9 +3261,7 @@
Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
Args:
- name: string, Required.
-
-The queue name. For example:
+ name: string, Required. The queue name. For example:
`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` (required)
body: object, The request body.
The object takes the form of:
@@ -3090,6 +3299,15 @@
# For more information, see https://cloud.google.com/about/locations/.
# * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
# hyphens (-). The maximum length is 100 characters.
+ "stackdriverLoggingConfig": { # Configuration options for writing logs to # Configuration options for writing logs to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
+ # field is unset, then no logs are written.
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ "samplingRatio": 3.14, # Specifies the fraction of operations to write to
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+ # This field may contain any value between 0.0 and 1.0, inclusive.
+ # 0.0 is the default and means that no operations are logged.
+ },
"rateLimits": { # Rate limits. # Rate limits for task dispatches.
#
# rate_limits and retry_config are
@@ -3156,7 +3374,7 @@
# value of
# max_dispatches_per_second.
#
- # For App Engine queues that were created or updated using
+ # For queues that were created or updated using
# `queue.yaml/xml`, `max_burst_size` is equal to
# [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
# Since `max_burst_size` is output only, if
@@ -3172,8 +3390,7 @@
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
- # * For App Engine queues, the maximum allowed value
- # is 500.
+ # * The maximum allowed value is 500.
#
#
# This field has the same meaning as
@@ -3184,6 +3401,7 @@
# task-level app_engine_routing.
# These settings apply only to
# App Engine tasks in this queue.
+ # Http tasks are not affected.
#
# If set, `app_engine_routing_override` is used for all
# App Engine tasks in the queue, no matter what the
@@ -3202,6 +3420,13 @@
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
# and [App Engine Flex request
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
+ #
+ # Using AppEngineRouting requires
+ # [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
+ # Google IAM permission for the project
+ # and the following scope:
+ #
+ # `https://www.googleapis.com/auth/cloud-platform`
"instance": "A String", # App instance.
#
# By default, the task is sent to an instance which is available when
@@ -3218,7 +3443,7 @@
"host": "A String", # Output only. The host that the task is sent to.
#
# The host is constructed from the domain name of the app associated with
- # the queue's project ID (for example <app-id>.appspot.com), and the
+ # the queue's project ID (for example <app-id>.appspot.com), and the
# service, version,
# and instance. Tasks which were created using
# the App Engine SDK might have a custom domain name.
@@ -3289,27 +3514,30 @@
# documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
#
# These settings determine when a failed task attempt is retried.
- "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.
+ "maxRetryDuration": "A String", # If positive, `max_retry_duration` specifies the time limit for
+ # retrying a failed task, measured from when the task was first
+ # attempted. Once `max_retry_duration` time has passed *and* the
+ # task has been attempted max_attempts
+ # times, no further attempts will be made and the task will be
+ # deleted.
+ #
+ # If zero, then the task age is unlimited.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
#
- # `max_backoff` will be truncated to the nearest second.
+ # `max_retry_duration` will be truncated to the nearest second.
#
# This field has the same meaning as
- # [max_backoff_seconds in
+ # [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 retries at intervals of
+ # retries at intervals of
# max_backoff up to
# max_attempts times.
#
@@ -3334,7 +3562,7 @@
#
# Cloud Tasks will attempt the task `max_attempts` times (that is, if the
# first attempt fails, then there will be `max_attempts - 1` retries). Must
- # be >= -1.
+ # be >= -1.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
@@ -3344,23 +3572,20 @@
# This field has the same meaning as
# [task_retry_limit in
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
- "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.
+ "maxBackoff": "A String", # A task will be scheduled for retry between
+ # min_backoff and
+ # max_backoff duration after it fails,
+ # if the queue's RetryConfig specifies that the task should be
+ # retried.
#
# If unspecified when the queue is created, Cloud Tasks will pick the
# default.
#
#
- # `max_retry_duration` will be truncated to the nearest second.
+ # `max_backoff` will be truncated to the nearest second.
#
# This field has the same meaning as
- # [task_age_limit in
+ # [max_backoff_seconds in
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
"minBackoff": "A String", # A task will be scheduled for retry between
# min_backoff and
@@ -3382,7 +3607,7 @@
</div>
<div class="method">
- <code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
+ <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
<pre>Sets the access control policy for a Queue. Replaces any existing
policy.
@@ -3398,63 +3623,126 @@
Args:
resource: string, REQUIRED: The resource for which the policy is being specified.
See the operation documentation for the appropriate value for this field. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
- "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to # REQUIRED: The complete policy to be applied to the `resource`. The size of
+ "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of
# the policy is limited to a few 10s of KB. An empty policy is a
# valid policy but certain Cloud Platform services (such as Projects)
# might reject them.
- # specify access control policies for Cloud Platform resources.
+ # controls for Google Cloud resources.
#
#
- # A `Policy` consists of a list of `bindings`. A `binding` binds a list of
- # `members` to a `role`, where the members can be user accounts, Google groups,
- # Google domains, and service accounts. A `role` is a named list of permissions
- # defined by IAM.
+ # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+ # `members` to a single `role`. Members can be user accounts, service accounts,
+ # Google groups, and domains (such as G Suite). A `role` is a named list of
+ # permissions; each `role` can be an IAM predefined role or a user-created
+ # custom role.
#
- # **JSON Example**
+ # Optionally, a `binding` can specify a `condition`, which is a logical
+ # expression that allows access to a resource only if the expression evaluates
+ # to `true`. A condition can add constraints based on attributes of the
+ # request, the resource, or both.
+ #
+ # **JSON example:**
#
# {
# "bindings": [
# {
- # "role": "roles/owner",
+ # "role": "roles/resourcemanager.organizationAdmin",
# "members": [
# "user:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
- # "serviceAccount:my-other-app@appspot.gserviceaccount.com"
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
- # "role": "roles/viewer",
- # "members": ["user:sean@example.com"]
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": ["user:eve@example.com"],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # }
# }
- # ]
+ # ],
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
- # **YAML Example**
+ # **YAML example:**
#
# bindings:
# - members:
# - user:mike@example.com
# - group:admins@example.com
# - domain:google.com
- # - serviceAccount:my-other-app@appspot.gserviceaccount.com
- # role: roles/owner
+ # - serviceAccount:my-project-id@appspot.gserviceaccount.com
+ # role: roles/resourcemanager.organizationAdmin
# - members:
- # - user:sean@example.com
- # role: roles/viewer
- #
+ # - user:eve@example.com
+ # role: roles/resourcemanager.organizationViewer
+ # condition:
+ # title: expirable access
+ # description: Does not grant access after Sep 2020
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # - etag: BwWWja0YfJA=
+ # - version: 3
#
# For a description of IAM and its features, see the
- # [IAM developer's guide](https://cloud.google.com/iam/docs).
- "bindings": [ # Associates a list of `members` to a `role`.
- # `bindings` with no members will result in an error.
+ # [IAM documentation](https://cloud.google.com/iam/docs/).
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ # `condition` that determines how and when the `bindings` are applied. Each
+ # of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
"role": "A String", # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ # NOTE: An unsatisfied condition will not allow user access via current
+ # binding. Different bindings, including their conditions, are examined
+ # independently.
+ # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+ # are documented at https://github.com/google/cel-spec.
+ #
+ # Example (Comparison):
+ #
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ },
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
@@ -3465,7 +3753,7 @@
# who is authenticated with a Google account or a service account.
#
# * `user:{emailid}`: An email address that represents a specific Google
- # account. For example, `alice@gmail.com` .
+ # account. For example, `alice@example.com` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a service
@@ -3474,36 +3762,55 @@
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `admins@example.com`.
#
+ # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a user that has been recently deleted. For
+ # example, `alice@example.com?uid=123456789012345678901`. If the user is
+ # recovered, this value reverts to `user:{emailid}` and the recovered user
+ # retains the role in the binding.
+ #
+ # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+ # unique identifier) representing a service account that has been recently
+ # deleted. For example,
+ # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+ # If the service account is undeleted, this value reverts to
+ # `serviceAccount:{emailid}` and the undeleted service account retains the
+ # role in the binding.
+ #
+ # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a Google group that has been recently
+ # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+ # the group is recovered, this value reverts to `group:{emailid}` and the
+ # recovered group retains the role in the binding.
+ #
#
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
"A String",
],
- "condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
- # NOTE: An unsatisfied condition will not allow user access via current
- # binding. Different bindings, including their conditions, are examined
- # independently.
- #
- # title: "User account presence"
- # description: "Determines whether the request has a user account"
- # expression: "size(request.user) > 0"
- "description": "A String", # An 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.
- #
- # The application context of the containing message determines which
- # well-known feature set of CEL is supported.
- "location": "A String", # An optional string indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "title": "A String", # An 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.
- },
},
],
- "version": 42, # Deprecated.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
@@ -3512,8 +3819,10 @@
# systems are expected to put that etag in the request to `setIamPolicy` to
# ensure that their change will be applied to the same version of the policy.
#
- # If no `etag` is provided in the call to `setIamPolicy`, then the existing
- # policy is overwritten blindly.
+ # **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.
},
}
@@ -3525,56 +3834,119 @@
Returns:
An object of the form:
- { # Defines an Identity and Access Management (IAM) policy. It is used to
- # specify access control policies for Cloud Platform resources.
+ { # An Identity and Access Management (IAM) policy, which specifies access
+ # controls for Google Cloud resources.
#
#
- # A `Policy` consists of a list of `bindings`. A `binding` binds a list of
- # `members` to a `role`, where the members can be user accounts, Google groups,
- # Google domains, and service accounts. A `role` is a named list of permissions
- # defined by IAM.
+ # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+ # `members` to a single `role`. Members can be user accounts, service accounts,
+ # Google groups, and domains (such as G Suite). A `role` is a named list of
+ # permissions; each `role` can be an IAM predefined role or a user-created
+ # custom role.
#
- # **JSON Example**
+ # Optionally, a `binding` can specify a `condition`, which is a logical
+ # expression that allows access to a resource only if the expression evaluates
+ # to `true`. A condition can add constraints based on attributes of the
+ # request, the resource, or both.
+ #
+ # **JSON example:**
#
# {
# "bindings": [
# {
- # "role": "roles/owner",
+ # "role": "roles/resourcemanager.organizationAdmin",
# "members": [
# "user:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
- # "serviceAccount:my-other-app@appspot.gserviceaccount.com"
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
- # "role": "roles/viewer",
- # "members": ["user:sean@example.com"]
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": ["user:eve@example.com"],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # }
# }
- # ]
+ # ],
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
- # **YAML Example**
+ # **YAML example:**
#
# bindings:
# - members:
# - user:mike@example.com
# - group:admins@example.com
# - domain:google.com
- # - serviceAccount:my-other-app@appspot.gserviceaccount.com
- # role: roles/owner
+ # - serviceAccount:my-project-id@appspot.gserviceaccount.com
+ # role: roles/resourcemanager.organizationAdmin
# - members:
- # - user:sean@example.com
- # role: roles/viewer
- #
+ # - user:eve@example.com
+ # role: roles/resourcemanager.organizationViewer
+ # condition:
+ # title: expirable access
+ # description: Does not grant access after Sep 2020
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # - etag: BwWWja0YfJA=
+ # - version: 3
#
# For a description of IAM and its features, see the
- # [IAM developer's guide](https://cloud.google.com/iam/docs).
- "bindings": [ # Associates a list of `members` to a `role`.
- # `bindings` with no members will result in an error.
+ # [IAM documentation](https://cloud.google.com/iam/docs/).
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ # `condition` that determines how and when the `bindings` are applied. Each
+ # of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
"role": "A String", # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ # NOTE: An unsatisfied condition will not allow user access via current
+ # binding. Different bindings, including their conditions, are examined
+ # independently.
+ # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+ # are documented at https://github.com/google/cel-spec.
+ #
+ # Example (Comparison):
+ #
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ },
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
@@ -3585,7 +3957,7 @@
# who is authenticated with a Google account or a service account.
#
# * `user:{emailid}`: An email address that represents a specific Google
- # account. For example, `alice@gmail.com` .
+ # account. For example, `alice@example.com` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a service
@@ -3594,36 +3966,55 @@
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `admins@example.com`.
#
+ # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a user that has been recently deleted. For
+ # example, `alice@example.com?uid=123456789012345678901`. If the user is
+ # recovered, this value reverts to `user:{emailid}` and the recovered user
+ # retains the role in the binding.
+ #
+ # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+ # unique identifier) representing a service account that has been recently
+ # deleted. For example,
+ # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+ # If the service account is undeleted, this value reverts to
+ # `serviceAccount:{emailid}` and the undeleted service account retains the
+ # role in the binding.
+ #
+ # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a Google group that has been recently
+ # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+ # the group is recovered, this value reverts to `group:{emailid}` and the
+ # recovered group retains the role in the binding.
+ #
#
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
"A String",
],
- "condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
- # NOTE: An unsatisfied condition will not allow user access via current
- # binding. Different bindings, including their conditions, are examined
- # independently.
- #
- # title: "User account presence"
- # description: "Determines whether the request has a user account"
- # expression: "size(request.user) > 0"
- "description": "A String", # An 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.
- #
- # The application context of the containing message determines which
- # well-known feature set of CEL is supported.
- "location": "A String", # An optional string indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "title": "A String", # An 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.
- },
},
],
- "version": 42, # Deprecated.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
@@ -3632,13 +4023,15 @@
# systems are expected to put that etag in the request to `setIamPolicy` to
# ensure that their change will be applied to the same version of the policy.
#
- # If no `etag` is provided in the call to `setIamPolicy`, then the existing
- # policy is overwritten blindly.
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
}</pre>
</div>
<div class="method">
- <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>
+ <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
<pre>Returns permissions that a caller has on a Queue.
If the resource does not exist, this will return an empty set of
permissions, not a NOT_FOUND error.
@@ -3650,7 +4043,7 @@
Args:
resource: string, REQUIRED: The resource for which the policy detail is being requested.
See the operation documentation for the appropriate value for this field. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request message for `TestIamPermissions` method.