| <html><body> | |
| <style> | |
| body, h1, h2, h3, div, span, p, pre, a { | |
| margin: 0; | |
| padding: 0; | |
| border: 0; | |
| font-weight: inherit; | |
| font-style: inherit; | |
| font-size: 100%; | |
| font-family: inherit; | |
| vertical-align: baseline; | |
| } | |
| body { | |
| font-size: 13px; | |
| padding: 1em; | |
| } | |
| h1 { | |
| font-size: 26px; | |
| margin-bottom: 1em; | |
| } | |
| h2 { | |
| font-size: 24px; | |
| margin-bottom: 1em; | |
| } | |
| h3 { | |
| font-size: 20px; | |
| margin-bottom: 1em; | |
| margin-top: 1em; | |
| } | |
| pre, code { | |
| line-height: 1.5; | |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; | |
| } | |
| pre { | |
| margin-top: 0.5em; | |
| } | |
| h1, h2, h3, p { | |
| font-family: Arial, sans serif; | |
| } | |
| h1, h2, h3 { | |
| border-bottom: solid #CCC 1px; | |
| } | |
| .toc_element { | |
| margin-top: 0.5em; | |
| } | |
| .firstline { | |
| margin-left: 2 em; | |
| } | |
| .method { | |
| margin-top: 1em; | |
| border: solid 1px #CCC; | |
| padding: 1em; | |
| background: #EEE; | |
| } | |
| .details { | |
| font-weight: bold; | |
| font-size: 14px; | |
| } | |
| </style> | |
| <h1><a href="pubsub_v1beta2.html">Cloud Pub/Sub API</a> . <a href="pubsub_v1beta2.projects.html">projects</a> . <a href="pubsub_v1beta2.projects.subscriptions.html">subscriptions</a></h1> | |
| <h2>Instance Methods</h2> | |
| <p class="toc_element"> | |
| <code><a href="#acknowledge">acknowledge(subscription, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Acknowledges the messages associated with the `ack_ids` in the</p> | |
| <p class="toc_element"> | |
| <code><a href="#create">create(name, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Creates a subscription to a given topic.</p> | |
| <p class="toc_element"> | |
| <code><a href="#delete">delete(subscription, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Deletes an existing subscription. All pending messages in the subscription</p> | |
| <p class="toc_element"> | |
| <code><a href="#get">get(subscription, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Gets the configuration details of a subscription.</p> | |
| <p class="toc_element"> | |
| <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> | |
| <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> | |
| <p class="firstline">Retrieves the next page of results.</p> | |
| <p class="toc_element"> | |
| <code><a href="#modifyAckDeadline">modifyAckDeadline(subscription, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Modifies the ack deadline for a specific message. This method is useful</p> | |
| <p class="toc_element"> | |
| <code><a href="#modifyPushConfig">modifyPushConfig(subscription, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Modifies the `PushConfig` for a specified subscription.</p> | |
| <p class="toc_element"> | |
| <code><a href="#pull">pull(subscription, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Pulls messages from the server. Returns an empty list if there are no</p> | |
| <p class="toc_element"> | |
| <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Sets the access control policy on the specified resource. Replaces any</p> | |
| <p class="toc_element"> | |
| <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Returns permissions that a caller has on the specified resource.</p> | |
| <h3>Method Details</h3> | |
| <div class="method"> | |
| <code class="details" id="acknowledge">acknowledge(subscription, body=None, x__xgafv=None)</code> | |
| <pre>Acknowledges the messages associated with the `ack_ids` in the | |
| `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages | |
| from the subscription. | |
| Acknowledging a message whose ack deadline has expired may succeed, | |
| but such a message may be redelivered later. Acknowledging a message more | |
| than once will not result in an error. | |
| Args: | |
| subscription: string, The subscription whose message is being acknowledged. (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # Request for the Acknowledge method. | |
| "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", | |
| ], | |
| } | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # A generic empty message that you can re-use to avoid defining duplicated | |
| # empty messages in your APIs. A typical example is to use it as the request | |
| # or the response type of an API method. For instance: | |
| # | |
| # service Foo { | |
| # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); | |
| # } | |
| # | |
| # The JSON representation for `Empty` is empty JSON object `{}`. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <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 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 | |
| for REST API requests, you must specify a name. | |
| Args: | |
| name: 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"`. (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 | |
| # 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 | |
| # again during that time (on a best-effort basis). | |
| # | |
| # For pull subscriptions, this value is used as the initial value for the ack | |
| # deadline. To override this value for a given message, call | |
| # `ModifyAckDeadline` with the corresponding `ack_id` if using pull. | |
| # The maximum custom deadline you can specify is 600 seconds (10 minutes). | |
| # | |
| # For push delivery, this value is also used to set the request timeout for | |
| # the call to the push endpoint. | |
| # | |
| # If the subscriber never acknowledges the message, the Pub/Sub | |
| # 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. | |
| # 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 | |
| # 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. | |
| # | |
| # Every endpoint has a set of API supported attributes that can be used to | |
| # control different aspects of the message delivery. | |
| # | |
| # The currently supported attribute is `x-goog-version`, which you can | |
| # use to change the format of the push message. This attribute | |
| # indicates the version of the data expected by the endpoint. This | |
| # controls the shape of the envelope (i.e. its fields and metadata). | |
| # The endpoint version is based on the version of the Pub/Sub | |
| # API. | |
| # | |
| # If not present during the `CreateSubscription` call, it will default to | |
| # the version of the API used to make such call. If not present during a | |
| # `ModifyPushConfig` call, its value will not be changed. `GetSubscription` | |
| # calls will always return a valid version, even if the subscription was | |
| # created without this attribute. | |
| # | |
| # The possible values for this attribute are: | |
| # | |
| # * `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", | |
| }, | |
| "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". | |
| }, | |
| "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. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # A subscription resource. | |
| "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 | |
| # again during that time (on a best-effort basis). | |
| # | |
| # For pull subscriptions, this value is used as the initial value for the ack | |
| # deadline. To override this value for a given message, call | |
| # `ModifyAckDeadline` with the corresponding `ack_id` if using pull. | |
| # The maximum custom deadline you can specify is 600 seconds (10 minutes). | |
| # | |
| # For push delivery, this value is also used to set the request timeout for | |
| # the call to the push endpoint. | |
| # | |
| # If the subscriber never acknowledges the message, the Pub/Sub | |
| # 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. | |
| # 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 | |
| # 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. | |
| # | |
| # Every endpoint has a set of API supported attributes that can be used to | |
| # control different aspects of the message delivery. | |
| # | |
| # The currently supported attribute is `x-goog-version`, which you can | |
| # use to change the format of the push message. This attribute | |
| # indicates the version of the data expected by the endpoint. This | |
| # controls the shape of the envelope (i.e. its fields and metadata). | |
| # The endpoint version is based on the version of the Pub/Sub | |
| # API. | |
| # | |
| # If not present during the `CreateSubscription` call, it will default to | |
| # the version of the API used to make such call. If not present during a | |
| # `ModifyPushConfig` call, its value will not be changed. `GetSubscription` | |
| # calls will always return a valid version, even if the subscription was | |
| # created without this attribute. | |
| # | |
| # The possible values for this attribute are: | |
| # | |
| # * `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", | |
| }, | |
| "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". | |
| }, | |
| "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> | |
| <div class="method"> | |
| <code class="details" id="delete">delete(subscription, x__xgafv=None)</code> | |
| <pre>Deletes an existing subscription. All pending messages in the subscription | |
| are immediately dropped. Calls to `Pull` after deletion will return | |
| `NOT_FOUND`. After a subscription is deleted, a new one may be created with | |
| the same name, but the new one has no association with the old | |
| subscription, or its topic unless the same topic is specified. | |
| Args: | |
| subscription: string, The subscription to delete. (required) | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # A generic empty message that you can re-use to avoid defining duplicated | |
| # empty messages in your APIs. A typical example is to use it as the request | |
| # or the response type of an API method. For instance: | |
| # | |
| # service Foo { | |
| # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); | |
| # } | |
| # | |
| # The JSON representation for `Empty` is empty JSON object `{}`. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="get">get(subscription, x__xgafv=None)</code> | |
| <pre>Gets the configuration details of a subscription. | |
| Args: | |
| subscription: string, The name of the subscription to get. (required) | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # A subscription resource. | |
| "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 | |
| # again during that time (on a best-effort basis). | |
| # | |
| # For pull subscriptions, this value is used as the initial value for the ack | |
| # deadline. To override this value for a given message, call | |
| # `ModifyAckDeadline` with the corresponding `ack_id` if using pull. | |
| # The maximum custom deadline you can specify is 600 seconds (10 minutes). | |
| # | |
| # For push delivery, this value is also used to set the request timeout for | |
| # the call to the push endpoint. | |
| # | |
| # If the subscriber never acknowledges the message, the Pub/Sub | |
| # 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. | |
| # 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 | |
| # 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. | |
| # | |
| # Every endpoint has a set of API supported attributes that can be used to | |
| # control different aspects of the message delivery. | |
| # | |
| # The currently supported attribute is `x-goog-version`, which you can | |
| # use to change the format of the push message. This attribute | |
| # indicates the version of the data expected by the endpoint. This | |
| # controls the shape of the envelope (i.e. its fields and metadata). | |
| # The endpoint version is based on the version of the Pub/Sub | |
| # API. | |
| # | |
| # If not present during the `CreateSubscription` call, it will default to | |
| # the version of the API used to make such call. If not present during a | |
| # `ModifyPushConfig` call, its value will not be changed. `GetSubscription` | |
| # calls will always return a valid version, even if the subscription was | |
| # created without this attribute. | |
| # | |
| # The possible values for this attribute are: | |
| # | |
| # * `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", | |
| }, | |
| "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". | |
| }, | |
| "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> | |
| <div class="method"> | |
| <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code> | |
| <pre>Gets the access control policy for a resource. | |
| Returns an empty policy if the resource exists and does not have a policy | |
| set. | |
| Args: | |
| resource: string, REQUIRED: The resource for which the policy is being requested. | |
| See the operation documentation for the appropriate value for this field. (required) | |
| options_requestedPolicyVersion: integer, 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. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # An Identity and Access Management (IAM) policy, which specifies access | |
| # controls for Google Cloud resources. | |
| # | |
| # | |
| # 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. | |
| # | |
| # 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/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')", | |
| # } | |
| # } | |
| # ], | |
| # "etag": "BwWWja0YfJA=", | |
| # "version": 3 | |
| # } | |
| # | |
| # **YAML example:** | |
| # | |
| # bindings: | |
| # - 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: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 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`. | |
| "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 | |
| # on the internet; with or without a Google account. | |
| # | |
| # * `allAuthenticatedUsers`: A special identifier that represents anyone | |
| # 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@example.com` . | |
| # | |
| # | |
| # * `serviceAccount:{emailid}`: An email address that represents a service | |
| # account. For example, `my-other-app@appspot.gserviceaccount.com`. | |
| # | |
| # * `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 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 | |
| # prevent simultaneous updates of a policy from overwriting each other. | |
| # It is strongly suggested that systems make use of the `etag` in the | |
| # read-modify-write cycle to perform policy updates in order to avoid race | |
| # conditions: An `etag` is returned in the response to `getIamPolicy`, and | |
| # systems are expected to put that etag in the request to `setIamPolicy` to | |
| # ensure that their change will be applied to the same version of the policy. | |
| # | |
| # **Important:** If you use IAM Conditions, you must include the `etag` field | |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows | |
| # you to overwrite a version `3` policy with a version `1` policy, and all of | |
| # the conditions in the version `3` policy are lost. | |
| "version": 42, # Specifies the format of the policy. | |
| # | |
| # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value | |
| # are rejected. | |
| # | |
| # Any operation that affects conditional role bindings must specify version | |
| # `3`. This requirement applies to the following operations: | |
| # | |
| # * Getting a policy that includes a conditional role binding | |
| # * Adding a conditional role binding to a policy | |
| # * Changing a conditional role binding in a policy | |
| # * Removing any role binding, with or without a condition, from a policy | |
| # that includes conditions | |
| # | |
| # **Important:** If you use IAM Conditions, you must include the `etag` field | |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows | |
| # you to overwrite a version `3` policy with a version `1` policy, and all of | |
| # the conditions in the version `3` policy are lost. | |
| # | |
| # If a policy does not include any conditions, operations on that policy may | |
| # specify any valid version or leave the field unset. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list">list(project, pageSize=None, pageToken=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. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| 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 | |
| # the request; this value should be passed in a new | |
| # `ListSubscriptionsRequest` to get more subscriptions. | |
| "subscriptions": [ # The subscriptions that match the request. | |
| { # A subscription resource. | |
| "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 | |
| # again during that time (on a best-effort basis). | |
| # | |
| # For pull subscriptions, this value is used as the initial value for the ack | |
| # deadline. To override this value for a given message, call | |
| # `ModifyAckDeadline` with the corresponding `ack_id` if using pull. | |
| # The maximum custom deadline you can specify is 600 seconds (10 minutes). | |
| # | |
| # For push delivery, this value is also used to set the request timeout for | |
| # the call to the push endpoint. | |
| # | |
| # If the subscriber never acknowledges the message, the Pub/Sub | |
| # 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. | |
| # 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 | |
| # 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. | |
| # | |
| # Every endpoint has a set of API supported attributes that can be used to | |
| # control different aspects of the message delivery. | |
| # | |
| # The currently supported attribute is `x-goog-version`, which you can | |
| # use to change the format of the push message. This attribute | |
| # indicates the version of the data expected by the endpoint. This | |
| # controls the shape of the envelope (i.e. its fields and metadata). | |
| # The endpoint version is based on the version of the Pub/Sub | |
| # API. | |
| # | |
| # If not present during the `CreateSubscription` call, it will default to | |
| # the version of the API used to make such call. If not present during a | |
| # `ModifyPushConfig` call, its value will not be changed. `GetSubscription` | |
| # calls will always return a valid version, even if the subscription was | |
| # created without this attribute. | |
| # | |
| # The possible values for this attribute are: | |
| # | |
| # * `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", | |
| }, | |
| "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". | |
| }, | |
| "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> | |
| <div class="method"> | |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> | |
| <pre>Retrieves the next page of results. | |
| Args: | |
| previous_request: The request for the previous page. (required) | |
| 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 | |
| page. Returns None if there are no more items in the collection. | |
| </pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="modifyAckDeadline">modifyAckDeadline(subscription, body=None, x__xgafv=None)</code> | |
| <pre>Modifies the ack deadline for a specific message. This method is useful | |
| to indicate that more time is needed to process a message by the | |
| subscriber, or to make the message available for redelivery if the | |
| processing was interrupted. Note that this does not modify the | |
| subscription-level `ackDeadlineSeconds` used for subsequent messages. | |
| Args: | |
| subscription: string, The name of the subscription. (required) | |
| body: object, The request body. | |
| 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 | |
| # 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", | |
| ], | |
| } | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # A generic empty message that you can re-use to avoid defining duplicated | |
| # empty messages in your APIs. A typical example is to use it as the request | |
| # or the response type of an API method. For instance: | |
| # | |
| # service Foo { | |
| # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); | |
| # } | |
| # | |
| # The JSON representation for `Empty` is empty JSON object `{}`. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="modifyPushConfig">modifyPushConfig(subscription, body=None, x__xgafv=None)</code> | |
| <pre>Modifies the `PushConfig` for a specified subscription. | |
| This may be used to change a push subscription to a pull one (signified by | |
| an empty `PushConfig`) or vice versa, or change the endpoint URL and other | |
| attributes of a push subscription. Messages will accumulate for delivery | |
| continuously through the call regardless of changes to the `PushConfig`. | |
| Args: | |
| subscription: string, The name of the subscription. (required) | |
| body: object, The request body. | |
| The object takes the form of: | |
| { # Request for the ModifyPushConfig method. | |
| "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. | |
| # | |
| # Every endpoint has a set of API supported attributes that can be used to | |
| # control different aspects of the message delivery. | |
| # | |
| # The currently supported attribute is `x-goog-version`, which you can | |
| # use to change the format of the push message. This attribute | |
| # indicates the version of the data expected by the endpoint. This | |
| # controls the shape of the envelope (i.e. its fields and metadata). | |
| # The endpoint version is based on the version of the Pub/Sub | |
| # API. | |
| # | |
| # If not present during the `CreateSubscription` call, it will default to | |
| # the version of the API used to make such call. If not present during a | |
| # `ModifyPushConfig` call, its value will not be changed. `GetSubscription` | |
| # calls will always return a valid version, even if the subscription was | |
| # created without this attribute. | |
| # | |
| # The possible values for this attribute are: | |
| # | |
| # * `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", | |
| }, | |
| "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". | |
| }, | |
| } | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # A generic empty message that you can re-use to avoid defining duplicated | |
| # empty messages in your APIs. A typical example is to use it as the request | |
| # or the response type of an API method. For instance: | |
| # | |
| # service Foo { | |
| # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); | |
| # } | |
| # | |
| # The JSON representation for `Empty` is empty JSON object `{}`. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="pull">pull(subscription, body=None, x__xgafv=None)</code> | |
| <pre>Pulls messages from the server. Returns an empty list if there are no | |
| messages available in the backlog. The server may return `UNAVAILABLE` if | |
| there are too many concurrent pull requests pending for the given | |
| subscription. | |
| Args: | |
| subscription: string, The subscription from which messages should be pulled. (required) | |
| body: object, The request body. | |
| 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 | |
| # 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 | |
| # system may return fewer than the number specified. | |
| } | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Response for the `Pull` method. | |
| "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. | |
| # 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. | |
| # 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. | |
| }, | |
| }, | |
| ], | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code> | |
| <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 | |
| 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. | |
| 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 | |
| # 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. | |
| # controls for Google Cloud resources. | |
| # | |
| # | |
| # 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. | |
| # | |
| # 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/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')", | |
| # } | |
| # } | |
| # ], | |
| # "etag": "BwWWja0YfJA=", | |
| # "version": 3 | |
| # } | |
| # | |
| # **YAML example:** | |
| # | |
| # bindings: | |
| # - 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: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 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`. | |
| "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 | |
| # on the internet; with or without a Google account. | |
| # | |
| # * `allAuthenticatedUsers`: A special identifier that represents anyone | |
| # 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@example.com` . | |
| # | |
| # | |
| # * `serviceAccount:{emailid}`: An email address that represents a service | |
| # account. For example, `my-other-app@appspot.gserviceaccount.com`. | |
| # | |
| # * `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 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 | |
| # prevent simultaneous updates of a policy from overwriting each other. | |
| # It is strongly suggested that systems make use of the `etag` in the | |
| # read-modify-write cycle to perform policy updates in order to avoid race | |
| # conditions: An `etag` is returned in the response to `getIamPolicy`, and | |
| # systems are expected to put that etag in the request to `setIamPolicy` to | |
| # ensure that their change will be applied to the same version of the policy. | |
| # | |
| # **Important:** If you use IAM Conditions, you must include the `etag` field | |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows | |
| # you to overwrite a version `3` policy with a version `1` policy, and all of | |
| # the conditions in the version `3` policy are lost. | |
| "version": 42, # Specifies the format of the policy. | |
| # | |
| # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value | |
| # are rejected. | |
| # | |
| # Any operation that affects conditional role bindings must specify version | |
| # `3`. This requirement applies to the following operations: | |
| # | |
| # * Getting a policy that includes a conditional role binding | |
| # * Adding a conditional role binding to a policy | |
| # * Changing a conditional role binding in a policy | |
| # * Removing any role binding, with or without a condition, from a policy | |
| # that includes conditions | |
| # | |
| # **Important:** If you use IAM Conditions, you must include the `etag` field | |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows | |
| # you to overwrite a version `3` policy with a version `1` policy, and all of | |
| # the conditions in the version `3` policy are lost. | |
| # | |
| # If a policy does not include any conditions, operations on that policy may | |
| # specify any valid version or leave the field unset. | |
| }, | |
| } | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # An Identity and Access Management (IAM) policy, which specifies access | |
| # controls for Google Cloud resources. | |
| # | |
| # | |
| # 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. | |
| # | |
| # 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/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')", | |
| # } | |
| # } | |
| # ], | |
| # "etag": "BwWWja0YfJA=", | |
| # "version": 3 | |
| # } | |
| # | |
| # **YAML example:** | |
| # | |
| # bindings: | |
| # - 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: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 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`. | |
| "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 | |
| # on the internet; with or without a Google account. | |
| # | |
| # * `allAuthenticatedUsers`: A special identifier that represents anyone | |
| # 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@example.com` . | |
| # | |
| # | |
| # * `serviceAccount:{emailid}`: An email address that represents a service | |
| # account. For example, `my-other-app@appspot.gserviceaccount.com`. | |
| # | |
| # * `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 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 | |
| # prevent simultaneous updates of a policy from overwriting each other. | |
| # It is strongly suggested that systems make use of the `etag` in the | |
| # read-modify-write cycle to perform policy updates in order to avoid race | |
| # conditions: An `etag` is returned in the response to `getIamPolicy`, and | |
| # systems are expected to put that etag in the request to `setIamPolicy` to | |
| # ensure that their change will be applied to the same version of the policy. | |
| # | |
| # **Important:** If you use IAM Conditions, you must include the `etag` field | |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows | |
| # you to overwrite a version `3` policy with a version `1` policy, and all of | |
| # the conditions in the version `3` policy are lost. | |
| "version": 42, # Specifies the format of the policy. | |
| # | |
| # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value | |
| # are rejected. | |
| # | |
| # Any operation that affects conditional role bindings must specify version | |
| # `3`. This requirement applies to the following operations: | |
| # | |
| # * Getting a policy that includes a conditional role binding | |
| # * Adding a conditional role binding to a policy | |
| # * Changing a conditional role binding in a policy | |
| # * Removing any role binding, with or without a condition, from a policy | |
| # that includes conditions | |
| # | |
| # **Important:** If you use IAM Conditions, you must include the `etag` field | |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows | |
| # you to overwrite a version `3` policy with a version `1` policy, and all of | |
| # the conditions in the version `3` policy are lost. | |
| # | |
| # If a policy does not include any conditions, operations on that policy may | |
| # specify any valid version or leave the field unset. | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <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. | |
| 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. | |
| 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. | |
| 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 | |
| # information see | |
| # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). | |
| "A String", | |
| ], | |
| } | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # Response message for `TestIamPermissions` method. | |
| "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is | |
| # allowed. | |
| "A String", | |
| ], | |
| }</pre> | |
| </div> | |
| </body></html> |