docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html
index 3d25c3a..3fcd79e 100644
--- a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html
+++ b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html
@@ -90,13 +90,13 @@
<code><a href="#generateConsistencyToken">generateConsistencyToken(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Generates a consistency token for a Table, which can be used in</p>
<p class="toc_element">
- <code><a href="#get">get(name, x__xgafv=None, view=None)</a></code></p>
+ <code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets metadata information about the specified table.</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 or Backup resource.</p>
+<p class="firstline">Gets the access control policy for a Table resource.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None, view=None)</a></code></p>
+ <code><a href="#list">list(parent, pageToken=None, pageSize=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all tables served from a specified instance.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -106,7 +106,7 @@
<p class="firstline">Performs a series of column family modifications on the specified table.</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 or Backup resource.</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>
@@ -126,7 +126,7 @@
{ # Request message for
# google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency
- "consistencyToken": "A String", # Required. The token created using GenerateConsistencyToken for the Table.
+ "consistencyToken": "A String", # Required. The token created using GenerateConsistencyToken for the Table.
}
x__xgafv: string, V1 error format.
@@ -139,7 +139,7 @@
{ # Response message for
# google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency
- "consistent": True or False, # True only if the token is consistent. A token is consistent if replication
+ "consistent": True or False, # True only if the token is consistent. A token is consistent if replication
# has caught up with the restrictions specified in the request.
}</pre>
</div>
@@ -158,76 +158,76 @@
{ # Request message for
# google.bigtable.admin.v2.BigtableTableAdmin.CreateTable
- "table": { # A collection of user data indexed by row, column, and timestamp. # Required. The Table to create.
- # Each table is served using the resources of its parent cluster.
- "clusterStates": { # Output only. Map from cluster ID to per-cluster table state.
- # If it could not be determined whether or not the table has data in a
- # particular cluster (for example, if its zone is unavailable), then
- # there will be an entry for the cluster with UNKNOWN `replication_status`.
- # Views: `REPLICATION_VIEW`, `FULL`
- "a_key": { # The state of a table's data in a particular cluster.
- "replicationState": "A String", # Output only. The state of replication for the table in this cluster.
- },
- },
- "columnFamilies": { # (`CreationOnly`)
- # The column families configured for this table, mapped by column family ID.
- # Views: `SCHEMA_VIEW`, `FULL`
- "a_key": { # A set of columns within a table which share a common configuration.
- "gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.
- # Must serialize to at most 500 bytes.
- #
- # NOTE: Garbage collection executes opportunistically in the background, and
- # so it's possible for reads to return a cell even if it matches the active
- # GC expression for its family.
- "union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
- "rules": [ # Delete cells which would be deleted by any element of `rules`.
- # Object with schema name: GcRule
- ],
- },
- "intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
- "rules": [ # Only delete cells which would be deleted by every element of `rules`.
- # Object with schema name: GcRule
- ],
- },
- "maxAge": "A String", # Delete cells in a column older than the given age.
- # Values must be at least one millisecond, and will be truncated to
- # microsecond granularity.
- "maxNumVersions": 42, # Delete all cells in a column except the most recent N.
- },
- },
- },
- "name": "A String", # Output only. The unique name of the table. Values are of the form
- # `projects/<project>/instances/<instance>/tables/_a-zA-Z0-9*`.
- # Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`
- "granularity": "A String", # (`CreationOnly`)
- # The granularity (i.e. `MILLIS`) at which timestamps are stored in
- # this table. Timestamps not matching the granularity will be rejected.
- # If unspecified at creation time, the value will be set to `MILLIS`.
- # Views: `SCHEMA_VIEW`, `FULL`.
- },
- "initialSplits": [ # The optional list of row keys that will be used to initially split the
+ "tableId": "A String", # Required. The name by which the new table should be referred to within the parent
+ # instance, e.g., `foobar` rather than `{parent}/tables/foobar`.
+ # Maximum 50 characters.
+ "initialSplits": [ # The optional list of row keys that will be used to initially split the
# table into several tablets (tablets are similar to HBase regions).
# Given two split keys, `s1` and `s2`, three tablets will be created,
# spanning the key ranges: `[, s1), [s1, s2), [s2, )`.
#
# Example:
#
- # * Row keys := `["a", "apple", "custom", "customer_1", "customer_2",`
- # `"other", "zz"]`
- # * initial_split_keys := `["apple", "customer_1", "customer_2", "other"]`
+ # * Row keys := `["a", "apple", "custom", "customer_1", "customer_2",`
+ # `"other", "zz"]`
+ # * initial_split_keys := `["apple", "customer_1", "customer_2", "other"]`
# * Key assignment:
- # - Tablet 1 `[, apple) => {"a"}.`
- # - Tablet 2 `[apple, customer_1) => {"apple", "custom"}.`
- # - Tablet 3 `[customer_1, customer_2) => {"customer_1"}.`
- # - Tablet 4 `[customer_2, other) => {"customer_2"}.`
- # - Tablet 5 `[other, ) => {"other", "zz"}.`
+ # - Tablet 1 `[, apple) => {"a"}.`
+ # - Tablet 2 `[apple, customer_1) => {"apple", "custom"}.`
+ # - Tablet 3 `[customer_1, customer_2) => {"customer_1"}.`
+ # - Tablet 4 `[customer_2, other) => {"customer_2"}.`
+ # - Tablet 5 `[other, ) => {"other", "zz"}.`
{ # An initial split point for a newly created table.
- "key": "A String", # Row key to use as an initial tablet boundary.
+ "key": "A String", # Row key to use as an initial tablet boundary.
},
],
- "tableId": "A String", # Required. The name by which the new table should be referred to within the parent
- # instance, e.g., `foobar` rather than `{parent}/tables/foobar`.
- # Maximum 50 characters.
+ "table": { # A collection of user data indexed by row, column, and timestamp. # Required. The Table to create.
+ # Each table is served using the resources of its parent cluster.
+ "name": "A String", # Output only. The unique name of the table. Values are of the form
+ # `projects/<project>/instances/<instance>/tables/_a-zA-Z0-9*`.
+ # Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`
+ "clusterStates": { # Output only. Map from cluster ID to per-cluster table state.
+ # If it could not be determined whether or not the table has data in a
+ # particular cluster (for example, if its zone is unavailable), then
+ # there will be an entry for the cluster with UNKNOWN `replication_status`.
+ # Views: `REPLICATION_VIEW`, `FULL`
+ "a_key": { # The state of a table's data in a particular cluster.
+ "replicationState": "A String", # Output only. The state of replication for the table in this cluster.
+ },
+ },
+ "granularity": "A String", # (`CreationOnly`)
+ # The granularity (i.e. `MILLIS`) at which timestamps are stored in
+ # this table. Timestamps not matching the granularity will be rejected.
+ # If unspecified at creation time, the value will be set to `MILLIS`.
+ # Views: `SCHEMA_VIEW`, `FULL`.
+ "columnFamilies": { # (`CreationOnly`)
+ # The column families configured for this table, mapped by column family ID.
+ # Views: `SCHEMA_VIEW`, `FULL`
+ "a_key": { # A set of columns within a table which share a common configuration.
+ "gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.
+ # Must serialize to at most 500 bytes.
+ #
+ # NOTE: Garbage collection executes opportunistically in the background, and
+ # so it's possible for reads to return a cell even if it matches the active
+ # GC expression for its family.
+ "intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
+ "rules": [ # Only delete cells which would be deleted by every element of `rules`.
+ # Object with schema name: GcRule
+ ],
+ },
+ "union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
+ "rules": [ # Delete cells which would be deleted by any element of `rules`.
+ # Object with schema name: GcRule
+ ],
+ },
+ "maxNumVersions": 42, # Delete all cells in a column except the most recent N.
+ "maxAge": "A String", # Delete cells in a column older than the given age.
+ # Values must be at least one millisecond, and will be truncated to
+ # microsecond granularity.
+ },
+ },
+ },
+ },
}
x__xgafv: string, V1 error format.
@@ -240,50 +240,50 @@
{ # A collection of user data indexed by row, column, and timestamp.
# Each table is served using the resources of its parent cluster.
- "clusterStates": { # Output only. Map from cluster ID to per-cluster table state.
+ "name": "A String", # Output only. The unique name of the table. Values are of the form
+ # `projects/<project>/instances/<instance>/tables/_a-zA-Z0-9*`.
+ # Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`
+ "clusterStates": { # Output only. Map from cluster ID to per-cluster table state.
# If it could not be determined whether or not the table has data in a
# particular cluster (for example, if its zone is unavailable), then
# there will be an entry for the cluster with UNKNOWN `replication_status`.
# Views: `REPLICATION_VIEW`, `FULL`
- "a_key": { # The state of a table's data in a particular cluster.
- "replicationState": "A String", # Output only. The state of replication for the table in this cluster.
+ "a_key": { # The state of a table's data in a particular cluster.
+ "replicationState": "A String", # Output only. The state of replication for the table in this cluster.
},
},
- "columnFamilies": { # (`CreationOnly`)
- # The column families configured for this table, mapped by column family ID.
- # Views: `SCHEMA_VIEW`, `FULL`
- "a_key": { # A set of columns within a table which share a common configuration.
- "gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.
- # Must serialize to at most 500 bytes.
- #
- # NOTE: Garbage collection executes opportunistically in the background, and
- # so it's possible for reads to return a cell even if it matches the active
- # GC expression for its family.
- "union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
- "rules": [ # Delete cells which would be deleted by any element of `rules`.
- # Object with schema name: GcRule
- ],
- },
- "intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
- "rules": [ # Only delete cells which would be deleted by every element of `rules`.
- # Object with schema name: GcRule
- ],
- },
- "maxAge": "A String", # Delete cells in a column older than the given age.
- # Values must be at least one millisecond, and will be truncated to
- # microsecond granularity.
- "maxNumVersions": 42, # Delete all cells in a column except the most recent N.
- },
- },
- },
- "name": "A String", # Output only. The unique name of the table. Values are of the form
- # `projects/<project>/instances/<instance>/tables/_a-zA-Z0-9*`.
- # Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`
- "granularity": "A String", # (`CreationOnly`)
+ "granularity": "A String", # (`CreationOnly`)
# The granularity (i.e. `MILLIS`) at which timestamps are stored in
# this table. Timestamps not matching the granularity will be rejected.
# If unspecified at creation time, the value will be set to `MILLIS`.
# Views: `SCHEMA_VIEW`, `FULL`.
+ "columnFamilies": { # (`CreationOnly`)
+ # The column families configured for this table, mapped by column family ID.
+ # Views: `SCHEMA_VIEW`, `FULL`
+ "a_key": { # A set of columns within a table which share a common configuration.
+ "gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.
+ # Must serialize to at most 500 bytes.
+ #
+ # NOTE: Garbage collection executes opportunistically in the background, and
+ # so it's possible for reads to return a cell even if it matches the active
+ # GC expression for its family.
+ "intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
+ "rules": [ # Only delete cells which would be deleted by every element of `rules`.
+ # Object with schema name: GcRule
+ ],
+ },
+ "union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
+ "rules": [ # Delete cells which would be deleted by any element of `rules`.
+ # Object with schema name: GcRule
+ ],
+ },
+ "maxNumVersions": 42, # Delete all cells in a column except the most recent N.
+ "maxAge": "A String", # Delete cells in a column older than the given age.
+ # Values must be at least one millisecond, and will be truncated to
+ # microsecond granularity.
+ },
+ },
+ },
}</pre>
</div>
@@ -330,9 +330,9 @@
{ # Request message for
# google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange
- "rowKeyPrefix": "A String", # Delete all rows that start with this row key prefix. Prefix cannot be
+ "rowKeyPrefix": "A String", # Delete all rows that start with this row key prefix. Prefix cannot be
# zero length.
- "deleteAllDataFromTable": True or False, # Delete all rows in the table. Setting this to false is a no-op.
+ "deleteAllDataFromTable": True or False, # Delete all rows in the table. Setting this to false is a no-op.
}
x__xgafv: string, V1 error format.
@@ -383,80 +383,80 @@
{ # Response message for
# google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken
- "consistencyToken": "A String", # The generated consistency token.
+ "consistencyToken": "A String", # The generated consistency token.
}</pre>
</div>
<div class="method">
- <code class="details" id="get">get(name, x__xgafv=None, view=None)</code>
+ <code class="details" id="get">get(name, view=None, x__xgafv=None)</code>
<pre>Gets metadata information about the specified table.
Args:
name: string, Required. The unique name of the requested table.
Values are of the form
`projects/{project}/instances/{instance}/tables/{table}`. (required)
+ view: string, The view to be applied to the returned table's fields.
+Defaults to `SCHEMA_VIEW` if unspecified.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
- view: string, The view to be applied to the returned table's fields.
-Defaults to `SCHEMA_VIEW` if unspecified.
Returns:
An object of the form:
{ # A collection of user data indexed by row, column, and timestamp.
# Each table is served using the resources of its parent cluster.
- "clusterStates": { # Output only. Map from cluster ID to per-cluster table state.
+ "name": "A String", # Output only. The unique name of the table. Values are of the form
+ # `projects/<project>/instances/<instance>/tables/_a-zA-Z0-9*`.
+ # Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`
+ "clusterStates": { # Output only. Map from cluster ID to per-cluster table state.
# If it could not be determined whether or not the table has data in a
# particular cluster (for example, if its zone is unavailable), then
# there will be an entry for the cluster with UNKNOWN `replication_status`.
# Views: `REPLICATION_VIEW`, `FULL`
- "a_key": { # The state of a table's data in a particular cluster.
- "replicationState": "A String", # Output only. The state of replication for the table in this cluster.
+ "a_key": { # The state of a table's data in a particular cluster.
+ "replicationState": "A String", # Output only. The state of replication for the table in this cluster.
},
},
- "columnFamilies": { # (`CreationOnly`)
- # The column families configured for this table, mapped by column family ID.
- # Views: `SCHEMA_VIEW`, `FULL`
- "a_key": { # A set of columns within a table which share a common configuration.
- "gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.
- # Must serialize to at most 500 bytes.
- #
- # NOTE: Garbage collection executes opportunistically in the background, and
- # so it's possible for reads to return a cell even if it matches the active
- # GC expression for its family.
- "union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
- "rules": [ # Delete cells which would be deleted by any element of `rules`.
- # Object with schema name: GcRule
- ],
- },
- "intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
- "rules": [ # Only delete cells which would be deleted by every element of `rules`.
- # Object with schema name: GcRule
- ],
- },
- "maxAge": "A String", # Delete cells in a column older than the given age.
- # Values must be at least one millisecond, and will be truncated to
- # microsecond granularity.
- "maxNumVersions": 42, # Delete all cells in a column except the most recent N.
- },
- },
- },
- "name": "A String", # Output only. The unique name of the table. Values are of the form
- # `projects/<project>/instances/<instance>/tables/_a-zA-Z0-9*`.
- # Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`
- "granularity": "A String", # (`CreationOnly`)
+ "granularity": "A String", # (`CreationOnly`)
# The granularity (i.e. `MILLIS`) at which timestamps are stored in
# this table. Timestamps not matching the granularity will be rejected.
# If unspecified at creation time, the value will be set to `MILLIS`.
# Views: `SCHEMA_VIEW`, `FULL`.
+ "columnFamilies": { # (`CreationOnly`)
+ # The column families configured for this table, mapped by column family ID.
+ # Views: `SCHEMA_VIEW`, `FULL`
+ "a_key": { # A set of columns within a table which share a common configuration.
+ "gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.
+ # Must serialize to at most 500 bytes.
+ #
+ # NOTE: Garbage collection executes opportunistically in the background, and
+ # so it's possible for reads to return a cell even if it matches the active
+ # GC expression for its family.
+ "intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
+ "rules": [ # Only delete cells which would be deleted by every element of `rules`.
+ # Object with schema name: GcRule
+ ],
+ },
+ "union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
+ "rules": [ # Delete cells which would be deleted by any element of `rules`.
+ # Object with schema name: GcRule
+ ],
+ },
+ "maxNumVersions": 42, # Delete all cells in a column except the most recent N.
+ "maxAge": "A String", # Delete cells in a column older than the given age.
+ # Values must be at least one millisecond, and will be truncated to
+ # microsecond granularity.
+ },
+ },
+ },
}</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 or Backup resource.
+ <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.
@@ -467,9 +467,9 @@
The object takes the form of:
{ # Request message for `GetIamPolicy` method.
- "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to
+ "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to
# `GetIamPolicy`. This field is only used by Cloud IAM.
- "requestedPolicyVersion": 42, # Optional. The policy format version to be returned.
+ "requestedPolicyVersion": 42, # Optional. The policy format version to be returned.
#
# Valid values are 0, 1, and 3. Requests specifying an invalid value will be
# rejected.
@@ -506,28 +506,28 @@
# **JSON example:**
#
# {
- # "bindings": [
+ # "bindings": [
# {
- # "role": "roles/resourcemanager.organizationAdmin",
- # "members": [
- # "user:mike@example.com",
- # "group:admins@example.com",
- # "domain:google.com",
- # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+ # "role": "roles/resourcemanager.organizationAdmin",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
- # "role": "roles/resourcemanager.organizationViewer",
- # "members": ["user:eve@example.com"],
- # "condition": {
- # "title": "expirable access",
- # "description": "Does not grant access after Sep 2020",
- # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": ["user:eve@example.com"],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
# }
# }
# ],
- # "etag": "BwWWja0YfJA=",
- # "version": 3
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
# **YAML example:**
@@ -545,98 +545,25 @@
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
- # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
# - etag: BwWWja0YfJA=
# - version: 3
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "auditConfigs": [ # 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:
- #
- # {
- # "audit_configs": [
- # {
- # "service": "allServices"
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ",
- # "exempted_members": [
- # "user:jose@example.com"
- # ]
- # },
- # {
- # "log_type": "DATA_WRITE",
- # },
- # {
- # "log_type": "ADMIN_READ",
- # }
- # ]
- # },
- # {
- # "service": "sampleservice.googleapis.com"
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ",
- # },
- # {
- # "log_type": "DATA_WRITE",
- # "exempted_members": [
- # "user:aliya@example.com"
- # ]
- # }
- # ]
- # }
- # ]
- # }
- #
- # 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.
- "auditLogConfigs": [ # The configuration for logging of each type of permission.
- { # Provides the configuration for logging a type of permissions.
- # Example:
- #
- # {
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ",
- # "exempted_members": [
- # "user:jose@example.com"
- # ]
- # },
- # {
- # "log_type": "DATA_WRITE",
- # }
- # ]
- # }
- #
- # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
- # jose@example.com from DATA_READ logging.
- "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
- # permission.
- # Follows the same format of Binding.members.
- "A String",
- ],
- "logType": "A String", # The log type that this config enables.
- },
- ],
- "service": "A String", # 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.
- },
- ],
- "version": 42, # Specifies the format of the policy.
+ "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.
@@ -657,13 +584,140 @@
#
# 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
+ "auditConfigs": [ # 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:
+ #
+ # {
+ # "audit_configs": [
+ # {
+ # "service": "allServices"
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # },
+ # {
+ # "log_type": "ADMIN_READ",
+ # }
+ # ]
+ # },
+ # {
+ # "service": "sampleservice.googleapis.com"
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # "exempted_members": [
+ # "user:aliya@example.com"
+ # ]
+ # }
+ # ]
+ # }
+ # ]
+ # }
+ #
+ # 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.
+ "service": "A String", # 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.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions.
+ # Example:
+ #
+ # {
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # }
+ # ]
+ # }
+ #
+ # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+ # jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+ # permission.
+ # Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ },
+ ],
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "role": "A String", # Role that is assigned to `members`.
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ # NOTE: An unsatisfied condition will not allow user access via current
+ # binding. Different bindings, including their conditions, are examined
+ # independently.
+ # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+ # are documented at https://github.com/google/cel-spec.
+ #
+ # Example (Comparison):
+ #
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ },
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
# * `allUsers`: A special identifier that represents anyone who is
@@ -706,81 +760,23 @@
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
- "A String",
+ "A String",
],
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
- # NOTE: An unsatisfied condition will not allow user access via current
- # binding. Different bindings, including their conditions, are examined
- # independently.
- # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
- # are documented at https://github.com/google/cel-spec.
- #
- # Example (Comparison):
- #
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
- #
- # Example (Equality):
- #
- # title: "Requestor is owner"
- # description: "Determines if requestor is the document owner"
- # expression: "document.owner == request.auth.claims.email"
- #
- # Example (Logic):
- #
- # title: "Public documents"
- # description: "Determine whether the document should be publicly visible"
- # expression: "document.type != 'private' && document.type != 'internal'"
- #
- # Example (Data Manipulation):
- #
- # title: "Notification string"
- # description: "Create a notification string with a timestamp."
- # expression: "'New message received at ' + string(document.create_time)"
- #
- # The exact variables and functions that may be referenced within an expression
- # are determined by the service that evaluates it. See the service
- # documentation for additional information.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
- # its purpose. This can be used e.g. in UIs which allow to enter the
- # expression.
- },
+ "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.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None, view=None)</code>
+ <code class="details" id="list">list(parent, pageToken=None, pageSize=None, view=None, x__xgafv=None)</code>
<pre>Lists all tables served from a specified instance.
Args:
parent: string, Required. The unique name of the instance for which tables should be listed.
Values are of the form `projects/{project}/instances/{instance}`. (required)
pageToken: string, The value of `next_page_token` returned by a previous call.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
pageSize: integer, Maximum number of results per page.
A page_size of zero lets the server choose the number of items to return.
@@ -790,64 +786,68 @@
Following the first request, subsequent paginated calls are not required
to pass a page_size. If a page_size is set in subsequent calls, it must
match the page_size given in the first request.
- view: string, The view to be applied to the returned tables' fields.
+ view: string, The view to be applied to the returned tables' fields.
Only NAME_ONLY view (default) and REPLICATION_VIEW are supported.
+ 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
# google.bigtable.admin.v2.BigtableTableAdmin.ListTables
- "nextPageToken": "A String", # Set if not all tables could be returned in a single response.
+ "nextPageToken": "A String", # Set if not all tables could be returned in a single response.
# Pass this value to `page_token` in another request to get the next
# page of results.
- "tables": [ # The tables present in the requested instance.
+ "tables": [ # The tables present in the requested instance.
{ # A collection of user data indexed by row, column, and timestamp.
# Each table is served using the resources of its parent cluster.
- "clusterStates": { # Output only. Map from cluster ID to per-cluster table state.
+ "name": "A String", # Output only. The unique name of the table. Values are of the form
+ # `projects/<project>/instances/<instance>/tables/_a-zA-Z0-9*`.
+ # Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`
+ "clusterStates": { # Output only. Map from cluster ID to per-cluster table state.
# If it could not be determined whether or not the table has data in a
# particular cluster (for example, if its zone is unavailable), then
# there will be an entry for the cluster with UNKNOWN `replication_status`.
# Views: `REPLICATION_VIEW`, `FULL`
- "a_key": { # The state of a table's data in a particular cluster.
- "replicationState": "A String", # Output only. The state of replication for the table in this cluster.
+ "a_key": { # The state of a table's data in a particular cluster.
+ "replicationState": "A String", # Output only. The state of replication for the table in this cluster.
},
},
- "columnFamilies": { # (`CreationOnly`)
- # The column families configured for this table, mapped by column family ID.
- # Views: `SCHEMA_VIEW`, `FULL`
- "a_key": { # A set of columns within a table which share a common configuration.
- "gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.
- # Must serialize to at most 500 bytes.
- #
- # NOTE: Garbage collection executes opportunistically in the background, and
- # so it's possible for reads to return a cell even if it matches the active
- # GC expression for its family.
- "union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
- "rules": [ # Delete cells which would be deleted by any element of `rules`.
- # Object with schema name: GcRule
- ],
- },
- "intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
- "rules": [ # Only delete cells which would be deleted by every element of `rules`.
- # Object with schema name: GcRule
- ],
- },
- "maxAge": "A String", # Delete cells in a column older than the given age.
- # Values must be at least one millisecond, and will be truncated to
- # microsecond granularity.
- "maxNumVersions": 42, # Delete all cells in a column except the most recent N.
- },
- },
- },
- "name": "A String", # Output only. The unique name of the table. Values are of the form
- # `projects/<project>/instances/<instance>/tables/_a-zA-Z0-9*`.
- # Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`
- "granularity": "A String", # (`CreationOnly`)
+ "granularity": "A String", # (`CreationOnly`)
# The granularity (i.e. `MILLIS`) at which timestamps are stored in
# this table. Timestamps not matching the granularity will be rejected.
# If unspecified at creation time, the value will be set to `MILLIS`.
# Views: `SCHEMA_VIEW`, `FULL`.
+ "columnFamilies": { # (`CreationOnly`)
+ # The column families configured for this table, mapped by column family ID.
+ # Views: `SCHEMA_VIEW`, `FULL`
+ "a_key": { # A set of columns within a table which share a common configuration.
+ "gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.
+ # Must serialize to at most 500 bytes.
+ #
+ # NOTE: Garbage collection executes opportunistically in the background, and
+ # so it's possible for reads to return a cell even if it matches the active
+ # GC expression for its family.
+ "intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
+ "rules": [ # Only delete cells which would be deleted by every element of `rules`.
+ # Object with schema name: GcRule
+ ],
+ },
+ "union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
+ "rules": [ # Delete cells which would be deleted by any element of `rules`.
+ # Object with schema name: GcRule
+ ],
+ },
+ "maxNumVersions": 42, # Delete all cells in a column except the most recent N.
+ "maxAge": "A String", # Delete cells in a column older than the given age.
+ # Values must be at least one millisecond, and will be truncated to
+ # microsecond granularity.
+ },
+ },
+ },
},
],
}</pre>
@@ -862,7 +862,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
@@ -883,62 +883,62 @@
{ # Request message for
# google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies
- "modifications": [ # Required. Modifications to be atomically applied to the specified table's families.
+ "modifications": [ # Required. Modifications to be atomically applied to the specified table's families.
# Entries are applied in order, meaning that earlier modifications can be
# masked by later ones (in the case of repeated updates to the same family,
# for example).
{ # A create, update, or delete of a particular column family.
- "create": { # A set of columns within a table which share a common configuration. # Create a new column family with the specified schema, or fail if
- # one already exists with the given ID.
- "gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.
- # Must serialize to at most 500 bytes.
- #
- # NOTE: Garbage collection executes opportunistically in the background, and
- # so it's possible for reads to return a cell even if it matches the active
- # GC expression for its family.
- "union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
- "rules": [ # Delete cells which would be deleted by any element of `rules`.
- # Object with schema name: GcRule
- ],
- },
- "intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
- "rules": [ # Only delete cells which would be deleted by every element of `rules`.
- # Object with schema name: GcRule
- ],
- },
- "maxAge": "A String", # Delete cells in a column older than the given age.
- # Values must be at least one millisecond, and will be truncated to
- # microsecond granularity.
- "maxNumVersions": 42, # Delete all cells in a column except the most recent N.
- },
- },
- "drop": True or False, # Drop (delete) the column family with the given ID, or fail if no such
- # family exists.
- "id": "A String", # The ID of the column family to be modified.
- "update": { # A set of columns within a table which share a common configuration. # Update an existing column family to the specified schema, or fail
+ "update": { # A set of columns within a table which share a common configuration. # Update an existing column family to the specified schema, or fail
# if no column family exists with the given ID.
- "gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.
+ "gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.
# Must serialize to at most 500 bytes.
#
# NOTE: Garbage collection executes opportunistically in the background, and
- # so it's possible for reads to return a cell even if it matches the active
+ # so it's possible for reads to return a cell even if it matches the active
# GC expression for its family.
- "union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
- "rules": [ # Delete cells which would be deleted by any element of `rules`.
+ "intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
+ "rules": [ # Only delete cells which would be deleted by every element of `rules`.
# Object with schema name: GcRule
],
},
- "intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
- "rules": [ # Only delete cells which would be deleted by every element of `rules`.
+ "union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
+ "rules": [ # Delete cells which would be deleted by any element of `rules`.
# Object with schema name: GcRule
],
},
- "maxAge": "A String", # Delete cells in a column older than the given age.
+ "maxNumVersions": 42, # Delete all cells in a column except the most recent N.
+ "maxAge": "A String", # Delete cells in a column older than the given age.
# Values must be at least one millisecond, and will be truncated to
# microsecond granularity.
- "maxNumVersions": 42, # Delete all cells in a column except the most recent N.
},
},
+ "create": { # A set of columns within a table which share a common configuration. # Create a new column family with the specified schema, or fail if
+ # one already exists with the given ID.
+ "gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.
+ # Must serialize to at most 500 bytes.
+ #
+ # NOTE: Garbage collection executes opportunistically in the background, and
+ # so it's possible for reads to return a cell even if it matches the active
+ # GC expression for its family.
+ "intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
+ "rules": [ # Only delete cells which would be deleted by every element of `rules`.
+ # Object with schema name: GcRule
+ ],
+ },
+ "union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
+ "rules": [ # Delete cells which would be deleted by any element of `rules`.
+ # Object with schema name: GcRule
+ ],
+ },
+ "maxNumVersions": 42, # Delete all cells in a column except the most recent N.
+ "maxAge": "A String", # Delete cells in a column older than the given age.
+ # Values must be at least one millisecond, and will be truncated to
+ # microsecond granularity.
+ },
+ },
+ "drop": True or False, # Drop (delete) the column family with the given ID, or fail if no such
+ # family exists.
+ "id": "A String", # The ID of the column family to be modified.
},
],
}
@@ -953,56 +953,56 @@
{ # A collection of user data indexed by row, column, and timestamp.
# Each table is served using the resources of its parent cluster.
- "clusterStates": { # Output only. Map from cluster ID to per-cluster table state.
+ "name": "A String", # Output only. The unique name of the table. Values are of the form
+ # `projects/<project>/instances/<instance>/tables/_a-zA-Z0-9*`.
+ # Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`
+ "clusterStates": { # Output only. Map from cluster ID to per-cluster table state.
# If it could not be determined whether or not the table has data in a
# particular cluster (for example, if its zone is unavailable), then
# there will be an entry for the cluster with UNKNOWN `replication_status`.
# Views: `REPLICATION_VIEW`, `FULL`
- "a_key": { # The state of a table's data in a particular cluster.
- "replicationState": "A String", # Output only. The state of replication for the table in this cluster.
+ "a_key": { # The state of a table's data in a particular cluster.
+ "replicationState": "A String", # Output only. The state of replication for the table in this cluster.
},
},
- "columnFamilies": { # (`CreationOnly`)
- # The column families configured for this table, mapped by column family ID.
- # Views: `SCHEMA_VIEW`, `FULL`
- "a_key": { # A set of columns within a table which share a common configuration.
- "gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.
- # Must serialize to at most 500 bytes.
- #
- # NOTE: Garbage collection executes opportunistically in the background, and
- # so it's possible for reads to return a cell even if it matches the active
- # GC expression for its family.
- "union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
- "rules": [ # Delete cells which would be deleted by any element of `rules`.
- # Object with schema name: GcRule
- ],
- },
- "intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
- "rules": [ # Only delete cells which would be deleted by every element of `rules`.
- # Object with schema name: GcRule
- ],
- },
- "maxAge": "A String", # Delete cells in a column older than the given age.
- # Values must be at least one millisecond, and will be truncated to
- # microsecond granularity.
- "maxNumVersions": 42, # Delete all cells in a column except the most recent N.
- },
- },
- },
- "name": "A String", # Output only. The unique name of the table. Values are of the form
- # `projects/<project>/instances/<instance>/tables/_a-zA-Z0-9*`.
- # Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`
- "granularity": "A String", # (`CreationOnly`)
+ "granularity": "A String", # (`CreationOnly`)
# The granularity (i.e. `MILLIS`) at which timestamps are stored in
# this table. Timestamps not matching the granularity will be rejected.
# If unspecified at creation time, the value will be set to `MILLIS`.
# Views: `SCHEMA_VIEW`, `FULL`.
+ "columnFamilies": { # (`CreationOnly`)
+ # The column families configured for this table, mapped by column family ID.
+ # Views: `SCHEMA_VIEW`, `FULL`
+ "a_key": { # A set of columns within a table which share a common configuration.
+ "gcRule": { # Rule for determining which cells to delete during garbage collection. # Garbage collection rule specified as a protobuf.
+ # Must serialize to at most 500 bytes.
+ #
+ # NOTE: Garbage collection executes opportunistically in the background, and
+ # so it's possible for reads to return a cell even if it matches the active
+ # GC expression for its family.
+ "intersection": { # A GcRule which deletes cells matching all of the given rules. # Delete cells that would be deleted by every nested rule.
+ "rules": [ # Only delete cells which would be deleted by every element of `rules`.
+ # Object with schema name: GcRule
+ ],
+ },
+ "union": { # A GcRule which deletes cells matching any of the given rules. # Delete cells that would be deleted by any nested rule.
+ "rules": [ # Delete cells which would be deleted by any element of `rules`.
+ # Object with schema name: GcRule
+ ],
+ },
+ "maxNumVersions": 42, # Delete all cells in a column except the most recent N.
+ "maxAge": "A String", # Delete cells in a column older than the given age.
+ # Values must be at least one millisecond, and will be truncated to
+ # microsecond granularity.
+ },
+ },
+ },
}</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 or Backup resource.
+ <pre>Sets the access control policy on a Table resource.
Replaces any existing policy.
Args:
@@ -1012,7 +1012,7 @@
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
- "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of
+ "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of
# the policy is limited to a few 10s of KB. An empty policy is a
# valid policy but certain Cloud Platform services (such as Projects)
# might reject them.
@@ -1033,28 +1033,28 @@
# **JSON example:**
#
# {
- # "bindings": [
+ # "bindings": [
# {
- # "role": "roles/resourcemanager.organizationAdmin",
- # "members": [
- # "user:mike@example.com",
- # "group:admins@example.com",
- # "domain:google.com",
- # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+ # "role": "roles/resourcemanager.organizationAdmin",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
- # "role": "roles/resourcemanager.organizationViewer",
- # "members": ["user:eve@example.com"],
- # "condition": {
- # "title": "expirable access",
- # "description": "Does not grant access after Sep 2020",
- # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": ["user:eve@example.com"],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
# }
# }
# ],
- # "etag": "BwWWja0YfJA=",
- # "version": 3
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
# **YAML example:**
@@ -1072,98 +1072,25 @@
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
- # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
# - etag: BwWWja0YfJA=
# - version: 3
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "auditConfigs": [ # 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:
- #
- # {
- # "audit_configs": [
- # {
- # "service": "allServices"
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ",
- # "exempted_members": [
- # "user:jose@example.com"
- # ]
- # },
- # {
- # "log_type": "DATA_WRITE",
- # },
- # {
- # "log_type": "ADMIN_READ",
- # }
- # ]
- # },
- # {
- # "service": "sampleservice.googleapis.com"
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ",
- # },
- # {
- # "log_type": "DATA_WRITE",
- # "exempted_members": [
- # "user:aliya@example.com"
- # ]
- # }
- # ]
- # }
- # ]
- # }
- #
- # 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.
- "auditLogConfigs": [ # The configuration for logging of each type of permission.
- { # Provides the configuration for logging a type of permissions.
- # Example:
- #
- # {
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ",
- # "exempted_members": [
- # "user:jose@example.com"
- # ]
- # },
- # {
- # "log_type": "DATA_WRITE",
- # }
- # ]
- # }
- #
- # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
- # jose@example.com from DATA_READ logging.
- "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
- # permission.
- # Follows the same format of Binding.members.
- "A String",
- ],
- "logType": "A String", # The log type that this config enables.
- },
- ],
- "service": "A String", # 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.
- },
- ],
- "version": 42, # Specifies the format of the policy.
+ "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.
@@ -1184,13 +1111,140 @@
#
# 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
+ "auditConfigs": [ # 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:
+ #
+ # {
+ # "audit_configs": [
+ # {
+ # "service": "allServices"
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # },
+ # {
+ # "log_type": "ADMIN_READ",
+ # }
+ # ]
+ # },
+ # {
+ # "service": "sampleservice.googleapis.com"
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # "exempted_members": [
+ # "user:aliya@example.com"
+ # ]
+ # }
+ # ]
+ # }
+ # ]
+ # }
+ #
+ # 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.
+ "service": "A String", # 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.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions.
+ # Example:
+ #
+ # {
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # }
+ # ]
+ # }
+ #
+ # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+ # jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+ # permission.
+ # Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ },
+ ],
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "role": "A String", # Role that is assigned to `members`.
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ # NOTE: An unsatisfied condition will not allow user access via current
+ # binding. Different bindings, including their conditions, are examined
+ # independently.
+ # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+ # are documented at https://github.com/google/cel-spec.
+ #
+ # Example (Comparison):
+ #
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ },
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
# * `allUsers`: A special identifier that represents anyone who is
@@ -1233,71 +1287,17 @@
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
- "A String",
+ "A String",
],
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
- # NOTE: An unsatisfied condition will not allow user access via current
- # binding. Different bindings, including their conditions, are examined
- # independently.
- # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
- # are documented at https://github.com/google/cel-spec.
- #
- # Example (Comparison):
- #
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
- #
- # Example (Equality):
- #
- # title: "Requestor is owner"
- # description: "Determines if requestor is the document owner"
- # expression: "document.owner == request.auth.claims.email"
- #
- # Example (Logic):
- #
- # title: "Public documents"
- # description: "Determine whether the document should be publicly visible"
- # expression: "document.type != 'private' && document.type != 'internal'"
- #
- # Example (Data Manipulation):
- #
- # title: "Notification string"
- # description: "Create a notification string with a timestamp."
- # expression: "'New message received at ' + string(document.create_time)"
- #
- # The exact variables and functions that may be referenced within an expression
- # are determined by the service that evaluates it. See the service
- # documentation for additional information.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
- # its purpose. This can be used e.g. in UIs which allow to enter the
- # expression.
- },
+ "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.
},
- "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
+ "updateMask": "A String", # 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: "bindings, etag"
+ # paths: "bindings, etag"
# This field is only used by Cloud IAM.
}
@@ -1327,28 +1327,28 @@
# **JSON example:**
#
# {
- # "bindings": [
+ # "bindings": [
# {
- # "role": "roles/resourcemanager.organizationAdmin",
- # "members": [
- # "user:mike@example.com",
- # "group:admins@example.com",
- # "domain:google.com",
- # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+ # "role": "roles/resourcemanager.organizationAdmin",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
- # "role": "roles/resourcemanager.organizationViewer",
- # "members": ["user:eve@example.com"],
- # "condition": {
- # "title": "expirable access",
- # "description": "Does not grant access after Sep 2020",
- # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": ["user:eve@example.com"],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
# }
# }
# ],
- # "etag": "BwWWja0YfJA=",
- # "version": 3
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
# **YAML example:**
@@ -1366,98 +1366,25 @@
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
- # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
# - etag: BwWWja0YfJA=
# - version: 3
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "auditConfigs": [ # 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:
- #
- # {
- # "audit_configs": [
- # {
- # "service": "allServices"
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ",
- # "exempted_members": [
- # "user:jose@example.com"
- # ]
- # },
- # {
- # "log_type": "DATA_WRITE",
- # },
- # {
- # "log_type": "ADMIN_READ",
- # }
- # ]
- # },
- # {
- # "service": "sampleservice.googleapis.com"
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ",
- # },
- # {
- # "log_type": "DATA_WRITE",
- # "exempted_members": [
- # "user:aliya@example.com"
- # ]
- # }
- # ]
- # }
- # ]
- # }
- #
- # 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.
- "auditLogConfigs": [ # The configuration for logging of each type of permission.
- { # Provides the configuration for logging a type of permissions.
- # Example:
- #
- # {
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ",
- # "exempted_members": [
- # "user:jose@example.com"
- # ]
- # },
- # {
- # "log_type": "DATA_WRITE",
- # }
- # ]
- # }
- #
- # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
- # jose@example.com from DATA_READ logging.
- "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
- # permission.
- # Follows the same format of Binding.members.
- "A String",
- ],
- "logType": "A String", # The log type that this config enables.
- },
- ],
- "service": "A String", # 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.
- },
- ],
- "version": 42, # Specifies the format of the policy.
+ "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.
@@ -1478,13 +1405,140 @@
#
# 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
+ "auditConfigs": [ # 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:
+ #
+ # {
+ # "audit_configs": [
+ # {
+ # "service": "allServices"
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # },
+ # {
+ # "log_type": "ADMIN_READ",
+ # }
+ # ]
+ # },
+ # {
+ # "service": "sampleservice.googleapis.com"
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # "exempted_members": [
+ # "user:aliya@example.com"
+ # ]
+ # }
+ # ]
+ # }
+ # ]
+ # }
+ #
+ # 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.
+ "service": "A String", # 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.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions.
+ # Example:
+ #
+ # {
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # }
+ # ]
+ # }
+ #
+ # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+ # jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+ # permission.
+ # Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ },
+ ],
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "role": "A String", # Role that is assigned to `members`.
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ # NOTE: An unsatisfied condition will not allow user access via current
+ # binding. Different bindings, including their conditions, are examined
+ # independently.
+ # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+ # are documented at https://github.com/google/cel-spec.
+ #
+ # Example (Comparison):
+ #
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ },
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
# * `allUsers`: A special identifier that represents anyone who is
@@ -1527,66 +1581,12 @@
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
- "A String",
+ "A String",
],
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
- # NOTE: An unsatisfied condition will not allow user access via current
- # binding. Different bindings, including their conditions, are examined
- # independently.
- # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
- # are documented at https://github.com/google/cel-spec.
- #
- # Example (Comparison):
- #
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
- #
- # Example (Equality):
- #
- # title: "Requestor is owner"
- # description: "Determines if requestor is the document owner"
- # expression: "document.owner == request.auth.claims.email"
- #
- # Example (Logic):
- #
- # title: "Public documents"
- # description: "Determine whether the document should be publicly visible"
- # expression: "document.type != 'private' && document.type != 'internal'"
- #
- # Example (Data Manipulation):
- #
- # title: "Notification string"
- # description: "Create a notification string with a timestamp."
- # expression: "'New message received at ' + string(document.create_time)"
- #
- # The exact variables and functions that may be referenced within an expression
- # are determined by the service that evaluates it. See the service
- # documentation for additional information.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
- # its purpose. This can be used e.g. in UIs which allow to enter the
- # expression.
- },
+ "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.
}</pre>
</div>
@@ -1601,11 +1601,11 @@
The object takes the form of:
{ # Request message for `TestIamPermissions` method.
- "permissions": [ # The set of permissions to check for the `resource`. Permissions with
- # wildcards (such as '*' or 'storage.*') are not allowed. For more
+ "permissions": [ # The set of permissions to check for the `resource`. Permissions with
+ # wildcards (such as '*' or 'storage.*') are not allowed. For more
# information see
# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
- "A String",
+ "A String",
],
}
@@ -1618,9 +1618,9 @@
An object of the form:
{ # Response message for `TestIamPermissions` method.
- "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
# allowed.
- "A String",
+ "A String",
],
}</pre>
</div>