docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/spanner_v1.projects.instances.backups.html b/docs/dyn/spanner_v1.projects.instances.backups.html
index af4f04a..7cef73f 100644
--- a/docs/dyn/spanner_v1.projects.instances.backups.html
+++ b/docs/dyn/spanner_v1.projects.instances.backups.html
@@ -92,7 +92,7 @@
<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="toc_element">
- <code><a href="#list">list(parent, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</a></code></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.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -133,46 +133,46 @@
The object takes the form of:
{ # A backup of a Cloud Spanner database.
- "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.
- "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/<project>/instances/<instance>/databases/<database>`.
- "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.
- "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>`.
-}
+ "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.
+ "state": "A String", # Output only. The current state of the backup.
+ "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.
+ "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.
+ "A String",
+ ],
+ "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/<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>`.
+ }
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
@@ -187,6 +187,33 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "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).
+ "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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "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}`.
"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.
@@ -200,33 +227,6 @@
# `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "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).
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "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.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- },
- "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.
- },
}</pre>
</div>
@@ -275,46 +275,46 @@
An object of the form:
{ # A backup of a Cloud Spanner database.
- "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.
- "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/<project>/instances/<instance>/databases/<database>`.
- "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.
- "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>`.
- }</pre>
+ "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.
+ "state": "A String", # Output only. The current state of the backup.
+ "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.
+ "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.
+ "A String",
+ ],
+ "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/<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>`.
+ }</pre>
</div>
<div class="method">
@@ -344,6 +344,10 @@
# Requests for policies with any conditional bindings must specify version 3.
# Policies without any conditional bindings may specify any valid value or
# leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
},
}
@@ -365,10 +369,12 @@
# permissions; each `role` can be an IAM predefined role or a user-created
# custom role.
#
- # Optionally, a `binding` can specify a `condition`, which is a logical
- # expression that allows access to a resource only if the expression evaluates
- # to `true`. A condition can add constraints based on attributes of the
- # request, the resource, or both.
+ # For some types of Google Cloud resources, a `binding` can also specify a
+ # `condition`, which is a logical expression that allows access to a resource
+ # only if the expression evaluates to `true`. A condition can add constraints
+ # based on attributes of the request, the resource, or both. To learn which
+ # resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
#
# **JSON example:**
#
@@ -385,7 +391,9 @@
# },
# {
# "role": "roles/resourcemanager.organizationViewer",
- # "members": ["user:eve@example.com"],
+ # "members": [
+ # "user:eve@example.com"
+ # ],
# "condition": {
# "title": "expirable access",
# "description": "Does not grant access after Sep 2020",
@@ -418,47 +426,24 @@
#
# 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.
"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
- # NOTE: An unsatisfied condition will not allow user access via current
- # binding. Different bindings, including their conditions, are examined
- # independently.
+ #
+ # 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.
#
@@ -491,13 +476,13 @@
# documentation for additional information.
"location": "A String", # Optional. String indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
},
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
@@ -544,15 +529,49 @@
#
"A String",
],
- "role": "A String", # Role that is assigned to `members`.
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
+ "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).
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</code>
+ <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`.
@@ -560,12 +579,12 @@
Args:
parent: string, Required. The instance to list backups from. Values are of the
form `projects/<project>/instances/<instance>`. (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`.
- pageSize: integer, Number of backups to be returned in the response. If 0 or
-less, defaults to the server's maximum allowed page size.
filter: string, An expression that filters the list of returned backups.
A filter expression consists of a field name, a comparison operator, and a
@@ -612,46 +631,46 @@
"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.
- "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.
- "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/<project>/instances/<instance>/databases/<database>`.
- "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.
- "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>`.
- },
+ "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.
+ "state": "A String", # Output only. The current state of the backup.
+ "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.
+ "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.
+ "A String",
+ ],
+ "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/<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>`.
+ },
],
"nextPageToken": "A String", # `next_page_token` can be sent in a subsequent
# ListBackups call to fetch more
@@ -695,46 +714,46 @@
The object takes the form of:
{ # A backup of a Cloud Spanner database.
- "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.
- "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/<project>/instances/<instance>/databases/<database>`.
- "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.
- "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>`.
-}
+ "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.
+ "state": "A String", # Output only. The current state of the backup.
+ "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.
+ "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.
+ "A String",
+ ],
+ "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/<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>`.
+ }
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
@@ -750,46 +769,46 @@
An object of the form:
{ # A backup of a Cloud Spanner database.
- "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.
- "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/<project>/instances/<instance>/databases/<database>`.
- "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.
- "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>`.
- }</pre>
+ "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.
+ "state": "A String", # Output only. The current state of the backup.
+ "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.
+ "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.
+ "A String",
+ ],
+ "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/<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>`.
+ }</pre>
</div>
<div class="method">
@@ -821,10 +840,12 @@
# permissions; each `role` can be an IAM predefined role or a user-created
# custom role.
#
- # Optionally, a `binding` can specify a `condition`, which is a logical
- # expression that allows access to a resource only if the expression evaluates
- # to `true`. A condition can add constraints based on attributes of the
- # request, the resource, or both.
+ # For some types of Google Cloud resources, a `binding` can also specify a
+ # `condition`, which is a logical expression that allows access to a resource
+ # only if the expression evaluates to `true`. A condition can add constraints
+ # based on attributes of the request, the resource, or both. To learn which
+ # resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
#
# **JSON example:**
#
@@ -841,7 +862,9 @@
# },
# {
# "role": "roles/resourcemanager.organizationViewer",
- # "members": ["user:eve@example.com"],
+ # "members": [
+ # "user:eve@example.com"
+ # ],
# "condition": {
# "title": "expirable access",
# "description": "Does not grant access after Sep 2020",
@@ -874,47 +897,24 @@
#
# 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.
"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
- # NOTE: An unsatisfied condition will not allow user access via current
- # binding. Different bindings, including their conditions, are examined
- # independently.
+ #
+ # 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.
#
@@ -947,13 +947,13 @@
# documentation for additional information.
"location": "A String", # Optional. String indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
},
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
@@ -1000,10 +1000,44 @@
#
"A String",
],
- "role": "A String", # Role that is assigned to `members`.
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
+ "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).
},
}
@@ -1025,10 +1059,12 @@
# permissions; each `role` can be an IAM predefined role or a user-created
# custom role.
#
- # Optionally, a `binding` can specify a `condition`, which is a logical
- # expression that allows access to a resource only if the expression evaluates
- # to `true`. A condition can add constraints based on attributes of the
- # request, the resource, or both.
+ # For some types of Google Cloud resources, a `binding` can also specify a
+ # `condition`, which is a logical expression that allows access to a resource
+ # only if the expression evaluates to `true`. A condition can add constraints
+ # based on attributes of the request, the resource, or both. To learn which
+ # resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
#
# **JSON example:**
#
@@ -1045,7 +1081,9 @@
# },
# {
# "role": "roles/resourcemanager.organizationViewer",
- # "members": ["user:eve@example.com"],
+ # "members": [
+ # "user:eve@example.com"
+ # ],
# "condition": {
# "title": "expirable access",
# "description": "Does not grant access after Sep 2020",
@@ -1078,47 +1116,24 @@
#
# 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.
"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
- # NOTE: An unsatisfied condition will not allow user access via current
- # binding. Different bindings, including their conditions, are examined
- # independently.
+ #
+ # 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.
#
@@ -1151,13 +1166,13 @@
# documentation for additional information.
"location": "A String", # Optional. String indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
},
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
@@ -1204,10 +1219,44 @@
#
"A String",
],
- "role": "A String", # Role that is assigned to `members`.
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
+ "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).
}</pre>
</div>