Google Git
Sign in
chromium / external / github.com / google / google-api-python-client / gh-pages / . / docs / dyn / bigtableadmin_v2.projects.instances.clusters.backups.html
blob: 2f988d2ea15eafa4405e8c6670fe470f7f1fbcea [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="bigtableadmin_v2.html">Cloud Bigtable Admin API</a> . <a href="bigtableadmin_v2.projects.html">projects</a> . <a href="bigtableadmin_v2.projects.instances.html">instances</a> . <a href="bigtableadmin_v2.projects.instances.clusters.html">clusters</a> . <a href="bigtableadmin_v2.projects.instances.clusters.backups.html">backups</a></h1>
<h2>Instance Methods</h2>
<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 Bigtable Backup. The returned backup</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 Cloud Bigtable backup.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets metadata on a pending or completed Cloud Bigtable 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 Table resource.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, filter=None, orderBy=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Cloud Bigtable backups. Returns both completed and pending</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a pending or completed Cloud Bigtable 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 Table 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 table resource.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(parent, body=None, backupId=None, x__xgafv=None)</code>
<pre>Starts creating a new Cloud Bigtable Backup. The returned backup
long-running operation 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.
Args:
parent: string, Required. This must be one of the clusters in the instance in which this
table is located. The backup will be stored in this cluster. Values are
of the form `projects/{project}/instances/{instance}/clusters/{cluster}`. (required)
body: object, The request body.
The object takes the form of:
{ # A backup of a Cloud Bigtable table.
&quot;startTime&quot;: &quot;A String&quot;, # Output only. `start_time` is the time that the backup was started
# (i.e. approximately the time the
# CreateBackup request is received). The
# row data in this backup will be no older than this timestamp.
&quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the backup.
&quot;sizeBytes&quot;: &quot;A String&quot;, # Output only. Size of the backup in bytes.
&quot;name&quot;: &quot;A String&quot;, # A globally unique identifier for the backup which cannot be
# changed. Values are of the form
# `projects/{project}/instances/{instance}/clusters/{cluster}/
# backups/_a-zA-Z0-9*`
# The final segment of the name must be between 1 and 50 characters
# in length.
#
# The backup is stored in the cluster identified by the prefix of the backup
# name of the form
# `projects/{project}/instances/{instance}/clusters/{cluster}`.
&quot;endTime&quot;: &quot;A String&quot;, # Output only. `end_time` is the time that the backup was finished. The row
# data in the backup will be no newer than this timestamp.
&quot;sourceTable&quot;: &quot;A String&quot;, # Required. Immutable. Name of the table 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}/tables/{source_table}`.
&quot;expireTime&quot;: &quot;A String&quot;, # Required. The expiration time of the backup, with microseconds
# granularity that must be at least 6 hours and at most 30 days
# from the time the request is received. Once the `expire_time`
# has passed, Cloud Bigtable will delete the backup and free the
# resources used by the backup.
}
backupId: string, Required. The id of the backup to be created. The `backup_id` along with
the parent `parent` are combined as {parent}/backups/{backup_id} to create
the full backup name, of the form:
`projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}`.
This string must be between 1 and 50 characters in length and match the
regex _a-zA-Z0-9*.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a
# network API call.
&quot;metadata&quot;: { # 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.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;error&quot;: { # 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).
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&quot;message&quot;: &quot;A String&quot;, # 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.
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
},
&quot;response&quot;: { # 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`.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;name&quot;: &quot;A String&quot;, # 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}`.
&quot;done&quot;: 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>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a pending or completed Cloud Bigtable backup.
Args:
name: string, Required. Name of the backup to delete.
Values are of the form
`projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
#
# service Foo {
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# }
#
# The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets metadata on a pending or completed Cloud Bigtable Backup.
Args:
name: string, Required. Name of the backup.
Values are of the form
`projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A backup of a Cloud Bigtable table.
&quot;startTime&quot;: &quot;A String&quot;, # Output only. `start_time` is the time that the backup was started
# (i.e. approximately the time the
# CreateBackup request is received). The
# row data in this backup will be no older than this timestamp.
&quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the backup.
&quot;sizeBytes&quot;: &quot;A String&quot;, # Output only. Size of the backup in bytes.
&quot;name&quot;: &quot;A String&quot;, # A globally unique identifier for the backup which cannot be
# changed. Values are of the form
# `projects/{project}/instances/{instance}/clusters/{cluster}/
# backups/_a-zA-Z0-9*`
# The final segment of the name must be between 1 and 50 characters
# in length.
#
# The backup is stored in the cluster identified by the prefix of the backup
# name of the form
# `projects/{project}/instances/{instance}/clusters/{cluster}`.
&quot;endTime&quot;: &quot;A String&quot;, # Output only. `end_time` is the time that the backup was finished. The row
# data in the backup will be no newer than this timestamp.
&quot;sourceTable&quot;: &quot;A String&quot;, # Required. Immutable. Name of the table 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}/tables/{source_table}`.
&quot;expireTime&quot;: &quot;A String&quot;, # Required. The expiration time of the backup, with microseconds
# granularity that must be at least 6 hours and at most 30 days
# from the time the request is received. Once the `expire_time`
# has passed, Cloud Bigtable will delete the backup and free the
# resources used by the backup.
}</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 Table resource.
Returns an empty policy if the resource exists but does not have a policy
set.
Args:
resource: string, REQUIRED: The resource for which the policy is being requested.
See the operation documentation for the appropriate value for this field. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `GetIamPolicy` method.
&quot;options&quot;: { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to
# `GetIamPolicy`.
&quot;requestedPolicyVersion&quot;: 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).
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Identity and Access Management (IAM) policy, which specifies access
# controls for Google Cloud resources.
#
#
# A `Policy` is a collection of `bindings`. A `binding` binds one or more
# `members` to a single `role`. Members can be user accounts, service accounts,
# Google groups, and domains (such as G Suite). A `role` is a named list of
# permissions; each `role` can be an IAM predefined role or a user-created
# custom role.
#
# 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:**
#
# {
# &quot;bindings&quot;: [
# {
# &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
# &quot;members&quot;: [
# &quot;user:mike@example.com&quot;,
# &quot;group:admins@example.com&quot;,
# &quot;domain:google.com&quot;,
# &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot;
# ]
# },
# {
# &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
# &quot;members&quot;: [
# &quot;user:eve@example.com&quot;
# ],
# &quot;condition&quot;: {
# &quot;title&quot;: &quot;expirable access&quot;,
# &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
# &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
# }
# }
# ],
# &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
# &quot;version&quot;: 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 &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
# - etag: BwWWja0YfJA=
# - version: 3
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
&quot;bindings&quot;: [ # 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`.
&quot;condition&quot;: { # 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: &quot;Summary size limit&quot;
# description: &quot;Determines if a summary is less than 100 chars&quot;
# expression: &quot;document.summary.size() &lt; 100&quot;
#
# Example (Equality):
#
# title: &quot;Requestor is owner&quot;
# description: &quot;Determines if requestor is the document owner&quot;
# expression: &quot;document.owner == request.auth.claims.email&quot;
#
# Example (Logic):
#
# title: &quot;Public documents&quot;
# description: &quot;Determine whether the document should be publicly visible&quot;
# expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
#
# Example (Data Manipulation):
#
# title: &quot;Notification string&quot;
# description: &quot;Create a notification string with a timestamp.&quot;
# expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
#
# 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.
&quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
# syntax.
&quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
&quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
&quot;title&quot;: &quot;A String&quot;, # 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.
},
&quot;members&quot;: [ # 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`.
#
&quot;A String&quot;,
],
&quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
&quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
# The configuration determines which permission types are logged, and what
# identities, if any, are exempted from logging.
# An AuditConfig must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
# the union of the two AuditConfigs is used for that service: the log_types
# specified in each AuditConfig are enabled, and the exempted_members in each
# AuditLogConfig are exempted.
#
# Example Policy with multiple AuditConfigs:
#
# {
# &quot;audit_configs&quot;: [
# {
# &quot;service&quot;: &quot;allServices&quot;,
# &quot;audit_log_configs&quot;: [
# {
# &quot;log_type&quot;: &quot;DATA_READ&quot;,
# &quot;exempted_members&quot;: [
# &quot;user:jose@example.com&quot;
# ]
# },
# {
# &quot;log_type&quot;: &quot;DATA_WRITE&quot;
# },
# {
# &quot;log_type&quot;: &quot;ADMIN_READ&quot;
# }
# ]
# },
# {
# &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
# &quot;audit_log_configs&quot;: [
# {
# &quot;log_type&quot;: &quot;DATA_READ&quot;
# },
# {
# &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
# &quot;exempted_members&quot;: [
# &quot;user:aliya@example.com&quot;
# ]
# }
# ]
# }
# ]
# }
#
# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
# logging. It also exempts jose@example.com from DATA_READ logging, and
# aliya@example.com from DATA_WRITE logging.
&quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions.
# Example:
#
# {
# &quot;audit_log_configs&quot;: [
# {
# &quot;log_type&quot;: &quot;DATA_READ&quot;,
# &quot;exempted_members&quot;: [
# &quot;user:jose@example.com&quot;
# ]
# },
# {
# &quot;log_type&quot;: &quot;DATA_WRITE&quot;
# }
# ]
# }
#
# This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
# jose@example.com from DATA_READ logging.
&quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
# permission.
# Follows the same format of Binding.members.
&quot;A String&quot;,
],
&quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
},
],
&quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
&quot;etag&quot;: &quot;A String&quot;, # `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.
&quot;version&quot;: 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, pageSize=None, pageToken=None, filter=None, orderBy=None, x__xgafv=None)</code>
<pre>Lists Cloud Bigtable backups. Returns both completed and pending
backups.
Args:
parent: string, Required. The cluster to list backups from. Values are of the
form `projects/{project}/instances/{instance}/clusters/{cluster}`.
Use `{cluster} = &#x27;-&#x27;` to list backups for all clusters in an instance,
e.g., `projects/{project}/instances/{instance}/clusters/-`. (required)
pageSize: integer, Number of backups to be returned in the response. If 0 or
less, defaults to the server&#x27;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, A filter expression that filters backups listed in the response.
The expression must specify the field name, a comparison operator,
and the value that you want to use for filtering. The value must be a
string, a number, or a boolean. The comparison operator must be
&lt;, &gt;, &lt;=, &gt;=, !=, =, or :. Colon ‘:’ represents a HAS operator which is
roughly synonymous with equality. Filter rules are case insensitive.
The fields eligible for filtering are:
* `name`
* `source_table`
* `state`
* `start_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
* `end_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`
To filter on multiple expressions, provide each separate expression within
parentheses. By default, each expression is an AND expression. However,
you can include AND, OR, and NOT expressions explicitly.
Some examples of using filters are:
* `name:&quot;exact&quot;` --&gt; The backup&#x27;s name is the string &quot;exact&quot;.
* `name:howl` --&gt; The backup&#x27;s name contains the string &quot;howl&quot;.
* `source_table:prod`
--&gt; The source_table&#x27;s name contains the string &quot;prod&quot;.
* `state:CREATING` --&gt; The backup is pending creation.
* `state:READY` --&gt; The backup is fully created and ready for use.
* `(name:howl) AND (start_time &lt; \&quot;2018-03-28T14:50:00Z\&quot;)`
--&gt; The backup name contains the string &quot;howl&quot; and start_time
of the backup is before 2018-03-28T14:50:00Z.
* `size_bytes &gt; 10000000000` --&gt; The backup&#x27;s size is greater than 10GB
orderBy: string, An expression for specifying the sort order of the results of the request.
The string value should specify one or more fields in Backup. The full
syntax is described at https://aip.dev/132#ordering.
Fields supported are:
* name
* source_table
* expire_time
* start_time
* end_time
* size_bytes
* state
For example, &quot;start_time&quot;. The default sorting order is ascending.
To specify descending order for the field, a suffix &quot; desc&quot; should
be appended to the field name. For example, &quot;start_time desc&quot;.
Redundant space characters in the syntax are insigificant.
If order_by is empty, results will be sorted by `start_time` in descending
order starting from the most recently created backup.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response for ListBackups.
&quot;backups&quot;: [ # The list of matching backups.
{ # A backup of a Cloud Bigtable table.
&quot;startTime&quot;: &quot;A String&quot;, # Output only. `start_time` is the time that the backup was started
# (i.e. approximately the time the
# CreateBackup request is received). The
# row data in this backup will be no older than this timestamp.
&quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the backup.
&quot;sizeBytes&quot;: &quot;A String&quot;, # Output only. Size of the backup in bytes.
&quot;name&quot;: &quot;A String&quot;, # A globally unique identifier for the backup which cannot be
# changed. Values are of the form
# `projects/{project}/instances/{instance}/clusters/{cluster}/
# backups/_a-zA-Z0-9*`
# The final segment of the name must be between 1 and 50 characters
# in length.
#
# The backup is stored in the cluster identified by the prefix of the backup
# name of the form
# `projects/{project}/instances/{instance}/clusters/{cluster}`.
&quot;endTime&quot;: &quot;A String&quot;, # Output only. `end_time` is the time that the backup was finished. The row
# data in the backup will be no newer than this timestamp.
&quot;sourceTable&quot;: &quot;A String&quot;, # Required. Immutable. Name of the table 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}/tables/{source_table}`.
&quot;expireTime&quot;: &quot;A String&quot;, # Required. The expiration time of the backup, with microseconds
# granularity that must be at least 6 hours and at most 30 days
# from the time the request is received. Once the `expire_time`
# has passed, Cloud Bigtable will delete the backup and free the
# resources used by the backup.
},
],
&quot;nextPageToken&quot;: &quot;A String&quot;, # `next_page_token` can be sent in a subsequent
# ListBackups call to fetch more
# of the matching backups.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates a pending or completed Cloud Bigtable Backup.
Args:
name: string, A globally unique identifier for the backup which cannot be
changed. Values are of the form
`projects/{project}/instances/{instance}/clusters/{cluster}/
backups/_a-zA-Z0-9*`
The final segment of the name must be between 1 and 50 characters
in length.
The backup is stored in the cluster identified by the prefix of the backup
name of the form
`projects/{project}/instances/{instance}/clusters/{cluster}`. (required)
body: object, The request body.
The object takes the form of:
{ # A backup of a Cloud Bigtable table.
&quot;startTime&quot;: &quot;A String&quot;, # Output only. `start_time` is the time that the backup was started
# (i.e. approximately the time the
# CreateBackup request is received). The
# row data in this backup will be no older than this timestamp.
&quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the backup.
&quot;sizeBytes&quot;: &quot;A String&quot;, # Output only. Size of the backup in bytes.
&quot;name&quot;: &quot;A String&quot;, # A globally unique identifier for the backup which cannot be
# changed. Values are of the form
# `projects/{project}/instances/{instance}/clusters/{cluster}/
# backups/_a-zA-Z0-9*`
# The final segment of the name must be between 1 and 50 characters
# in length.
#
# The backup is stored in the cluster identified by the prefix of the backup
# name of the form
# `projects/{project}/instances/{instance}/clusters/{cluster}`.
&quot;endTime&quot;: &quot;A String&quot;, # Output only. `end_time` is the time that the backup was finished. The row
# data in the backup will be no newer than this timestamp.
&quot;sourceTable&quot;: &quot;A String&quot;, # Required. Immutable. Name of the table 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}/tables/{source_table}`.
&quot;expireTime&quot;: &quot;A String&quot;, # Required. The expiration time of the backup, with microseconds
# granularity that must be at least 6 hours and at most 30 days
# from the time the request is received. Once the `expire_time`
# has passed, Cloud Bigtable will delete the backup and free the
# resources used by the backup.
}
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
2 - v2 error format
Returns:
An object of the form:
{ # A backup of a Cloud Bigtable table.
&quot;startTime&quot;: &quot;A String&quot;, # Output only. `start_time` is the time that the backup was started
# (i.e. approximately the time the
# CreateBackup request is received). The
# row data in this backup will be no older than this timestamp.
&quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the backup.
&quot;sizeBytes&quot;: &quot;A String&quot;, # Output only. Size of the backup in bytes.
&quot;name&quot;: &quot;A String&quot;, # A globally unique identifier for the backup which cannot be
# changed. Values are of the form
# `projects/{project}/instances/{instance}/clusters/{cluster}/
# backups/_a-zA-Z0-9*`
# The final segment of the name must be between 1 and 50 characters
# in length.
#
# The backup is stored in the cluster identified by the prefix of the backup
# name of the form
# `projects/{project}/instances/{instance}/clusters/{cluster}`.
&quot;endTime&quot;: &quot;A String&quot;, # Output only. `end_time` is the time that the backup was finished. The row
# data in the backup will be no newer than this timestamp.
&quot;sourceTable&quot;: &quot;A String&quot;, # Required. Immutable. Name of the table 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}/tables/{source_table}`.
&quot;expireTime&quot;: &quot;A String&quot;, # Required. The expiration time of the backup, with microseconds
# granularity that must be at least 6 hours and at most 30 days
# from the time the request is received. Once the `expire_time`
# has passed, Cloud Bigtable will delete the backup and free the
# resources used by the backup.
}</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 Table resource.
Replaces any existing policy.
Args:
resource: string, REQUIRED: The resource for which the policy is being specified.
See the operation documentation for the appropriate value for this field. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
&quot;updateMask&quot;: &quot;A String&quot;, # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
# the fields in the mask will be modified. If no mask is provided, the
# following default mask is used:
#
# `paths: &quot;bindings, etag&quot;`
&quot;policy&quot;: { # 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:**
#
# {
# &quot;bindings&quot;: [
# {
# &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
# &quot;members&quot;: [
# &quot;user:mike@example.com&quot;,
# &quot;group:admins@example.com&quot;,
# &quot;domain:google.com&quot;,
# &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot;
# ]
# },
# {
# &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
# &quot;members&quot;: [
# &quot;user:eve@example.com&quot;
# ],
# &quot;condition&quot;: {
# &quot;title&quot;: &quot;expirable access&quot;,
# &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
# &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
# }
# }
# ],
# &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
# &quot;version&quot;: 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 &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
# - etag: BwWWja0YfJA=
# - version: 3
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
&quot;bindings&quot;: [ # 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`.
&quot;condition&quot;: { # 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: &quot;Summary size limit&quot;
# description: &quot;Determines if a summary is less than 100 chars&quot;
# expression: &quot;document.summary.size() &lt; 100&quot;
#
# Example (Equality):
#
# title: &quot;Requestor is owner&quot;
# description: &quot;Determines if requestor is the document owner&quot;
# expression: &quot;document.owner == request.auth.claims.email&quot;
#
# Example (Logic):
#
# title: &quot;Public documents&quot;
# description: &quot;Determine whether the document should be publicly visible&quot;
# expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
#
# Example (Data Manipulation):
#
# title: &quot;Notification string&quot;
# description: &quot;Create a notification string with a timestamp.&quot;
# expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
#
# 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.
&quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
# syntax.
&quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
&quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
&quot;title&quot;: &quot;A String&quot;, # 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.
},
&quot;members&quot;: [ # 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`.
#
&quot;A String&quot;,
],
&quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
&quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
# The configuration determines which permission types are logged, and what
# identities, if any, are exempted from logging.
# An AuditConfig must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
# the union of the two AuditConfigs is used for that service: the log_types
# specified in each AuditConfig are enabled, and the exempted_members in each
# AuditLogConfig are exempted.
#
# Example Policy with multiple AuditConfigs:
#
# {
# &quot;audit_configs&quot;: [
# {
# &quot;service&quot;: &quot;allServices&quot;,
# &quot;audit_log_configs&quot;: [
# {
# &quot;log_type&quot;: &quot;DATA_READ&quot;,
# &quot;exempted_members&quot;: [
# &quot;user:jose@example.com&quot;
# ]
# },
# {
# &quot;log_type&quot;: &quot;DATA_WRITE&quot;
# },
# {
# &quot;log_type&quot;: &quot;ADMIN_READ&quot;
# }
# ]
# },
# {
# &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
# &quot;audit_log_configs&quot;: [
# {
# &quot;log_type&quot;: &quot;DATA_READ&quot;
# },
# {
# &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
# &quot;exempted_members&quot;: [
# &quot;user:aliya@example.com&quot;
# ]
# }
# ]
# }
# ]
# }
#
# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
# logging. It also exempts jose@example.com from DATA_READ logging, and
# aliya@example.com from DATA_WRITE logging.
&quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions.
# Example:
#
# {
# &quot;audit_log_configs&quot;: [
# {
# &quot;log_type&quot;: &quot;DATA_READ&quot;,
# &quot;exempted_members&quot;: [
# &quot;user:jose@example.com&quot;
# ]
# },
# {
# &quot;log_type&quot;: &quot;DATA_WRITE&quot;
# }
# ]
# }
#
# This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
# jose@example.com from DATA_READ logging.
&quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
# permission.
# Follows the same format of Binding.members.
&quot;A String&quot;,
],
&quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
},
],
&quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
&quot;etag&quot;: &quot;A String&quot;, # `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.
&quot;version&quot;: 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).
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Identity and Access Management (IAM) policy, which specifies access
# controls for Google Cloud resources.
#
#
# A `Policy` is a collection of `bindings`. A `binding` binds one or more
# `members` to a single `role`. Members can be user accounts, service accounts,
# Google groups, and domains (such as G Suite). A `role` is a named list of
# permissions; each `role` can be an IAM predefined role or a user-created
# custom role.
#
# 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:**
#
# {
# &quot;bindings&quot;: [
# {
# &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
# &quot;members&quot;: [
# &quot;user:mike@example.com&quot;,
# &quot;group:admins@example.com&quot;,
# &quot;domain:google.com&quot;,
# &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot;
# ]
# },
# {
# &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
# &quot;members&quot;: [
# &quot;user:eve@example.com&quot;
# ],
# &quot;condition&quot;: {
# &quot;title&quot;: &quot;expirable access&quot;,
# &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
# &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
# }
# }
# ],
# &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
# &quot;version&quot;: 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 &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
# - etag: BwWWja0YfJA=
# - version: 3
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
&quot;bindings&quot;: [ # 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`.
&quot;condition&quot;: { # 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: &quot;Summary size limit&quot;
# description: &quot;Determines if a summary is less than 100 chars&quot;
# expression: &quot;document.summary.size() &lt; 100&quot;
#
# Example (Equality):
#
# title: &quot;Requestor is owner&quot;
# description: &quot;Determines if requestor is the document owner&quot;
# expression: &quot;document.owner == request.auth.claims.email&quot;
#
# Example (Logic):
#
# title: &quot;Public documents&quot;
# description: &quot;Determine whether the document should be publicly visible&quot;
# expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
#
# Example (Data Manipulation):
#
# title: &quot;Notification string&quot;
# description: &quot;Create a notification string with a timestamp.&quot;
# expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
#
# 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.
&quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
# syntax.
&quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
&quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
&quot;title&quot;: &quot;A String&quot;, # 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.
},
&quot;members&quot;: [ # 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`.
#
&quot;A String&quot;,
],
&quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
&quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
# The configuration determines which permission types are logged, and what
# identities, if any, are exempted from logging.
# An AuditConfig must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
# the union of the two AuditConfigs is used for that service: the log_types
# specified in each AuditConfig are enabled, and the exempted_members in each
# AuditLogConfig are exempted.
#
# Example Policy with multiple AuditConfigs:
#
# {
# &quot;audit_configs&quot;: [
# {
# &quot;service&quot;: &quot;allServices&quot;,
# &quot;audit_log_configs&quot;: [
# {
# &quot;log_type&quot;: &quot;DATA_READ&quot;,
# &quot;exempted_members&quot;: [
# &quot;user:jose@example.com&quot;
# ]
# },
# {
# &quot;log_type&quot;: &quot;DATA_WRITE&quot;
# },
# {
# &quot;log_type&quot;: &quot;ADMIN_READ&quot;
# }
# ]
# },
# {
# &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
# &quot;audit_log_configs&quot;: [
# {
# &quot;log_type&quot;: &quot;DATA_READ&quot;
# },
# {
# &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
# &quot;exempted_members&quot;: [
# &quot;user:aliya@example.com&quot;
# ]
# }
# ]
# }
# ]
# }
#
# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
# logging. It also exempts jose@example.com from DATA_READ logging, and
# aliya@example.com from DATA_WRITE logging.
&quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions.
# Example:
#
# {
# &quot;audit_log_configs&quot;: [
# {
# &quot;log_type&quot;: &quot;DATA_READ&quot;,
# &quot;exempted_members&quot;: [
# &quot;user:jose@example.com&quot;
# ]
# },
# {
# &quot;log_type&quot;: &quot;DATA_WRITE&quot;
# }
# ]
# }
#
# This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
# jose@example.com from DATA_READ logging.
&quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
# permission.
# Follows the same format of Binding.members.
&quot;A String&quot;,
],
&quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
},
],
&quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
&quot;etag&quot;: &quot;A String&quot;, # `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.
&quot;version&quot;: 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="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
<pre>Returns permissions that the caller has on the specified table resource.
Args:
resource: string, REQUIRED: The resource for which the policy detail is being requested.
See the operation documentation for the appropriate value for this field. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for `TestIamPermissions` method.
&quot;permissions&quot;: [ # The set of permissions to check for the `resource`. Permissions with
# wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed. For more
# information see
# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
&quot;A String&quot;,
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for `TestIamPermissions` method.
&quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
# allowed.
&quot;A String&quot;,
],
}</pre>
</div>
</body></html>