docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html
index 3fcd79e..7b13648 100644
--- a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html
+++ b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html
@@ -158,29 +158,6 @@
{ # Request message for
# google.bigtable.admin.v2.BigtableTableAdmin.CreateTable
- "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"]`
- # * 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"}.`
- { # An initial split point for a newly created table.
- "key": "A String", # Row key to use as an initial tablet boundary.
- },
- ],
"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
@@ -210,6 +187,10 @@
# 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.
+ "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.
"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
@@ -220,14 +201,33 @@
# 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.
},
},
},
},
+ "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"]`
+ # * 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"}.`
+ { # An initial split point for a newly created table.
+ "key": "A String", # Row key to use as an initial tablet boundary.
+ },
+ ],
}
x__xgafv: string, V1 error format.
@@ -267,6 +267,10 @@
# 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.
+ "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.
"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
@@ -277,10 +281,6 @@
# 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.
},
},
},
@@ -434,6 +434,10 @@
# 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.
+ "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.
"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
@@ -444,10 +448,6 @@
# 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.
},
},
},
@@ -551,18 +551,6 @@
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
- # prevent simultaneous updates of a policy from overwriting each other.
- # It is strongly suggested that systems make use of the `etag` in the
- # read-modify-write cycle to perform policy updates in order to avoid race
- # conditions: An `etag` is returned in the response to `getIamPolicy`, and
- # systems are expected to put that etag in the request to `setIamPolicy` to
- # ensure that their change will be applied to the same version of the policy.
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy.
#
# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
@@ -659,12 +647,12 @@
#
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
# jose@example.com from DATA_READ logging.
+ "logType": "A String", # The log type that this config enables.
"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.
},
],
},
@@ -707,15 +695,15 @@
# 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.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
},
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
@@ -766,6 +754,18 @@
# 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>
@@ -798,9 +798,6 @@
{ # Response message for
# google.bigtable.admin.v2.BigtableTableAdmin.ListTables
- "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.
{ # A collection of user data indexed by row, column, and timestamp.
# Each table is served using the resources of its parent cluster.
@@ -831,6 +828,10 @@
# 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.
+ "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.
"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
@@ -841,15 +842,14 @@
# 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.
},
},
},
},
],
+ "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.
}</pre>
</div>
@@ -888,6 +888,7 @@
# 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.
+ "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
# 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.
@@ -896,6 +897,10 @@
# 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.
+ "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.
"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
@@ -906,10 +911,6 @@
# 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.
},
},
"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
@@ -920,6 +921,10 @@
# 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.
+ "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.
"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
@@ -930,15 +935,10 @@
# 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.
},
],
}
@@ -980,6 +980,10 @@
# 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.
+ "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.
"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
@@ -990,10 +994,6 @@
# 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.
},
},
},
@@ -1078,18 +1078,6 @@
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
- # prevent simultaneous updates of a policy from overwriting each other.
- # It is strongly suggested that systems make use of the `etag` in the
- # read-modify-write cycle to perform policy updates in order to avoid race
- # conditions: An `etag` is returned in the response to `getIamPolicy`, and
- # systems are expected to put that etag in the request to `setIamPolicy` to
- # ensure that their change will be applied to the same version of the policy.
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy.
#
# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
@@ -1186,12 +1174,12 @@
#
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
# jose@example.com from DATA_READ logging.
+ "logType": "A String", # The log type that this config enables.
"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.
},
],
},
@@ -1234,15 +1222,15 @@
# 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.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
},
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
@@ -1293,6 +1281,18 @@
# 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
# the fields in the mask will be modified. If no mask is provided, the
@@ -1372,18 +1372,6 @@
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
- # prevent simultaneous updates of a policy from overwriting each other.
- # It is strongly suggested that systems make use of the `etag` in the
- # read-modify-write cycle to perform policy updates in order to avoid race
- # conditions: An `etag` is returned in the response to `getIamPolicy`, and
- # systems are expected to put that etag in the request to `setIamPolicy` to
- # ensure that their change will be applied to the same version of the policy.
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
"version": 42, # Specifies the format of the policy.
#
# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
@@ -1480,12 +1468,12 @@
#
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
# jose@example.com from DATA_READ logging.
+ "logType": "A String", # The log type that this config enables.
"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.
},
],
},
@@ -1528,15 +1516,15 @@
# 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.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
},
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
@@ -1587,6 +1575,18 @@
# 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>