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.clusters.html b/docs/dyn/bigtableadmin_v2.projects.instances.clusters.html
index 94b553d..04f9fac 100644
--- a/docs/dyn/bigtableadmin_v2.projects.instances.clusters.html
+++ b/docs/dyn/bigtableadmin_v2.projects.instances.clusters.html
@@ -112,19 +112,19 @@
{ # A resizable group of nodes in a particular cloud location, capable
# of serving all Tables in the parent
# Instance.
- "defaultStorageType": "A String", # (`CreationOnly`)
- # The type of storage used by this cluster to serve its
- # parent instance's tables, unless explicitly overridden.
- "serveNodes": 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher
+ "serveNodes": 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher
# throughput and more consistent performance.
- "state": "A String", # (`OutputOnly`)
- # The current state of the cluster.
- "location": "A String", # (`CreationOnly`)
- # The location where this cluster's nodes and storage reside. For best
+ "defaultStorageType": "A String", # (`CreationOnly`)
+ # The type of storage used by this cluster to serve its
+ # parent instance's tables, unless explicitly overridden.
+ "location": "A String", # (`CreationOnly`)
+ # The location where this cluster's nodes and storage reside. For best
# performance, clients should be located as close as possible to this
# cluster. Currently only zones are supported, so values should be of the
# form `projects/{project}/locations/{zone}`.
- "name": "A String", # Required. (`OutputOnly`)
+ "state": "A String", # (`OutputOnly`)
+ # The current state of the cluster.
+ "name": "A String", # Required. (`OutputOnly`)
# The unique name of the cluster. Values are of the form
# `projects/{project}/instances/{instance}/clusters/a-z*`.
}
@@ -142,7 +142,16 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "response": { # The normal response of the operation in case of success. If the original
+ "metadata": { # Service-specific metadata associated with the operation. It typically
+ # contains progress information and common metadata such as create time.
+ # Some services might not provide such metadata. Any method that returns a
+ # long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
+ "response": { # The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
# `Get`/`Create`/`Update`, the response should be the resource. For other
@@ -150,35 +159,26 @@
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "metadata": { # Service-specific metadata associated with the operation. It typically
- # contains progress information and common metadata such as create time.
- # Some services might not provide such metadata. Any method that returns a
- # long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
- # If `true`, the operation is completed, and either `error` or `response` is
- # available.
- "name": "A String", # The server-assigned name, which is only unique within the same service that
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should be a resource name ending with `operations/{unique_id}`.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
# three pieces of data: error code, error message, and error details.
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
- "message": "A String", # A developer-facing error message, which should be in English. Any
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
+ "details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
@@ -230,19 +230,19 @@
{ # A resizable group of nodes in a particular cloud location, capable
# of serving all Tables in the parent
# Instance.
- "defaultStorageType": "A String", # (`CreationOnly`)
- # The type of storage used by this cluster to serve its
- # parent instance's tables, unless explicitly overridden.
- "serveNodes": 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher
+ "serveNodes": 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher
# throughput and more consistent performance.
- "state": "A String", # (`OutputOnly`)
- # The current state of the cluster.
- "location": "A String", # (`CreationOnly`)
- # The location where this cluster's nodes and storage reside. For best
+ "defaultStorageType": "A String", # (`CreationOnly`)
+ # The type of storage used by this cluster to serve its
+ # parent instance's tables, unless explicitly overridden.
+ "location": "A String", # (`CreationOnly`)
+ # The location where this cluster's nodes and storage reside. For best
# performance, clients should be located as close as possible to this
# cluster. Currently only zones are supported, so values should be of the
# form `projects/{project}/locations/{zone}`.
- "name": "A String", # Required. (`OutputOnly`)
+ "state": "A String", # (`OutputOnly`)
+ # The current state of the cluster.
+ "name": "A String", # Required. (`OutputOnly`)
# The unique name of the cluster. Values are of the form
# `projects/{project}/instances/{instance}/clusters/a-z*`.
}</pre>
@@ -255,7 +255,7 @@
Args:
parent: string, Required. The unique name of the instance for which a list of clusters is requested.
Values are of the form `projects/{project}/instances/{instance}`.
-Use `{instance} = '-'` to list Clusters for all Instances in a project,
+Use `{instance} = '-'` to list Clusters for all Instances in a project,
e.g., `projects/myproject/instances/-`. (required)
pageToken: string, DEPRECATED: This field is unused and ignored.
x__xgafv: string, V1 error format.
@@ -267,35 +267,35 @@
An object of the form:
{ # Response message for BigtableInstanceAdmin.ListClusters.
- "nextPageToken": "A String", # DEPRECATED: This field is unused and ignored.
- "clusters": [ # The list of requested clusters.
+ "clusters": [ # The list of requested clusters.
{ # A resizable group of nodes in a particular cloud location, capable
# of serving all Tables in the parent
# Instance.
- "defaultStorageType": "A String", # (`CreationOnly`)
- # The type of storage used by this cluster to serve its
- # parent instance's tables, unless explicitly overridden.
- "serveNodes": 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher
+ "serveNodes": 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher
# throughput and more consistent performance.
- "state": "A String", # (`OutputOnly`)
- # The current state of the cluster.
- "location": "A String", # (`CreationOnly`)
- # The location where this cluster's nodes and storage reside. For best
+ "defaultStorageType": "A String", # (`CreationOnly`)
+ # The type of storage used by this cluster to serve its
+ # parent instance's tables, unless explicitly overridden.
+ "location": "A String", # (`CreationOnly`)
+ # The location where this cluster's nodes and storage reside. For best
# performance, clients should be located as close as possible to this
# cluster. Currently only zones are supported, so values should be of the
# form `projects/{project}/locations/{zone}`.
- "name": "A String", # Required. (`OutputOnly`)
+ "state": "A String", # (`OutputOnly`)
+ # The current state of the cluster.
+ "name": "A String", # Required. (`OutputOnly`)
# The unique name of the cluster. Values are of the form
# `projects/{project}/instances/{instance}/clusters/a-z*`.
},
],
- "failedLocations": [ # Locations from which Cluster information could not be retrieved,
+ "failedLocations": [ # Locations from which Cluster information could not be retrieved,
# due to an outage or some other transient condition.
# Clusters from these locations may be missing from `clusters`,
# or may only have partial information returned.
# Values are of the form `projects/<project>/locations/<zone_id>`
- "A String",
+ "A String",
],
+ "nextPageToken": "A String", # DEPRECATED: This field is unused and ignored.
}</pre>
</div>
@@ -308,7 +308,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>
@@ -327,19 +327,19 @@
{ # A resizable group of nodes in a particular cloud location, capable
# of serving all Tables in the parent
# Instance.
- "defaultStorageType": "A String", # (`CreationOnly`)
- # The type of storage used by this cluster to serve its
- # parent instance's tables, unless explicitly overridden.
- "serveNodes": 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher
+ "serveNodes": 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher
# throughput and more consistent performance.
- "state": "A String", # (`OutputOnly`)
- # The current state of the cluster.
- "location": "A String", # (`CreationOnly`)
- # The location where this cluster's nodes and storage reside. For best
+ "defaultStorageType": "A String", # (`CreationOnly`)
+ # The type of storage used by this cluster to serve its
+ # parent instance's tables, unless explicitly overridden.
+ "location": "A String", # (`CreationOnly`)
+ # The location where this cluster's nodes and storage reside. For best
# performance, clients should be located as close as possible to this
# cluster. Currently only zones are supported, so values should be of the
# form `projects/{project}/locations/{zone}`.
- "name": "A String", # Required. (`OutputOnly`)
+ "state": "A String", # (`OutputOnly`)
+ # The current state of the cluster.
+ "name": "A String", # Required. (`OutputOnly`)
# The unique name of the cluster. Values are of the form
# `projects/{project}/instances/{instance}/clusters/a-z*`.
}
@@ -354,7 +354,16 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "response": { # The normal response of the operation in case of success. If the original
+ "metadata": { # Service-specific metadata associated with the operation. It typically
+ # contains progress information and common metadata such as create time.
+ # Some services might not provide such metadata. Any method that returns a
+ # long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
+ "response": { # The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
# `Get`/`Create`/`Update`, the response should be the resource. For other
@@ -362,35 +371,26 @@
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "metadata": { # Service-specific metadata associated with the operation. It typically
- # contains progress information and common metadata such as create time.
- # Some services might not provide such metadata. Any method that returns a
- # long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
- # If `true`, the operation is completed, and either `error` or `response` is
- # available.
- "name": "A String", # The server-assigned name, which is only unique within the same service that
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should be a resource name ending with `operations/{unique_id}`.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
# three pieces of data: error code, error message, and error details.
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
- "message": "A String", # A developer-facing error message, which should be in English. Any
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
+ "details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},