create(name=None, body=None, x__xgafv=None)
Creates a snapshot from the requested subscription. Snapshots are used in
delete(snapshot=None, x__xgafv=None)
Removes an existing snapshot. Snapshots are used in
get(snapshot=None, x__xgafv=None)
Gets the configuration details of a snapshot. Snapshots are used in
getIamPolicy(resource=None, options_requestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for a resource.
list(project=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists the existing snapshots. Snapshots are used in
list_next(previous_request=*, previous_response=*)
Retrieves the next page of results.
patch(name=*, body=None, x__xgafv=None)
Updates an existing snapshot. Snapshots are used in
setIamPolicy(resource=None, body=None, x__xgafv=None)
Sets the access control policy on the specified resource. Replaces any
testIamPermissions(resource=None, body=None, x__xgafv=None)
Returns permissions that a caller has on the specified resource.
create(name=None, body=None, x__xgafv=None)
Creates a snapshot from the requested subscription. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. <br><br>If the snapshot already exists, returns `ALREADY_EXISTS`. If the requested subscription doesn't exist, returns `NOT_FOUND`. If the backlog in the subscription is too old -- and the resulting snapshot would expire in less than 1 hour -- then `FAILED_PRECONDITION` is returned. See also the `Snapshot.expire_time` field. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription, conforming to the [resource name format](https://cloud.google.com/pubsub/docs/admin#resource_names). The generated name is populated in the returned Snapshot object. Note that for REST API requests, you must specify a name in the request. Args: name: string, Required. User-provided name for this snapshot. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription. Note that for REST API requests, you must specify a name. See the <a href="https://cloud.google.com/pubsub/docs/admin#resource_names"> resource name rules</a>. Format is `projects/{project}/snapshots/{snap}`. (required) body: object, The request body. The object takes the form of: { # Request for the `CreateSnapshot` method. "labels": { # See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and # managing labels</a>. "a_key": "A String", }, "subscription": "A String", # Required. The subscription whose backlog the snapshot retains. # Specifically, the created snapshot is guaranteed to retain: # (a) The existing backlog on the subscription. More precisely, this is # defined as the messages in the subscription's backlog that are # unacknowledged upon the successful completion of the # `CreateSnapshot` request; as well as: # (b) Any messages published to the subscription's topic following the # successful completion of the CreateSnapshot request. # Format is `projects/{project}/subscriptions/{sub}`. } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # A snapshot resource. Snapshots are used in # <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> # operations, which allow # you to manage message acknowledgments in bulk. That is, you can set the # acknowledgment state of messages in an existing subscription to the state # captured by a snapshot. "topic": "A String", # The name of the topic from which this snapshot is retaining messages. "expireTime": "A String", # The snapshot is guaranteed to exist up until this time. # A newly-created snapshot expires no later than 7 days from the time of its # creation. Its exact lifetime is determined at creation by the existing # backlog in the source subscription. Specifically, the lifetime of the # snapshot is `7 days - (age of oldest unacked message in the subscription)`. # For example, consider a subscription whose oldest unacked message is 3 days # old. If a snapshot is created from this subscription, the snapshot -- which # will always capture this 3-day-old backlog as long as the snapshot # exists -- will expire in 4 days. The service will refuse to create a # snapshot that would expire in less than 1 hour after creation. "labels": { # See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and # managing labels</a>. "a_key": "A String", }, "name": "A String", # The name of the snapshot. }
delete(snapshot=None, x__xgafv=None)
Removes an existing snapshot. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.<br><br> When the snapshot is deleted, all messages retained in the snapshot are immediately dropped. After a snapshot is deleted, a new one may be created with the same name, but the new one has no association with the old snapshot or its subscription, unless the same subscription is specified. Args: snapshot: string, Required. The name of the snapshot to delete. Format is `projects/{project}/snapshots/{snap}`. (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 `{}`. }
get(snapshot=None, x__xgafv=None)
Gets the configuration details of a snapshot. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. Args: snapshot: string, Required. The name of the snapshot to get. Format is `projects/{project}/snapshots/{snap}`. (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # A snapshot resource. Snapshots are used in # <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> # operations, which allow # you to manage message acknowledgments in bulk. That is, you can set the # acknowledgment state of messages in an existing subscription to the state # captured by a snapshot. "topic": "A String", # The name of the topic from which this snapshot is retaining messages. "expireTime": "A String", # The snapshot is guaranteed to exist up until this time. # A newly-created snapshot expires no later than 7 days from the time of its # creation. Its exact lifetime is determined at creation by the existing # backlog in the source subscription. Specifically, the lifetime of the # snapshot is `7 days - (age of oldest unacked message in the subscription)`. # For example, consider a subscription whose oldest unacked message is 3 days # old. If a snapshot is created from this subscription, the snapshot -- which # will always capture this 3-day-old backlog as long as the snapshot # exists -- will expire in 4 days. The service will refuse to create a # snapshot that would expire in less than 1 hour after creation. "labels": { # See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and # managing labels</a>. "a_key": "A String", }, "name": "A String", # The name of the snapshot. }
getIamPolicy(resource=None, options_requestedPolicyVersion=None, x__xgafv=None)
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`. "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. }, "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", ], }, ], "version": 42, # Specifies the format of the policy. # # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value # are rejected. # # Any operation that affects conditional role bindings must specify version # `3`. This requirement applies to the following operations: # # * Getting a policy that includes a conditional role binding # * Adding a conditional role binding to a policy # * Changing a conditional role binding in a policy # * Removing any role binding, with or without a condition, from a policy # that includes conditions # # **Important:** If you use IAM Conditions, you must include the `etag` field # whenever you call `setIamPolicy`. If you omit this field, then IAM allows # you to overwrite a version `3` policy with a version `1` policy, and all of # the conditions in the version `3` policy are lost. # # If a policy does not include any conditions, operations on that policy may # specify any valid version or leave the field unset. "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help # prevent simultaneous updates of a policy from overwriting each other. # It is strongly suggested that systems make use of the `etag` in the # 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. }
list(project=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists the existing snapshots. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. Args: project: string, Required. The name of the project in which to list snapshots. Format is `projects/{project-id}`. (required) pageSize: integer, Maximum number of snapshots to return. pageToken: string, The value returned by the last `ListSnapshotsResponse`; indicates that this is a continuation of a prior `ListSnapshots` 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 `ListSnapshots` method. "nextPageToken": "A String", # If not empty, indicates that there may be more snapshot that match the # request; this value should be passed in a new `ListSnapshotsRequest`. "snapshots": [ # The resulting snapshots. { # A snapshot resource. Snapshots are used in # <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> # operations, which allow # you to manage message acknowledgments in bulk. That is, you can set the # acknowledgment state of messages in an existing subscription to the state # captured by a snapshot. "topic": "A String", # The name of the topic from which this snapshot is retaining messages. "expireTime": "A String", # The snapshot is guaranteed to exist up until this time. # A newly-created snapshot expires no later than 7 days from the time of its # creation. Its exact lifetime is determined at creation by the existing # backlog in the source subscription. Specifically, the lifetime of the # snapshot is `7 days - (age of oldest unacked message in the subscription)`. # For example, consider a subscription whose oldest unacked message is 3 days # old. If a snapshot is created from this subscription, the snapshot -- which # will always capture this 3-day-old backlog as long as the snapshot # exists -- will expire in 4 days. The service will refuse to create a # snapshot that would expire in less than 1 hour after creation. "labels": { # See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and # managing labels</a>. "a_key": "A String", }, "name": "A String", # The name of the snapshot. }, ], }
list_next(previous_request=*, previous_response=*)
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.
patch(name=*, body=None, x__xgafv=None)
Updates an existing snapshot. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. Args: name: string, The name of the snapshot. (required) body: object, The request body. The object takes the form of: { # Request for the UpdateSnapshot method. "snapshot": { # A snapshot resource. Snapshots are used in # Required. The updated snapshot object. # <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> # operations, which allow # you to manage message acknowledgments in bulk. That is, you can set the # acknowledgment state of messages in an existing subscription to the state # captured by a snapshot. "topic": "A String", # The name of the topic from which this snapshot is retaining messages. "expireTime": "A String", # The snapshot is guaranteed to exist up until this time. # A newly-created snapshot expires no later than 7 days from the time of its # creation. Its exact lifetime is determined at creation by the existing # backlog in the source subscription. Specifically, the lifetime of the # snapshot is `7 days - (age of oldest unacked message in the subscription)`. # For example, consider a subscription whose oldest unacked message is 3 days # old. If a snapshot is created from this subscription, the snapshot -- which # will always capture this 3-day-old backlog as long as the snapshot # exists -- will expire in 4 days. The service will refuse to create a # snapshot that would expire in less than 1 hour after creation. "labels": { # See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and # managing labels</a>. "a_key": "A String", }, "name": "A String", # The name of the snapshot. }, "updateMask": "A String", # Required. Indicates which fields in the provided snapshot to update. # Must be specified and non-empty. } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # A snapshot resource. Snapshots are used in # <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> # operations, which allow # you to manage message acknowledgments in bulk. That is, you can set the # acknowledgment state of messages in an existing subscription to the state # captured by a snapshot. "topic": "A String", # The name of the topic from which this snapshot is retaining messages. "expireTime": "A String", # The snapshot is guaranteed to exist up until this time. # A newly-created snapshot expires no later than 7 days from the time of its # creation. Its exact lifetime is determined at creation by the existing # backlog in the source subscription. Specifically, the lifetime of the # snapshot is `7 days - (age of oldest unacked message in the subscription)`. # For example, consider a subscription whose oldest unacked message is 3 days # old. If a snapshot is created from this subscription, the snapshot -- which # will always capture this 3-day-old backlog as long as the snapshot # exists -- will expire in 4 days. The service will refuse to create a # snapshot that would expire in less than 1 hour after creation. "labels": { # See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and # managing labels</a>. "a_key": "A String", }, "name": "A String", # The name of the snapshot. }
setIamPolicy(resource=None, body=None, x__xgafv=None)
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`. "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. }, "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", ], }, ], "version": 42, # Specifies the format of the policy. # # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value # are rejected. # # Any operation that affects conditional role bindings must specify version # `3`. This requirement applies to the following operations: # # * Getting a policy that includes a conditional role binding # * Adding a conditional role binding to a policy # * Changing a conditional role binding in a policy # * Removing any role binding, with or without a condition, from a policy # that includes conditions # # **Important:** If you use IAM Conditions, you must include the `etag` field # whenever you call `setIamPolicy`. If you omit this field, then IAM allows # you to overwrite a version `3` policy with a version `1` policy, and all of # the conditions in the version `3` policy are lost. # # If a policy does not include any conditions, operations on that policy may # specify any valid version or leave the field unset. "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help # prevent simultaneous updates of a policy from overwriting each other. # It is strongly suggested that systems make use of the `etag` in the # 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. }, } 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`. "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. }, "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", ], }, ], "version": 42, # Specifies the format of the policy. # # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value # are rejected. # # Any operation that affects conditional role bindings must specify version # `3`. This requirement applies to the following operations: # # * Getting a policy that includes a conditional role binding # * Adding a conditional role binding to a policy # * Changing a conditional role binding in a policy # * Removing any role binding, with or without a condition, from a policy # that includes conditions # # **Important:** If you use IAM Conditions, you must include the `etag` field # whenever you call `setIamPolicy`. If you omit this field, then IAM allows # you to overwrite a version `3` policy with a version `1` policy, and all of # the conditions in the version `3` policy are lost. # # If a policy does not include any conditions, operations on that policy may # specify any valid version or leave the field unset. "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help # prevent simultaneous updates of a policy from overwriting each other. # It is strongly suggested that systems make use of the `etag` in the # 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. }
testIamPermissions(resource=None, body=None, x__xgafv=None)
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", ], }