docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/spanner_v1.projects.instances.backups.html b/docs/dyn/spanner_v1.projects.instances.backups.html
index 1c1e78a..026b178 100644
--- a/docs/dyn/spanner_v1.projects.instances.backups.html
+++ b/docs/dyn/spanner_v1.projects.instances.backups.html
@@ -80,8 +80,11 @@
<p class="firstline">Returns the operations Resource.</p>
<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
<code><a href="#create">create(parent, body=None, backupId=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Starts creating a new Cloud Spanner Backup.</p>
+<p class="firstline">Starts creating a new Cloud Spanner Backup. The returned backup long-running operation will have a name of the format `projects//instances//backups//operations/` and can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a pending or completed Backup.</p>
@@ -90,10 +93,10 @@
<p class="firstline">Gets metadata on a pending or completed Backup.</p>
<p class="toc_element">
<code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Gets the access control policy for a database or backup resource.</p>
+<p class="firstline">Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists completed and pending backups.</p>
+ <code><a href="#list">list(parent, pageSize=None, pageToken=None, filter=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists completed and pending backups. Backups returned are ordered by `create_time` in descending order, starting from the most recent `create_time`.</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>
@@ -102,81 +105,38 @@
<p class="firstline">Updates a pending or completed Backup.</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 a database or backup resource.</p>
+<p class="firstline">Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.setIamPolicy` permission on resource.</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 the caller has on the specified database or backup</p>
+<p class="firstline">Returns permissions that the caller has on the specified database or backup resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance.</p>
<h3>Method Details</h3>
<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
<code class="details" id="create">create(parent, body=None, backupId=None, x__xgafv=None)</code>
- <pre>Starts creating a new Cloud Spanner Backup.
-The returned backup long-running operation
-will have a name of the format
-`projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id>`
-and can be used to track creation of the backup. The
-metadata field type is
-CreateBackupMetadata. The
-response field type is
-Backup, if successful. Cancelling the returned operation will stop the
-creation and delete the backup.
-There can be only one pending backup creation per database. Backup creation
-of different databases can run concurrently.
+ <pre>Starts creating a new Cloud Spanner Backup. The returned backup long-running operation will have a name of the format `projects//instances//backups//operations/` and can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently.
Args:
- parent: string, Required. The name of the instance in which the backup will be
-created. This must be the same instance that contains the database the
-backup will be created from. The backup will be stored in the
-location(s) specified in the instance configuration of this
-instance. Values are of the form
-`projects/<project>/instances/<instance>`. (required)
+ parent: string, Required. The name of the instance in which the backup will be created. This must be the same instance that contains the database the backup will be created from. The backup will be stored in the location(s) specified in the instance configuration of this instance. Values are of the form `projects//instances/`. (required)
body: object, The request body.
The object takes the form of:
{ # A backup of a Cloud Spanner database.
- "expireTime": "A String", # Required for the CreateBackup
- # operation. The expiration time of the backup, with microseconds
- # granularity that must be at least 6 hours and at most 366 days
- # from the time the CreateBackup request is processed. Once the `expire_time`
- # has passed, the backup is eligible to be automatically deleted by Cloud
- # Spanner to free the resources used by the backup.
- "createTime": "A String", # Output only. The backup will contain an externally consistent
- # copy of the database at the timestamp specified by
- # `create_time`. `create_time` is approximately the time the
- # CreateBackup request is received.
- "database": "A String", # Required for the CreateBackup operation.
- # Name of the database from which this backup was
- # created. This needs to be in the same instance as the backup.
- # Values are of the form
- # `projects/<project>/instances/<instance>/databases/<database>`.
+ "expireTime": "A String", # Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.
"state": "A String", # Output only. The current state of the backup.
- "name": "A String", # Output only for the CreateBackup operation.
- # Required for the UpdateBackup operation.
- #
- # A globally unique identifier for the backup which cannot be
- # changed. Values are of the form
- # `projects/<project>/instances/<instance>/backups/a-z*[a-z0-9]`
- # The final segment of the name must be between 2 and 60 characters
- # in length.
- #
- # The backup is stored in the location(s) specified in the instance
- # configuration of the instance containing the backup, identified
- # by the prefix of the backup name of the form
- # `projects/<project>/instances/<instance>`.
- "sizeBytes": "A String", # Output only. Size of the backup in bytes.
- "referencingDatabases": [ # Output only. The names of the restored databases that reference the backup.
- # The database names are of
- # the form `projects/<project>/instances/<instance>/databases/<database>`.
- # Referencing databases may exist in different instances. The existence of
- # any referencing database prevents the backup from being deleted. When a
- # restored database from the backup enters the `READY` state, the reference
- # to the backup is removed.
+ "referencingDatabases": [ # Output only. The names of the restored databases that reference the backup. The database names are of the form `projects//instances//databases/`. Referencing databases may exist in different instances. The existence of any referencing database prevents the backup from being deleted. When a restored database from the backup enters the `READY` state, the reference to the backup is removed.
"A String",
],
+ "database": "A String", # Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects//instances//databases/`.
+ "sizeBytes": "A String", # Output only. Size of the backup in bytes.
+ "name": "A String", # Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects//instances//backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`.
+ "createTime": "A String", # Output only. The backup will contain an externally consistent copy of the database at the timestamp specified by `create_time`. `create_time` is approximately the time the CreateBackup request is received.
}
- backupId: string, Required. The id of the backup to be created. The `backup_id` appended to
-`parent` forms the full backup name of the form
-`projects/<project>/instances/<instance>/backups/<backup_id>`.
+ backupId: string, Required. The id of the backup to be created. The `backup_id` appended to `parent` forms the full backup name of the form `projects//instances//backups/`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -185,48 +145,24 @@
Returns:
An object of the form:
- { # This resource represents a long-running operation that is the result of a
- # network API call.
- "name": "A String", # The server-assigned name, which is only unique within the same service that
- # originally returns it. If you use the default HTTP mapping, the
- # `name` should be a resource name ending with `operations/{unique_id}`.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
- "metadata": { # Service-specific metadata associated with the operation. It typically
- # contains progress information and common metadata such as create time.
- # Some services might not provide such metadata. Any method that returns a
- # long-running operation should document the metadata type, if any.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
- # If `true`, the operation is completed, and either `error` or `response` is
- # available.
- "response": { # The normal response of the operation in case of success. If the original
- # method returns no data on success, such as `Delete`, the response is
- # `google.protobuf.Empty`. If the original method is standard
- # `Get`/`Create`/`Update`, the response should be the resource. For other
- # methods, the response should have the type `XxxResponse`, where `Xxx`
- # is the original method name. For example, if the original method name
- # is `TakeSnapshot()`, the inferred response type is
- # `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
}</pre>
</div>
@@ -235,9 +171,7 @@
<pre>Deletes a pending or completed Backup.
Args:
- name: string, Required. Name of the backup to delete.
-Values are of the form
-`projects/<project>/instances/<instance>/backups/<backup>`. (required)
+ name: string, Required. Name of the backup to delete. Values are of the form `projects//instances//backups/`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -246,15 +180,7 @@
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 `{}`.
+ { # 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>
@@ -263,9 +189,7 @@
<pre>Gets metadata on a pending or completed Backup.
Args:
- name: string, Required. Name of the backup.
-Values are of the form
-`projects/<project>/instances/<instance>/backups/<backup>`. (required)
+ name: string, Required. Name of the backup. Values are of the form `projects//instances//backups/`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -275,79 +199,30 @@
An object of the form:
{ # A backup of a Cloud Spanner database.
- "expireTime": "A String", # Required for the CreateBackup
- # operation. The expiration time of the backup, with microseconds
- # granularity that must be at least 6 hours and at most 366 days
- # from the time the CreateBackup request is processed. Once the `expire_time`
- # has passed, the backup is eligible to be automatically deleted by Cloud
- # Spanner to free the resources used by the backup.
- "createTime": "A String", # Output only. The backup will contain an externally consistent
- # copy of the database at the timestamp specified by
- # `create_time`. `create_time` is approximately the time the
- # CreateBackup request is received.
- "database": "A String", # Required for the CreateBackup operation.
- # Name of the database from which this backup was
- # created. This needs to be in the same instance as the backup.
- # Values are of the form
- # `projects/<project>/instances/<instance>/databases/<database>`.
+ "expireTime": "A String", # Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.
"state": "A String", # Output only. The current state of the backup.
- "name": "A String", # Output only for the CreateBackup operation.
- # Required for the UpdateBackup operation.
- #
- # A globally unique identifier for the backup which cannot be
- # changed. Values are of the form
- # `projects/<project>/instances/<instance>/backups/a-z*[a-z0-9]`
- # The final segment of the name must be between 2 and 60 characters
- # in length.
- #
- # The backup is stored in the location(s) specified in the instance
- # configuration of the instance containing the backup, identified
- # by the prefix of the backup name of the form
- # `projects/<project>/instances/<instance>`.
- "sizeBytes": "A String", # Output only. Size of the backup in bytes.
- "referencingDatabases": [ # Output only. The names of the restored databases that reference the backup.
- # The database names are of
- # the form `projects/<project>/instances/<instance>/databases/<database>`.
- # Referencing databases may exist in different instances. The existence of
- # any referencing database prevents the backup from being deleted. When a
- # restored database from the backup enters the `READY` state, the reference
- # to the backup is removed.
+ "referencingDatabases": [ # Output only. The names of the restored databases that reference the backup. The database names are of the form `projects//instances//databases/`. Referencing databases may exist in different instances. The existence of any referencing database prevents the backup from being deleted. When a restored database from the backup enters the `READY` state, the reference to the backup is removed.
"A String",
],
+ "database": "A String", # Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects//instances//databases/`.
+ "sizeBytes": "A String", # Output only. Size of the backup in bytes.
+ "name": "A String", # Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects//instances//backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`.
+ "createTime": "A String", # Output only. The backup will contain an externally consistent copy of the database at the timestamp specified by `create_time`. `create_time` is approximately the time the CreateBackup request is received.
}</pre>
</div>
<div class="method">
<code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code>
- <pre>Gets the access control policy for a database or backup resource.
-Returns an empty policy if a database or backup exists but does not have a
-policy set.
-
-Authorization requires `spanner.databases.getIamPolicy` permission on
-resource.
-For backups, authorization requires `spanner.backups.getIamPolicy`
-permission on resource.
+ <pre>Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource.
Args:
- resource: string, REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects/<project ID>/instances/<instance ID>` for instance resources and `projects/<project ID>/instances/<instance ID>/databases/<database ID>` for database resources. (required)
+ resource: string, REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `GetIamPolicy` method.
- "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to
- # `GetIamPolicy`.
- "requestedPolicyVersion": 42, # Optional. The policy format version to be returned.
- #
- # Valid values are 0, 1, and 3. Requests specifying an invalid value will be
- # rejected.
- #
- # Requests for policies with any conditional bindings must specify version 3.
- # Policies without any conditional bindings may specify any valid value or
- # leave the field unset.
- #
- # To learn which resources support conditions in their IAM policies, see the
- # [IAM
- # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
+ "requestedPolicyVersion": 42, # Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
},
}
@@ -359,266 +234,36 @@
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.
- #
- # For some types of Google Cloud resources, a `binding` can also specify a
- # `condition`, which is a logical expression that allows access to a resource
- # only if the expression evaluates to `true`. A condition can add constraints
- # based on attributes of the request, the resource, or both. To learn which
- # resources support conditions in their IAM policies, see the
- # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
- #
- # **JSON example:**
- #
- # {
- # "bindings": [
- # {
- # "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.
+ { # 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. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "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/).
+ "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. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "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`.
- #
+ "bindingId": "A String", # A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.
+ "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.
- #
- # If the condition evaluates to `true`, then this binding applies to the
- # current request.
- #
- # If the condition evaluates to `false`, then this binding does not apply to
- # the current request. However, a different role binding might grant the same
- # role to one or more of the members in this binding.
- #
- # To learn which resources support conditions in their IAM policies, see the
- # [IAM
- # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
- # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
- # are documented at https://github.com/google/cel-spec.
- #
- # Example (Comparison):
- #
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
- #
- # Example (Equality):
- #
- # title: "Requestor is owner"
- # description: "Determines if requestor is the document owner"
- # expression: "document.owner == request.auth.claims.email"
- #
- # Example (Logic):
- #
- # title: "Public documents"
- # description: "Determine whether the document should be publicly visible"
- # expression: "document.type != 'private' && document.type != 'internal'"
- #
- # Example (Data Manipulation):
- #
- # title: "Notification string"
- # description: "Create a notification string with a timestamp."
- # expression: "'New message received at ' + string(document.create_time)"
- #
- # The exact variables and functions that may be referenced within an expression
- # are determined by the service that evaluates it. See the service
- # documentation for additional information.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "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.
+ "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) 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "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.
},
},
],
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
- #
- # To learn which resources support conditions in their IAM policies, see the
- # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
- "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.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
- <pre>Lists completed and pending backups.
-Backups returned are ordered by `create_time` in descending order,
-starting from the most recent `create_time`.
+ <code class="details" id="list">list(parent, pageSize=None, pageToken=None, filter=None, x__xgafv=None)</code>
+ <pre>Lists completed and pending backups. Backups returned are ordered by `create_time` in descending order, starting from the most recent `create_time`.
Args:
- parent: string, Required. The instance to list backups from. Values are of the
-form `projects/<project>/instances/<instance>`. (required)
- filter: string, An expression that filters the list of returned backups.
-
-A filter expression consists of a field name, a comparison operator, and a
-value for filtering.
-The value must be a string, a number, or a boolean. The comparison operator
-must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
-Colon `:` is the contains operator. Filter rules are not case sensitive.
-
-The following fields in the Backup are eligible for filtering:
-
- * `name`
- * `database`
- * `state`
- * `create_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
- * `expire_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
- * `size_bytes`
-
-You can combine multiple expressions by enclosing each expression in
-parentheses. By default, expressions are combined with AND logic, but
-you can specify AND, OR, and NOT logic explicitly.
-
-Here are a few examples:
-
- * `name:Howl` - The backup's name contains the string "howl".
- * `database:prod`
- - The database's name contains the string "prod".
- * `state:CREATING` - The backup is pending creation.
- * `state:READY` - The backup is fully created and ready for use.
- * `(name:howl) AND (create_time < \"2018-03-28T14:50:00Z\")`
- - The backup name contains the string "howl" and `create_time`
- of the backup is before 2018-03-28T14:50:00Z.
- * `expire_time < \"2018-03-28T14:50:00Z\"`
- - The backup `expire_time` is before 2018-03-28T14:50:00Z.
- * `size_bytes > 10000000000` - The backup's size is greater than 10GB
- pageSize: integer, Number of backups to be returned in the response. If 0 or
-less, defaults to the server's maximum allowed page size.
- pageToken: string, If non-empty, `page_token` should contain a
-next_page_token from a
-previous ListBackupsResponse to the same `parent` and with the same
-`filter`.
+ parent: string, Required. The instance to list backups from. Values are of the form `projects//instances/`. (required)
+ pageSize: integer, Number of backups to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
+ pageToken: string, If non-empty, `page_token` should contain a next_page_token from a previous ListBackupsResponse to the same `parent` and with the same `filter`.
+ filter: string, An expression that filters the list of returned backups. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Backup are eligible for filtering: * `name` * `database` * `state` * `create_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * `expire_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * `size_bytes` You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `name:Howl` - The backup's name contains the string "howl". * `database:prod` - The database's name contains the string "prod". * `state:CREATING` - The backup is pending creation. * `state:READY` - The backup is fully created and ready for use. * `(name:howl) AND (create_time < \"2018-03-28T14:50:00Z\")` - The backup name contains the string "howl" and `create_time` of the backup is before 2018-03-28T14:50:00Z. * `expire_time < \"2018-03-28T14:50:00Z\"` - The backup `expire_time` is before 2018-03-28T14:50:00Z. * `size_bytes > 10000000000` - The backup's size is greater than 10GB
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -628,51 +273,18 @@
An object of the form:
{ # The response for ListBackups.
- "nextPageToken": "A String", # `next_page_token` can be sent in a subsequent
- # ListBackups call to fetch more
- # of the matching backups.
- "backups": [ # The list of matching backups. Backups returned are ordered by `create_time`
- # in descending order, starting from the most recent `create_time`.
+ "nextPageToken": "A String", # `next_page_token` can be sent in a subsequent ListBackups call to fetch more of the matching backups.
+ "backups": [ # The list of matching backups. Backups returned are ordered by `create_time` in descending order, starting from the most recent `create_time`.
{ # A backup of a Cloud Spanner database.
- "expireTime": "A String", # Required for the CreateBackup
- # operation. The expiration time of the backup, with microseconds
- # granularity that must be at least 6 hours and at most 366 days
- # from the time the CreateBackup request is processed. Once the `expire_time`
- # has passed, the backup is eligible to be automatically deleted by Cloud
- # Spanner to free the resources used by the backup.
- "createTime": "A String", # Output only. The backup will contain an externally consistent
- # copy of the database at the timestamp specified by
- # `create_time`. `create_time` is approximately the time the
- # CreateBackup request is received.
- "database": "A String", # Required for the CreateBackup operation.
- # Name of the database from which this backup was
- # created. This needs to be in the same instance as the backup.
- # Values are of the form
- # `projects/<project>/instances/<instance>/databases/<database>`.
+ "expireTime": "A String", # Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.
"state": "A String", # Output only. The current state of the backup.
- "name": "A String", # Output only for the CreateBackup operation.
- # Required for the UpdateBackup operation.
- #
- # A globally unique identifier for the backup which cannot be
- # changed. Values are of the form
- # `projects/<project>/instances/<instance>/backups/a-z*[a-z0-9]`
- # The final segment of the name must be between 2 and 60 characters
- # in length.
- #
- # The backup is stored in the location(s) specified in the instance
- # configuration of the instance containing the backup, identified
- # by the prefix of the backup name of the form
- # `projects/<project>/instances/<instance>`.
- "sizeBytes": "A String", # Output only. Size of the backup in bytes.
- "referencingDatabases": [ # Output only. The names of the restored databases that reference the backup.
- # The database names are of
- # the form `projects/<project>/instances/<instance>/databases/<database>`.
- # Referencing databases may exist in different instances. The existence of
- # any referencing database prevents the backup from being deleted. When a
- # restored database from the backup enters the `READY` state, the reference
- # to the backup is removed.
+ "referencingDatabases": [ # Output only. The names of the restored databases that reference the backup. The database names are of the form `projects//instances//databases/`. Referencing databases may exist in different instances. The existence of any referencing database prevents the backup from being deleted. When a restored database from the backup enters the `READY` state, the reference to the backup is removed.
"A String",
],
+ "database": "A String", # Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects//instances//databases/`.
+ "sizeBytes": "A String", # Output only. Size of the backup in bytes.
+ "name": "A String", # Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects//instances//backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`.
+ "createTime": "A String", # Output only. The backup will contain an externally consistent copy of the database at the timestamp specified by `create_time`. `create_time` is approximately the time the CreateBackup request is received.
},
],
}</pre>
@@ -697,69 +309,23 @@
<pre>Updates a pending or completed Backup.
Args:
- name: string, Output only for the CreateBackup operation.
-Required for the UpdateBackup operation.
-
-A globally unique identifier for the backup which cannot be
-changed. Values are of the form
-`projects/<project>/instances/<instance>/backups/a-z*[a-z0-9]`
-The final segment of the name must be between 2 and 60 characters
-in length.
-
-The backup is stored in the location(s) specified in the instance
-configuration of the instance containing the backup, identified
-by the prefix of the backup name of the form
-`projects/<project>/instances/<instance>`. (required)
+ name: string, Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects//instances//backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`. (required)
body: object, The request body.
The object takes the form of:
{ # A backup of a Cloud Spanner database.
- "expireTime": "A String", # Required for the CreateBackup
- # operation. The expiration time of the backup, with microseconds
- # granularity that must be at least 6 hours and at most 366 days
- # from the time the CreateBackup request is processed. Once the `expire_time`
- # has passed, the backup is eligible to be automatically deleted by Cloud
- # Spanner to free the resources used by the backup.
- "createTime": "A String", # Output only. The backup will contain an externally consistent
- # copy of the database at the timestamp specified by
- # `create_time`. `create_time` is approximately the time the
- # CreateBackup request is received.
- "database": "A String", # Required for the CreateBackup operation.
- # Name of the database from which this backup was
- # created. This needs to be in the same instance as the backup.
- # Values are of the form
- # `projects/<project>/instances/<instance>/databases/<database>`.
+ "expireTime": "A String", # Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.
"state": "A String", # Output only. The current state of the backup.
- "name": "A String", # Output only for the CreateBackup operation.
- # Required for the UpdateBackup operation.
- #
- # A globally unique identifier for the backup which cannot be
- # changed. Values are of the form
- # `projects/<project>/instances/<instance>/backups/a-z*[a-z0-9]`
- # The final segment of the name must be between 2 and 60 characters
- # in length.
- #
- # The backup is stored in the location(s) specified in the instance
- # configuration of the instance containing the backup, identified
- # by the prefix of the backup name of the form
- # `projects/<project>/instances/<instance>`.
- "sizeBytes": "A String", # Output only. Size of the backup in bytes.
- "referencingDatabases": [ # Output only. The names of the restored databases that reference the backup.
- # The database names are of
- # the form `projects/<project>/instances/<instance>/databases/<database>`.
- # Referencing databases may exist in different instances. The existence of
- # any referencing database prevents the backup from being deleted. When a
- # restored database from the backup enters the `READY` state, the reference
- # to the backup is removed.
+ "referencingDatabases": [ # Output only. The names of the restored databases that reference the backup. The database names are of the form `projects//instances//databases/`. Referencing databases may exist in different instances. The existence of any referencing database prevents the backup from being deleted. When a restored database from the backup enters the `READY` state, the reference to the backup is removed.
"A String",
],
+ "database": "A String", # Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects//instances//databases/`.
+ "sizeBytes": "A String", # Output only. Size of the backup in bytes.
+ "name": "A String", # Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects//instances//backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`.
+ "createTime": "A String", # Output only. The backup will contain an externally consistent copy of the database at the timestamp specified by `create_time`. `create_time` is approximately the time the CreateBackup request is received.
}
- updateMask: string, Required. A mask specifying which fields (e.g. `expire_time`) in the
-Backup resource should be updated. This mask is relative to the Backup
-resource, not to the request message. The field mask must always be
-specified; this prevents any future fields from being erased accidentally
-by clients that do not know about them.
+ updateMask: string, Required. A mask specifying which fields (e.g. `expire_time`) in the Backup resource should be updated. This mask is relative to the Backup resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally by clients that do not know about them.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -769,275 +335,46 @@
An object of the form:
{ # A backup of a Cloud Spanner database.
- "expireTime": "A String", # Required for the CreateBackup
- # operation. The expiration time of the backup, with microseconds
- # granularity that must be at least 6 hours and at most 366 days
- # from the time the CreateBackup request is processed. Once the `expire_time`
- # has passed, the backup is eligible to be automatically deleted by Cloud
- # Spanner to free the resources used by the backup.
- "createTime": "A String", # Output only. The backup will contain an externally consistent
- # copy of the database at the timestamp specified by
- # `create_time`. `create_time` is approximately the time the
- # CreateBackup request is received.
- "database": "A String", # Required for the CreateBackup operation.
- # Name of the database from which this backup was
- # created. This needs to be in the same instance as the backup.
- # Values are of the form
- # `projects/<project>/instances/<instance>/databases/<database>`.
+ "expireTime": "A String", # Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.
"state": "A String", # Output only. The current state of the backup.
- "name": "A String", # Output only for the CreateBackup operation.
- # Required for the UpdateBackup operation.
- #
- # A globally unique identifier for the backup which cannot be
- # changed. Values are of the form
- # `projects/<project>/instances/<instance>/backups/a-z*[a-z0-9]`
- # The final segment of the name must be between 2 and 60 characters
- # in length.
- #
- # The backup is stored in the location(s) specified in the instance
- # configuration of the instance containing the backup, identified
- # by the prefix of the backup name of the form
- # `projects/<project>/instances/<instance>`.
- "sizeBytes": "A String", # Output only. Size of the backup in bytes.
- "referencingDatabases": [ # Output only. The names of the restored databases that reference the backup.
- # The database names are of
- # the form `projects/<project>/instances/<instance>/databases/<database>`.
- # Referencing databases may exist in different instances. The existence of
- # any referencing database prevents the backup from being deleted. When a
- # restored database from the backup enters the `READY` state, the reference
- # to the backup is removed.
+ "referencingDatabases": [ # Output only. The names of the restored databases that reference the backup. The database names are of the form `projects//instances//databases/`. Referencing databases may exist in different instances. The existence of any referencing database prevents the backup from being deleted. When a restored database from the backup enters the `READY` state, the reference to the backup is removed.
"A String",
],
+ "database": "A String", # Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects//instances//databases/`.
+ "sizeBytes": "A String", # Output only. Size of the backup in bytes.
+ "name": "A String", # Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects//instances//backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`.
+ "createTime": "A String", # Output only. The backup will contain an externally consistent copy of the database at the timestamp specified by `create_time`. `create_time` is approximately the time the CreateBackup request is received.
}</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 a database or backup resource.
-Replaces any existing policy.
-
-Authorization requires `spanner.databases.setIamPolicy`
-permission on resource.
-For backups, authorization requires `spanner.backups.setIamPolicy`
-permission on resource.
+ <pre>Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.setIamPolicy` permission on resource.
Args:
- resource: string, REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects/<project ID>/instances/<instance ID>` for instance resources and `projects/<project ID>/instances/<instance ID>/databases/<database ID>` for databases resources. (required)
+ resource: string, REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for databases resources. (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.
- #
- # For some types of Google Cloud resources, a `binding` can also specify a
- # `condition`, which is a logical expression that allows access to a resource
- # only if the expression evaluates to `true`. A condition can add constraints
- # based on attributes of the request, the resource, or both. To learn which
- # resources support conditions in their IAM policies, see the
- # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
- #
- # **JSON example:**
- #
- # {
- # "bindings": [
- # {
- # "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.
+ "policy": { # 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. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "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/). # 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.
+ "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. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "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`.
- #
+ "bindingId": "A String", # A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.
+ "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.
- #
- # If the condition evaluates to `true`, then this binding applies to the
- # current request.
- #
- # If the condition evaluates to `false`, then this binding does not apply to
- # the current request. However, a different role binding might grant the same
- # role to one or more of the members in this binding.
- #
- # To learn which resources support conditions in their IAM policies, see the
- # [IAM
- # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
- # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
- # are documented at https://github.com/google/cel-spec.
- #
- # Example (Comparison):
- #
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
- #
- # Example (Equality):
- #
- # title: "Requestor is owner"
- # description: "Determines if requestor is the document owner"
- # expression: "document.owner == request.auth.claims.email"
- #
- # Example (Logic):
- #
- # title: "Public documents"
- # description: "Determine whether the document should be publicly visible"
- # expression: "document.type != 'private' && document.type != 'internal'"
- #
- # Example (Data Manipulation):
- #
- # title: "Notification string"
- # description: "Create a notification string with a timestamp."
- # expression: "'New message received at ' + string(document.create_time)"
- #
- # The exact variables and functions that may be referenced within an expression
- # are determined by the service that evaluates it. See the service
- # documentation for additional information.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "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.
+ "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) 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "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.
},
},
],
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
- #
- # To learn which resources support conditions in their IAM policies, see the
- # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
- "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.
},
}
@@ -1049,238 +386,38 @@
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.
- #
- # For some types of Google Cloud resources, a `binding` can also specify a
- # `condition`, which is a logical expression that allows access to a resource
- # only if the expression evaluates to `true`. A condition can add constraints
- # based on attributes of the request, the resource, or both. To learn which
- # resources support conditions in their IAM policies, see the
- # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
- #
- # **JSON example:**
- #
- # {
- # "bindings": [
- # {
- # "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.
+ { # 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. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "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/).
+ "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. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "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`.
- #
+ "bindingId": "A String", # A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.
+ "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.
- #
- # If the condition evaluates to `true`, then this binding applies to the
- # current request.
- #
- # If the condition evaluates to `false`, then this binding does not apply to
- # the current request. However, a different role binding might grant the same
- # role to one or more of the members in this binding.
- #
- # To learn which resources support conditions in their IAM policies, see the
- # [IAM
- # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
- # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
- # are documented at https://github.com/google/cel-spec.
- #
- # Example (Comparison):
- #
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
- #
- # Example (Equality):
- #
- # title: "Requestor is owner"
- # description: "Determines if requestor is the document owner"
- # expression: "document.owner == request.auth.claims.email"
- #
- # Example (Logic):
- #
- # title: "Public documents"
- # description: "Determine whether the document should be publicly visible"
- # expression: "document.type != 'private' && document.type != 'internal'"
- #
- # Example (Data Manipulation):
- #
- # title: "Notification string"
- # description: "Create a notification string with a timestamp."
- # expression: "'New message received at ' + string(document.create_time)"
- #
- # The exact variables and functions that may be referenced within an expression
- # are determined by the service that evaluates it. See the service
- # documentation for additional information.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "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.
+ "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) 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "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.
},
},
],
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
- #
- # To learn which resources support conditions in their IAM policies, see the
- # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
- "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.
}</pre>
</div>
<div class="method">
<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
- <pre>Returns permissions that the caller has on the specified database or backup
-resource.
-
-Attempting this RPC on a non-existent Cloud Spanner database will
-result in a NOT_FOUND error if the user has
-`spanner.databases.list` permission on the containing Cloud
-Spanner instance. Otherwise returns an empty set of permissions.
-Calling this method on a backup that does not exist will
-result in a NOT_FOUND error if the user has
-`spanner.backups.list` permission on the containing instance.
+ <pre>Returns permissions that the caller has on the specified database or backup resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance.
Args:
- resource: string, REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects/<project ID>/instances/<instance ID>` for instance resources and `projects/<project ID>/instances/<instance ID>/databases/<database ID>` for database resources. (required)
+ resource: string, REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `TestIamPermissions` method.
- "permissions": [ # REQUIRED: The set of permissions to check for 'resource'.
- # Permissions with wildcards (such as '*', 'spanner.*', 'spanner.instances.*') are not allowed.
+ "permissions": [ # REQUIRED: The set of permissions to check for 'resource'. Permissions with wildcards (such as '*', 'spanner.*', 'spanner.instances.*') are not allowed.
"A String",
],
}
@@ -1294,8 +431,7 @@
An object of the form:
{ # Response message for `TestIamPermissions` method.
- "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
- # allowed.
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
"A String",
],
}</pre>