docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/pubsub_v1beta2.projects.subscriptions.html b/docs/dyn/pubsub_v1beta2.projects.subscriptions.html
index 1de1b7c..3c16532 100644
--- a/docs/dyn/pubsub_v1beta2.projects.subscriptions.html
+++ b/docs/dyn/pubsub_v1beta2.projects.subscriptions.html
@@ -90,7 +90,7 @@
<code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the access control policy for a resource.</p>
<p class="toc_element">
- <code><a href="#list">list(project, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(project, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists matching subscriptions.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -127,9 +127,9 @@
The object takes the form of:
{ # Request for the Acknowledge method.
- "ackIds": [ # The acknowledgment ID for the messages being acknowledged that was returned
+ "ackIds": [ # The acknowledgment ID for the messages being acknowledged that was returned
# by the Pub/Sub system in the `Pull` response. Must not be empty.
- "A String",
+ "A String",
],
}
@@ -157,7 +157,7 @@
<code class="details" id="create">create(name, body=None, x__xgafv=None)</code>
<pre>Creates a subscription to a given topic.
If the subscription already exists, returns `ALREADY_EXISTS`.
-If the corresponding topic doesn't exist, returns `NOT_FOUND`.
+If the corresponding topic doesn't exist, returns `NOT_FOUND`.
If the name is not provided in the request, the server will assign a random
name for this subscription on the same project as the topic. Note that
@@ -165,16 +165,16 @@
Args:
name: string, The name of the subscription. It must have the format
-`"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
+`"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
start with a letter, and contain only letters (`[A-Za-z]`), numbers
(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
-in length, and it must not start with `"goog"`. (required)
+in length, and it must not start with `"goog"`. (required)
body: object, The request body.
The object takes the form of:
{ # A subscription resource.
- "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message
+ "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message
# before the subscriber should acknowledge the message. After message
# delivery but before the ack deadline expires and before the message is
# acknowledged, it is an outstanding message and will not be delivered
@@ -192,29 +192,19 @@
# system will eventually redeliver the message.
#
# If this parameter is 0, a default value of 10 seconds is used.
- "topic": "A String", # The name of the topic from which this subscription is receiving messages.
+ "name": "A String", # The name of the subscription. It must have the format
+ # `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
+ # start with a letter, and contain only letters (`[A-Za-z]`), numbers
+ # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
+ # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
+ # in length, and it must not start with `"goog"`.
+ "topic": "A String", # The name of the topic from which this subscription is receiving messages.
# The value of this field will be `_deleted-topic_` if the topic has been
# deleted.
- "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
+ "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
# used to configure it. An empty `pushConfig` signifies that the subscriber
# will pull and ack messages using API methods.
- "oidcToken": { # Contains information needed for generating an # If specified, Pub/Sub will generate and attach an OIDC JWT token as an
- # `Authorization` header in the HTTP request for every pushed message.
- # [OpenID Connect
- # token](https://developers.google.com/identity/protocols/OpenIDConnect).
- "audience": "A String", # Audience to be used when generating OIDC token. The audience claim
- # identifies the recipients that the JWT is intended for. The audience
- # value is a single case-sensitive string. Having multiple values (array)
- # for the audience field is not supported. More info about the OIDC JWT
- # token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3
- # Note: if not specified, the Push endpoint URL will be used.
- "serviceAccountEmail": "A String", # [Service account
- # email](https://cloud.google.com/iam/docs/service-accounts)
- # to be used for generating the OIDC token. The caller (for
- # CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
- # have the iam.serviceAccounts.actAs permission for the service account.
- },
- "attributes": { # Endpoint configuration attributes.
+ "attributes": { # Endpoint configuration attributes.
#
# Every endpoint has a set of API supported attributes that can be used to
# control different aspects of the message delivery.
@@ -236,17 +226,27 @@
#
# * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.
# * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
- "a_key": "A String",
+ "a_key": "A String",
},
- "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
- # For example, a Webhook endpoint might use "https://example.com/push".
+ "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
+ # For example, a Webhook endpoint might use "https://example.com/push".
+ "oidcToken": { # Contains information needed for generating an # If specified, Pub/Sub will generate and attach an OIDC JWT token as an
+ # `Authorization` header in the HTTP request for every pushed message.
+ # [OpenID Connect
+ # token](https://developers.google.com/identity/protocols/OpenIDConnect).
+ "audience": "A String", # Audience to be used when generating OIDC token. The audience claim
+ # identifies the recipients that the JWT is intended for. The audience
+ # value is a single case-sensitive string. Having multiple values (array)
+ # for the audience field is not supported. More info about the OIDC JWT
+ # token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3
+ # Note: if not specified, the Push endpoint URL will be used.
+ "serviceAccountEmail": "A String", # [Service account
+ # email](https://cloud.google.com/iam/docs/service-accounts)
+ # to be used for generating the OIDC token. The caller (for
+ # CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
+ # have the iam.serviceAccounts.actAs permission for the service account.
+ },
},
- "name": "A String", # The name of the subscription. It must have the format
- # `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
- # start with a letter, and contain only letters (`[A-Za-z]`), numbers
- # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
- # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
- # in length, and it must not start with `"goog"`.
}
x__xgafv: string, V1 error format.
@@ -258,7 +258,7 @@
An object of the form:
{ # A subscription resource.
- "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message
+ "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message
# before the subscriber should acknowledge the message. After message
# delivery but before the ack deadline expires and before the message is
# acknowledged, it is an outstanding message and will not be delivered
@@ -276,29 +276,19 @@
# system will eventually redeliver the message.
#
# If this parameter is 0, a default value of 10 seconds is used.
- "topic": "A String", # The name of the topic from which this subscription is receiving messages.
+ "name": "A String", # The name of the subscription. It must have the format
+ # `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
+ # start with a letter, and contain only letters (`[A-Za-z]`), numbers
+ # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
+ # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
+ # in length, and it must not start with `"goog"`.
+ "topic": "A String", # The name of the topic from which this subscription is receiving messages.
# The value of this field will be `_deleted-topic_` if the topic has been
# deleted.
- "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
+ "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
# used to configure it. An empty `pushConfig` signifies that the subscriber
# will pull and ack messages using API methods.
- "oidcToken": { # Contains information needed for generating an # If specified, Pub/Sub will generate and attach an OIDC JWT token as an
- # `Authorization` header in the HTTP request for every pushed message.
- # [OpenID Connect
- # token](https://developers.google.com/identity/protocols/OpenIDConnect).
- "audience": "A String", # Audience to be used when generating OIDC token. The audience claim
- # identifies the recipients that the JWT is intended for. The audience
- # value is a single case-sensitive string. Having multiple values (array)
- # for the audience field is not supported. More info about the OIDC JWT
- # token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3
- # Note: if not specified, the Push endpoint URL will be used.
- "serviceAccountEmail": "A String", # [Service account
- # email](https://cloud.google.com/iam/docs/service-accounts)
- # to be used for generating the OIDC token. The caller (for
- # CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
- # have the iam.serviceAccounts.actAs permission for the service account.
- },
- "attributes": { # Endpoint configuration attributes.
+ "attributes": { # Endpoint configuration attributes.
#
# Every endpoint has a set of API supported attributes that can be used to
# control different aspects of the message delivery.
@@ -320,17 +310,27 @@
#
# * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.
# * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
- "a_key": "A String",
+ "a_key": "A String",
},
- "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
- # For example, a Webhook endpoint might use "https://example.com/push".
+ "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
+ # For example, a Webhook endpoint might use "https://example.com/push".
+ "oidcToken": { # Contains information needed for generating an # If specified, Pub/Sub will generate and attach an OIDC JWT token as an
+ # `Authorization` header in the HTTP request for every pushed message.
+ # [OpenID Connect
+ # token](https://developers.google.com/identity/protocols/OpenIDConnect).
+ "audience": "A String", # Audience to be used when generating OIDC token. The audience claim
+ # identifies the recipients that the JWT is intended for. The audience
+ # value is a single case-sensitive string. Having multiple values (array)
+ # for the audience field is not supported. More info about the OIDC JWT
+ # token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3
+ # Note: if not specified, the Push endpoint URL will be used.
+ "serviceAccountEmail": "A String", # [Service account
+ # email](https://cloud.google.com/iam/docs/service-accounts)
+ # to be used for generating the OIDC token. The caller (for
+ # CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
+ # have the iam.serviceAccounts.actAs permission for the service account.
+ },
},
- "name": "A String", # The name of the subscription. It must have the format
- # `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
- # start with a letter, and contain only letters (`[A-Za-z]`), numbers
- # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
- # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
- # in length, and it must not start with `"goog"`.
}</pre>
</div>
@@ -379,7 +379,7 @@
An object of the form:
{ # A subscription resource.
- "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message
+ "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message
# before the subscriber should acknowledge the message. After message
# delivery but before the ack deadline expires and before the message is
# acknowledged, it is an outstanding message and will not be delivered
@@ -397,29 +397,19 @@
# system will eventually redeliver the message.
#
# If this parameter is 0, a default value of 10 seconds is used.
- "topic": "A String", # The name of the topic from which this subscription is receiving messages.
+ "name": "A String", # The name of the subscription. It must have the format
+ # `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
+ # start with a letter, and contain only letters (`[A-Za-z]`), numbers
+ # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
+ # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
+ # in length, and it must not start with `"goog"`.
+ "topic": "A String", # The name of the topic from which this subscription is receiving messages.
# The value of this field will be `_deleted-topic_` if the topic has been
# deleted.
- "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
+ "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
# used to configure it. An empty `pushConfig` signifies that the subscriber
# will pull and ack messages using API methods.
- "oidcToken": { # Contains information needed for generating an # If specified, Pub/Sub will generate and attach an OIDC JWT token as an
- # `Authorization` header in the HTTP request for every pushed message.
- # [OpenID Connect
- # token](https://developers.google.com/identity/protocols/OpenIDConnect).
- "audience": "A String", # Audience to be used when generating OIDC token. The audience claim
- # identifies the recipients that the JWT is intended for. The audience
- # value is a single case-sensitive string. Having multiple values (array)
- # for the audience field is not supported. More info about the OIDC JWT
- # token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3
- # Note: if not specified, the Push endpoint URL will be used.
- "serviceAccountEmail": "A String", # [Service account
- # email](https://cloud.google.com/iam/docs/service-accounts)
- # to be used for generating the OIDC token. The caller (for
- # CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
- # have the iam.serviceAccounts.actAs permission for the service account.
- },
- "attributes": { # Endpoint configuration attributes.
+ "attributes": { # Endpoint configuration attributes.
#
# Every endpoint has a set of API supported attributes that can be used to
# control different aspects of the message delivery.
@@ -441,17 +431,27 @@
#
# * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.
# * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
- "a_key": "A String",
+ "a_key": "A String",
},
- "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
- # For example, a Webhook endpoint might use "https://example.com/push".
+ "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
+ # For example, a Webhook endpoint might use "https://example.com/push".
+ "oidcToken": { # Contains information needed for generating an # If specified, Pub/Sub will generate and attach an OIDC JWT token as an
+ # `Authorization` header in the HTTP request for every pushed message.
+ # [OpenID Connect
+ # token](https://developers.google.com/identity/protocols/OpenIDConnect).
+ "audience": "A String", # Audience to be used when generating OIDC token. The audience claim
+ # identifies the recipients that the JWT is intended for. The audience
+ # value is a single case-sensitive string. Having multiple values (array)
+ # for the audience field is not supported. More info about the OIDC JWT
+ # token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3
+ # Note: if not specified, the Push endpoint URL will be used.
+ "serviceAccountEmail": "A String", # [Service account
+ # email](https://cloud.google.com/iam/docs/service-accounts)
+ # to be used for generating the OIDC token. The caller (for
+ # CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
+ # have the iam.serviceAccounts.actAs permission for the service account.
+ },
},
- "name": "A String", # The name of the subscription. It must have the format
- # `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
- # start with a letter, and contain only letters (`[A-Za-z]`), numbers
- # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
- # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
- # in length, and it must not start with `"goog"`.
}</pre>
</div>
@@ -472,6 +472,10 @@
Requests for policies with any conditional bindings must specify version 3.
Policies without any conditional bindings may specify any valid value or
leave the field unset.
+
+To learn which resources support conditions in their IAM policies, see the
+[IAM
+documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -490,36 +494,40 @@
# permissions; each `role` can be an IAM predefined role or a user-created
# custom role.
#
- # Optionally, a `binding` can specify a `condition`, which is a logical
- # expression that allows access to a resource only if the expression evaluates
- # to `true`. A condition can add constraints based on attributes of the
- # request, the resource, or both.
+ # For some types of Google Cloud resources, a `binding` can also specify a
+ # `condition`, which is a logical expression that allows access to a resource
+ # only if the expression evaluates to `true`. A condition can add constraints
+ # based on attributes of the request, the resource, or both. To learn which
+ # resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
#
# **JSON example:**
#
# {
- # "bindings": [
+ # "bindings": [
# {
- # "role": "roles/resourcemanager.organizationAdmin",
- # "members": [
- # "user:mike@example.com",
- # "group:admins@example.com",
- # "domain:google.com",
- # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+ # "role": "roles/resourcemanager.organizationAdmin",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
- # "role": "roles/resourcemanager.organizationViewer",
- # "members": ["user:eve@example.com"],
- # "condition": {
- # "title": "expirable access",
- # "description": "Does not grant access after Sep 2020",
- # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": [
+ # "user:eve@example.com"
+ # ],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
# }
# }
# ],
- # "etag": "BwWWja0YfJA=",
- # "version": 3
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
# **YAML example:**
@@ -537,19 +545,71 @@
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
- # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
# - etag: BwWWja0YfJA=
# - version: 3
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ "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`.
+ "role": "A String", # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ #
+ # If the condition evaluates to `true`, then this binding applies to the
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the members in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+ # are documented at https://github.com/google/cel-spec.
+ #
+ # Example (Comparison):
+ #
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # 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:
#
# * `allUsers`: A special identifier that represents anyone who is
@@ -592,55 +652,11 @@
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
- "A String",
+ "A String",
],
- "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.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
- # its purpose. This can be used e.g. in UIs which allow to enter the
- # expression.
- },
},
],
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
# read-modify-write cycle to perform policy updates in order to avoid race
@@ -652,7 +668,7 @@
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
- "version": 42, # Specifies the format of the policy.
+ "version": 42, # Specifies the format of the policy.
#
# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
# are rejected.
@@ -673,19 +689,22 @@
#
# If a policy does not include any conditions, operations on that policy may
# specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(project, pageToken=None, pageSize=None, x__xgafv=None)</code>
<pre>Lists matching subscriptions.
Args:
project: string, The name of the cloud project that subscriptions belong to. (required)
- pageSize: integer, Maximum number of subscriptions to return.
pageToken: string, The value returned by the last `ListSubscriptionsResponse`; indicates that
this is a continuation of a prior `ListSubscriptions` call, and that the
system should return the next page of data.
+ pageSize: integer, Maximum number of subscriptions to return.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -695,12 +714,12 @@
An object of the form:
{ # Response for the `ListSubscriptions` method.
- "nextPageToken": "A String", # If not empty, indicates that there may be more subscriptions that match
+ "nextPageToken": "A String", # If not empty, indicates that there may be more subscriptions that match
# the request; this value should be passed in a new
# `ListSubscriptionsRequest` to get more subscriptions.
- "subscriptions": [ # The subscriptions that match the request.
+ "subscriptions": [ # The subscriptions that match the request.
{ # A subscription resource.
- "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message
+ "ackDeadlineSeconds": 42, # This value is the maximum time after a subscriber receives a message
# before the subscriber should acknowledge the message. After message
# delivery but before the ack deadline expires and before the message is
# acknowledged, it is an outstanding message and will not be delivered
@@ -718,29 +737,19 @@
# system will eventually redeliver the message.
#
# If this parameter is 0, a default value of 10 seconds is used.
- "topic": "A String", # The name of the topic from which this subscription is receiving messages.
+ "name": "A String", # The name of the subscription. It must have the format
+ # `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
+ # start with a letter, and contain only letters (`[A-Za-z]`), numbers
+ # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
+ # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
+ # in length, and it must not start with `"goog"`.
+ "topic": "A String", # The name of the topic from which this subscription is receiving messages.
# The value of this field will be `_deleted-topic_` if the topic has been
# deleted.
- "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
+ "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
# used to configure it. An empty `pushConfig` signifies that the subscriber
# will pull and ack messages using API methods.
- "oidcToken": { # Contains information needed for generating an # If specified, Pub/Sub will generate and attach an OIDC JWT token as an
- # `Authorization` header in the HTTP request for every pushed message.
- # [OpenID Connect
- # token](https://developers.google.com/identity/protocols/OpenIDConnect).
- "audience": "A String", # Audience to be used when generating OIDC token. The audience claim
- # identifies the recipients that the JWT is intended for. The audience
- # value is a single case-sensitive string. Having multiple values (array)
- # for the audience field is not supported. More info about the OIDC JWT
- # token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3
- # Note: if not specified, the Push endpoint URL will be used.
- "serviceAccountEmail": "A String", # [Service account
- # email](https://cloud.google.com/iam/docs/service-accounts)
- # to be used for generating the OIDC token. The caller (for
- # CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
- # have the iam.serviceAccounts.actAs permission for the service account.
- },
- "attributes": { # Endpoint configuration attributes.
+ "attributes": { # Endpoint configuration attributes.
#
# Every endpoint has a set of API supported attributes that can be used to
# control different aspects of the message delivery.
@@ -762,17 +771,27 @@
#
# * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.
# * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
- "a_key": "A String",
+ "a_key": "A String",
},
- "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
- # For example, a Webhook endpoint might use "https://example.com/push".
+ "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
+ # For example, a Webhook endpoint might use "https://example.com/push".
+ "oidcToken": { # Contains information needed for generating an # If specified, Pub/Sub will generate and attach an OIDC JWT token as an
+ # `Authorization` header in the HTTP request for every pushed message.
+ # [OpenID Connect
+ # token](https://developers.google.com/identity/protocols/OpenIDConnect).
+ "audience": "A String", # Audience to be used when generating OIDC token. The audience claim
+ # identifies the recipients that the JWT is intended for. The audience
+ # value is a single case-sensitive string. Having multiple values (array)
+ # for the audience field is not supported. More info about the OIDC JWT
+ # token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3
+ # Note: if not specified, the Push endpoint URL will be used.
+ "serviceAccountEmail": "A String", # [Service account
+ # email](https://cloud.google.com/iam/docs/service-accounts)
+ # to be used for generating the OIDC token. The caller (for
+ # CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
+ # have the iam.serviceAccounts.actAs permission for the service account.
+ },
},
- "name": "A String", # The name of the subscription. It must have the format
- # `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
- # start with a letter, and contain only letters (`[A-Za-z]`), numbers
- # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
- # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
- # in length, and it must not start with `"goog"`.
},
],
}</pre>
@@ -787,7 +806,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
@@ -806,15 +825,15 @@
The object takes the form of:
{ # Request for the ModifyAckDeadline method.
- "ackDeadlineSeconds": 42, # The new ack deadline with respect to the time this request was sent to
+ "ackId": "A String", # The acknowledgment ID. Either this or ack_ids must be populated, but not
+ # both.
+ "ackDeadlineSeconds": 42, # The new ack deadline with respect to the time this request was sent to
# the Pub/Sub system. Must be >= 0. For example, if the value is 10, the new
# ack deadline will expire 10 seconds after the `ModifyAckDeadline` call
# was made. Specifying zero may immediately make the message available for
# another pull request.
- "ackId": "A String", # The acknowledgment ID. Either this or ack_ids must be populated, but not
- # both.
- "ackIds": [ # List of acknowledgment IDs.
- "A String",
+ "ackIds": [ # List of acknowledgment IDs.
+ "A String",
],
}
@@ -853,29 +872,13 @@
The object takes the form of:
{ # Request for the ModifyPushConfig method.
- "pushConfig": { # Configuration for a push delivery endpoint. # The push configuration for future deliveries.
+ "pushConfig": { # Configuration for a push delivery endpoint. # The push configuration for future deliveries.
#
# An empty `pushConfig` indicates that the Pub/Sub system should
# stop pushing messages from the given subscription and allow
# messages to be pulled and acknowledged - effectively pausing
# the subscription if `Pull` is not called.
- "oidcToken": { # Contains information needed for generating an # If specified, Pub/Sub will generate and attach an OIDC JWT token as an
- # `Authorization` header in the HTTP request for every pushed message.
- # [OpenID Connect
- # token](https://developers.google.com/identity/protocols/OpenIDConnect).
- "audience": "A String", # Audience to be used when generating OIDC token. The audience claim
- # identifies the recipients that the JWT is intended for. The audience
- # value is a single case-sensitive string. Having multiple values (array)
- # for the audience field is not supported. More info about the OIDC JWT
- # token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3
- # Note: if not specified, the Push endpoint URL will be used.
- "serviceAccountEmail": "A String", # [Service account
- # email](https://cloud.google.com/iam/docs/service-accounts)
- # to be used for generating the OIDC token. The caller (for
- # CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
- # have the iam.serviceAccounts.actAs permission for the service account.
- },
- "attributes": { # Endpoint configuration attributes.
+ "attributes": { # Endpoint configuration attributes.
#
# Every endpoint has a set of API supported attributes that can be used to
# control different aspects of the message delivery.
@@ -897,10 +900,26 @@
#
# * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.
# * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
- "a_key": "A String",
+ "a_key": "A String",
},
- "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
- # For example, a Webhook endpoint might use "https://example.com/push".
+ "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
+ # For example, a Webhook endpoint might use "https://example.com/push".
+ "oidcToken": { # Contains information needed for generating an # If specified, Pub/Sub will generate and attach an OIDC JWT token as an
+ # `Authorization` header in the HTTP request for every pushed message.
+ # [OpenID Connect
+ # token](https://developers.google.com/identity/protocols/OpenIDConnect).
+ "audience": "A String", # Audience to be used when generating OIDC token. The audience claim
+ # identifies the recipients that the JWT is intended for. The audience
+ # value is a single case-sensitive string. Having multiple values (array)
+ # for the audience field is not supported. More info about the OIDC JWT
+ # token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3
+ # Note: if not specified, the Push endpoint URL will be used.
+ "serviceAccountEmail": "A String", # [Service account
+ # email](https://cloud.google.com/iam/docs/service-accounts)
+ # to be used for generating the OIDC token. The caller (for
+ # CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
+ # have the iam.serviceAccounts.actAs permission for the service account.
+ },
},
}
@@ -937,14 +956,14 @@
The object takes the form of:
{ # Request for the `Pull` method.
- "returnImmediately": True or False, # Optional. If this is specified as true the system will respond immediately even if
+ "returnImmediately": True or False, # Optional. If this is specified as true the system will respond immediately even if
# it is not able to return a message in the `Pull` response. Otherwise the
# system is allowed to wait until at least one message is available rather
# than returning no messages. The client may cancel the request if it does
# not wish to wait any longer for the response. Warning: setting this field
# to `true` is discouraged because it adversely impacts the performance of
# `Pull` operations. We recommend that users do not set this field.
- "maxMessages": 42, # The maximum number of messages returned for this request. The Pub/Sub
+ "maxMessages": 42, # The maximum number of messages returned for this request. The Pub/Sub
# system may return fewer than the number specified.
}
@@ -957,27 +976,27 @@
An object of the form:
{ # Response for the `Pull` method.
- "receivedMessages": [ # Received Pub/Sub messages. The Pub/Sub system will return zero messages if
+ "receivedMessages": [ # Received Pub/Sub messages. The Pub/Sub system will return zero messages if
# there are no more available in the backlog. The Pub/Sub system may return
# fewer than the `maxMessages` requested even if there are more messages
# available in the backlog.
{ # A message and its corresponding acknowledgment ID.
- "ackId": "A String", # This ID can be used to acknowledge the received message.
- "message": { # A message data and its attributes. The message payload must not be empty; # The message.
+ "message": { # A message data and its attributes. The message payload must not be empty; # The message.
# it must contain either a non-empty data field, or at least one attribute.
- "attributes": { # Optional attributes for this message.
- "a_key": "A String",
- },
- "data": "A String", # The message payload. For JSON requests, the value of this field must be
- # [base64-encoded](https://tools.ietf.org/html/rfc4648).
- "publishTime": "A String", # The time at which the message was published, populated by the server when
- # it receives the `Publish` call. It must not be populated by the
- # publisher in a `Publish` call.
- "messageId": "A String", # ID of this message, assigned by the server when the message is published.
+ "messageId": "A String", # ID of this message, assigned by the server when the message is published.
# Guaranteed to be unique within the topic. This value may be read by a
# subscriber that receives a `PubsubMessage` via a `Pull` call or a push
# delivery. It must not be populated by the publisher in a `Publish` call.
+ "attributes": { # Optional attributes for this message.
+ "a_key": "A String",
+ },
+ "publishTime": "A String", # The time at which the message was published, populated by the server when
+ # it receives the `Publish` call. It must not be populated by the
+ # publisher in a `Publish` call.
+ "data": "A String", # The message payload. For JSON requests, the value of this field must be
+ # [base64-encoded](https://tools.ietf.org/html/rfc4648).
},
+ "ackId": "A String", # This ID can be used to acknowledge the received message.
},
],
}</pre>
@@ -988,7 +1007,7 @@
<pre>Sets the access control policy on the specified resource. Replaces any
existing policy.
-Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED
+Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Args:
resource: string, REQUIRED: The resource for which the policy is being specified.
@@ -997,7 +1016,7 @@
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
- "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of
+ "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of
# the policy is limited to a few 10s of KB. An empty policy is a
# valid policy but certain Cloud Platform services (such as Projects)
# might reject them.
@@ -1010,36 +1029,40 @@
# permissions; each `role` can be an IAM predefined role or a user-created
# custom role.
#
- # Optionally, a `binding` can specify a `condition`, which is a logical
- # expression that allows access to a resource only if the expression evaluates
- # to `true`. A condition can add constraints based on attributes of the
- # request, the resource, or both.
+ # For some types of Google Cloud resources, a `binding` can also specify a
+ # `condition`, which is a logical expression that allows access to a resource
+ # only if the expression evaluates to `true`. A condition can add constraints
+ # based on attributes of the request, the resource, or both. To learn which
+ # resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
#
# **JSON example:**
#
# {
- # "bindings": [
+ # "bindings": [
# {
- # "role": "roles/resourcemanager.organizationAdmin",
- # "members": [
- # "user:mike@example.com",
- # "group:admins@example.com",
- # "domain:google.com",
- # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+ # "role": "roles/resourcemanager.organizationAdmin",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
- # "role": "roles/resourcemanager.organizationViewer",
- # "members": ["user:eve@example.com"],
- # "condition": {
- # "title": "expirable access",
- # "description": "Does not grant access after Sep 2020",
- # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": [
+ # "user:eve@example.com"
+ # ],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
# }
# }
# ],
- # "etag": "BwWWja0YfJA=",
- # "version": 3
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
# **YAML example:**
@@ -1057,19 +1080,71 @@
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
- # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
# - etag: BwWWja0YfJA=
# - version: 3
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ "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`.
+ "role": "A String", # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ #
+ # If the condition evaluates to `true`, then this binding applies to the
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the members in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+ # are documented at https://github.com/google/cel-spec.
+ #
+ # Example (Comparison):
+ #
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # 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:
#
# * `allUsers`: A special identifier that represents anyone who is
@@ -1112,55 +1187,11 @@
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
- "A String",
+ "A String",
],
- "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.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
- # its purpose. This can be used e.g. in UIs which allow to enter the
- # expression.
- },
},
],
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
# read-modify-write cycle to perform policy updates in order to avoid race
@@ -1172,7 +1203,7 @@
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
- "version": 42, # Specifies the format of the policy.
+ "version": 42, # Specifies the format of the policy.
#
# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
# are rejected.
@@ -1193,6 +1224,9 @@
#
# If a policy does not include any conditions, operations on that policy may
# specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
},
}
@@ -1214,36 +1248,40 @@
# permissions; each `role` can be an IAM predefined role or a user-created
# custom role.
#
- # Optionally, a `binding` can specify a `condition`, which is a logical
- # expression that allows access to a resource only if the expression evaluates
- # to `true`. A condition can add constraints based on attributes of the
- # request, the resource, or both.
+ # For some types of Google Cloud resources, a `binding` can also specify a
+ # `condition`, which is a logical expression that allows access to a resource
+ # only if the expression evaluates to `true`. A condition can add constraints
+ # based on attributes of the request, the resource, or both. To learn which
+ # resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
#
# **JSON example:**
#
# {
- # "bindings": [
+ # "bindings": [
# {
- # "role": "roles/resourcemanager.organizationAdmin",
- # "members": [
- # "user:mike@example.com",
- # "group:admins@example.com",
- # "domain:google.com",
- # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+ # "role": "roles/resourcemanager.organizationAdmin",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
- # "role": "roles/resourcemanager.organizationViewer",
- # "members": ["user:eve@example.com"],
- # "condition": {
- # "title": "expirable access",
- # "description": "Does not grant access after Sep 2020",
- # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": [
+ # "user:eve@example.com"
+ # ],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
# }
# }
# ],
- # "etag": "BwWWja0YfJA=",
- # "version": 3
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
# **YAML example:**
@@ -1261,19 +1299,71 @@
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
- # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
# - etag: BwWWja0YfJA=
# - version: 3
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ "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`.
+ "role": "A String", # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ #
+ # If the condition evaluates to `true`, then this binding applies to the
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the members in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+ # are documented at https://github.com/google/cel-spec.
+ #
+ # Example (Comparison):
+ #
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # 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:
#
# * `allUsers`: A special identifier that represents anyone who is
@@ -1316,55 +1406,11 @@
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
- "A String",
+ "A String",
],
- "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.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
- # its purpose. This can be used e.g. in UIs which allow to enter the
- # expression.
- },
},
],
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
# read-modify-write cycle to perform policy updates in order to avoid race
@@ -1376,7 +1422,7 @@
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
- "version": 42, # Specifies the format of the policy.
+ "version": 42, # Specifies the format of the policy.
#
# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
# are rejected.
@@ -1397,6 +1443,9 @@
#
# If a policy does not include any conditions, operations on that policy may
# specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}</pre>
</div>
@@ -1404,11 +1453,11 @@
<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
<pre>Returns permissions that a caller has on the specified resource.
If the resource does not exist, this will return an empty set of
-permissions, not a NOT_FOUND error.
+permissions, not a `NOT_FOUND` error.
Note: This operation is designed to be used for building permission-aware
UIs and command-line tools, not for authorization checking. This operation
-may "fail open" without warning.
+may "fail open" without warning.
Args:
resource: string, REQUIRED: The resource for which the policy detail is being requested.
@@ -1417,11 +1466,11 @@
The object takes the form of:
{ # Request message for `TestIamPermissions` method.
- "permissions": [ # The set of permissions to check for the `resource`. Permissions with
- # wildcards (such as '*' or 'storage.*') are not allowed. For more
+ "permissions": [ # The set of permissions to check for the `resource`. Permissions with
+ # wildcards (such as '*' or 'storage.*') are not allowed. For more
# information see
# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
- "A String",
+ "A String",
],
}
@@ -1434,9 +1483,9 @@
An object of the form:
{ # Response message for `TestIamPermissions` method.
- "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
# allowed.
- "A String",
+ "A String",
],
}</pre>
</div>