chore: regens API reference docs (#889)
diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.appProfiles.html b/docs/dyn/bigtableadmin_v2.projects.instances.appProfiles.html
index 7701e0b..3cc7726 100644
--- a/docs/dyn/bigtableadmin_v2.projects.instances.appProfiles.html
+++ b/docs/dyn/bigtableadmin_v2.projects.instances.appProfiles.html
@@ -75,7 +75,7 @@
<h1><a href="bigtableadmin_v2.html">Cloud Bigtable Admin API</a> . <a href="bigtableadmin_v2.projects.html">projects</a> . <a href="bigtableadmin_v2.projects.instances.html">instances</a> . <a href="bigtableadmin_v2.projects.instances.appProfiles.html">appProfiles</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#create">create(parent, body, ignoreWarnings=None, appProfileId=None, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(parent, body=None, ignoreWarnings=None, appProfileId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates an app profile within an instance.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, ignoreWarnings=None, x__xgafv=None)</a></code></p>
@@ -90,18 +90,18 @@
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#patch">patch(name, body, ignoreWarnings=None, updateMask=None, x__xgafv=None)</a></code></p>
+ <code><a href="#patch">patch(name, body=None, ignoreWarnings=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an app profile within an instance.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(parent, body, ignoreWarnings=None, appProfileId=None, x__xgafv=None)</code>
+ <code class="details" id="create">create(parent, body=None, ignoreWarnings=None, appProfileId=None, x__xgafv=None)</code>
<pre>Creates an app profile within an instance.
Args:
- parent: string, The unique name of the instance in which to create the new app profile.
+ parent: string, Required. The unique name of the instance in which to create the new app profile.
Values are of the form
-`projects/<project>/instances/<instance>`. (required)
- body: object, The request body. (required)
+`projects/{project}/instances/{instance}`. (required)
+ body: object, The request body.
The object takes the form of:
{ # A configuration object describing how Cloud Bigtable should treat traffic
@@ -116,7 +116,7 @@
# [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more
# details.
"singleClusterRouting": { # Unconditionally routes all read/write requests to a specific cluster. # Use a single-cluster routing policy.
- # This option preserves read-your-writes consistency, but does not improve
+ # This option preserves read-your-writes consistency but does not improve
# availability.
"clusterId": "A String", # The cluster to which read/write requests should be routed.
"allowTransactionalWrites": True or False, # Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are
@@ -125,16 +125,17 @@
},
"name": "A String", # (`OutputOnly`)
# The unique name of the app profile. Values are of the form
- # `projects/<project>/instances/<instance>/appProfiles/_a-zA-Z0-9*`.
- "multiClusterRoutingUseAny": { # Read/write requests may be routed to any cluster in the instance, and will # Use a multi-cluster routing policy that may pick any cluster.
- # fail over to another cluster in the event of transient errors or delays.
- # Choosing this option sacrifices read-your-writes consistency to improve
- # availability.
+ # `projects/<project>/instances/<instance>/appProfiles/_a-zA-Z0-9*`.
+ "multiClusterRoutingUseAny": { # Read/write requests are routed to the nearest cluster in the instance, and # Use a multi-cluster routing policy.
+ # will fail over to the nearest cluster that is available in the event of
+ # transient errors or delays. Clusters in a region are considered
+ # equidistant. Choosing this option sacrifices read-your-writes consistency
+ # to improve availability.
},
}
ignoreWarnings: boolean, If true, ignore safety checks when creating the app profile.
- appProfileId: string, The ID to be used when referring to the new app profile within its
+ appProfileId: string, Required. The ID to be used when referring to the new app profile within its
instance, e.g., just `myprofile` rather than
`projects/myproject/instances/myinstance/appProfiles/myprofile`.
x__xgafv: string, V1 error format.
@@ -157,7 +158,7 @@
# [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more
# details.
"singleClusterRouting": { # Unconditionally routes all read/write requests to a specific cluster. # Use a single-cluster routing policy.
- # This option preserves read-your-writes consistency, but does not improve
+ # This option preserves read-your-writes consistency but does not improve
# availability.
"clusterId": "A String", # The cluster to which read/write requests should be routed.
"allowTransactionalWrites": True or False, # Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are
@@ -166,11 +167,12 @@
},
"name": "A String", # (`OutputOnly`)
# The unique name of the app profile. Values are of the form
- # `projects/<project>/instances/<instance>/appProfiles/_a-zA-Z0-9*`.
- "multiClusterRoutingUseAny": { # Read/write requests may be routed to any cluster in the instance, and will # Use a multi-cluster routing policy that may pick any cluster.
- # fail over to another cluster in the event of transient errors or delays.
- # Choosing this option sacrifices read-your-writes consistency to improve
- # availability.
+ # `projects/<project>/instances/<instance>/appProfiles/_a-zA-Z0-9*`.
+ "multiClusterRoutingUseAny": { # Read/write requests are routed to the nearest cluster in the instance, and # Use a multi-cluster routing policy.
+ # will fail over to the nearest cluster that is available in the event of
+ # transient errors or delays. Clusters in a region are considered
+ # equidistant. Choosing this option sacrifices read-your-writes consistency
+ # to improve availability.
},
}</pre>
</div>
@@ -180,9 +182,9 @@
<pre>Deletes an app profile from an instance.
Args:
- name: string, The unique name of the app profile to be deleted. Values are of the form
-`projects/<project>/instances/<instance>/appProfiles/<app_profile>`. (required)
- ignoreWarnings: boolean, If true, ignore safety checks when deleting the app profile.
+ name: string, Required. The unique name of the app profile to be deleted. Values are of the form
+`projects/{project}/instances/{instance}/appProfiles/{app_profile}`. (required)
+ ignoreWarnings: boolean, Required. If true, ignore safety checks when deleting the app profile.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -208,8 +210,8 @@
<pre>Gets information about an app profile.
Args:
- name: string, The unique name of the requested app profile. Values are of the form
-`projects/<project>/instances/<instance>/appProfiles/<app_profile>`. (required)
+ name: string, Required. The unique name of the requested app profile. Values are of the form
+`projects/{project}/instances/{instance}/appProfiles/{app_profile}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -230,7 +232,7 @@
# [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more
# details.
"singleClusterRouting": { # Unconditionally routes all read/write requests to a specific cluster. # Use a single-cluster routing policy.
- # This option preserves read-your-writes consistency, but does not improve
+ # This option preserves read-your-writes consistency but does not improve
# availability.
"clusterId": "A String", # The cluster to which read/write requests should be routed.
"allowTransactionalWrites": True or False, # Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are
@@ -239,11 +241,12 @@
},
"name": "A String", # (`OutputOnly`)
# The unique name of the app profile. Values are of the form
- # `projects/<project>/instances/<instance>/appProfiles/_a-zA-Z0-9*`.
- "multiClusterRoutingUseAny": { # Read/write requests may be routed to any cluster in the instance, and will # Use a multi-cluster routing policy that may pick any cluster.
- # fail over to another cluster in the event of transient errors or delays.
- # Choosing this option sacrifices read-your-writes consistency to improve
- # availability.
+ # `projects/<project>/instances/<instance>/appProfiles/_a-zA-Z0-9*`.
+ "multiClusterRoutingUseAny": { # Read/write requests are routed to the nearest cluster in the instance, and # Use a multi-cluster routing policy.
+ # will fail over to the nearest cluster that is available in the event of
+ # transient errors or delays. Clusters in a region are considered
+ # equidistant. Choosing this option sacrifices read-your-writes consistency
+ # to improve availability.
},
}</pre>
</div>
@@ -253,10 +256,10 @@
<pre>Lists information about app profiles in an instance.
Args:
- parent: string, The unique name of the instance for which a list of app profiles is
+ parent: string, Required. The unique name of the instance for which a list of app profiles is
requested. Values are of the form
-`projects/<project>/instances/<instance>`.
-Use `<instance> = '-'` to list AppProfiles for all Instances in a project,
+`projects/{project}/instances/{instance}`.
+Use `{instance} = '-'` to list AppProfiles for all Instances in a project,
e.g., `projects/myproject/instances/-`. (required)
pageToken: string, The value of `next_page_token` returned by a previous call.
x__xgafv: string, V1 error format.
@@ -264,7 +267,14 @@
1 - v1 error format
2 - v2 error format
pageSize: integer, Maximum number of results per page.
-CURRENTLY UNIMPLEMENTED AND IGNORED.
+
+A page_size of zero lets the server choose the number of items to return.
+A page_size which is strictly positive will return at most that many items.
+A negative page_size will cause an error.
+
+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.
Returns:
An object of the form:
@@ -276,7 +286,7 @@
"failedLocations": [ # Locations from which AppProfile information could not be retrieved,
# due to an outage or some other transient condition.
# AppProfiles from these locations may be missing from `app_profiles`.
- # Values are of the form `projects/<project>/locations/<zone_id>`
+ # Values are of the form `projects/<project>/locations/<zone_id>`
"A String",
],
"appProfiles": [ # The list of requested app profiles.
@@ -292,7 +302,7 @@
# [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more
# details.
"singleClusterRouting": { # Unconditionally routes all read/write requests to a specific cluster. # Use a single-cluster routing policy.
- # This option preserves read-your-writes consistency, but does not improve
+ # This option preserves read-your-writes consistency but does not improve
# availability.
"clusterId": "A String", # The cluster to which read/write requests should be routed.
"allowTransactionalWrites": True or False, # Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are
@@ -301,11 +311,12 @@
},
"name": "A String", # (`OutputOnly`)
# The unique name of the app profile. Values are of the form
- # `projects/<project>/instances/<instance>/appProfiles/_a-zA-Z0-9*`.
- "multiClusterRoutingUseAny": { # Read/write requests may be routed to any cluster in the instance, and will # Use a multi-cluster routing policy that may pick any cluster.
- # fail over to another cluster in the event of transient errors or delays.
- # Choosing this option sacrifices read-your-writes consistency to improve
- # availability.
+ # `projects/<project>/instances/<instance>/appProfiles/_a-zA-Z0-9*`.
+ "multiClusterRoutingUseAny": { # Read/write requests are routed to the nearest cluster in the instance, and # Use a multi-cluster routing policy.
+ # will fail over to the nearest cluster that is available in the event of
+ # transient errors or delays. Clusters in a region are considered
+ # equidistant. Choosing this option sacrifices read-your-writes consistency
+ # to improve availability.
},
},
],
@@ -327,14 +338,14 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(name, body, ignoreWarnings=None, updateMask=None, x__xgafv=None)</code>
+ <code class="details" id="patch">patch(name, body=None, ignoreWarnings=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates an app profile within an instance.
Args:
name: string, (`OutputOnly`)
The unique name of the app profile. Values are of the form
-`projects/<project>/instances/<instance>/appProfiles/_a-zA-Z0-9*`. (required)
- body: object, The request body. (required)
+`projects/<project>/instances/<instance>/appProfiles/_a-zA-Z0-9*`. (required)
+ body: object, The request body.
The object takes the form of:
{ # A configuration object describing how Cloud Bigtable should treat traffic
@@ -349,7 +360,7 @@
# [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more
# details.
"singleClusterRouting": { # Unconditionally routes all read/write requests to a specific cluster. # Use a single-cluster routing policy.
- # This option preserves read-your-writes consistency, but does not improve
+ # This option preserves read-your-writes consistency but does not improve
# availability.
"clusterId": "A String", # The cluster to which read/write requests should be routed.
"allowTransactionalWrites": True or False, # Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are
@@ -358,16 +369,17 @@
},
"name": "A String", # (`OutputOnly`)
# The unique name of the app profile. Values are of the form
- # `projects/<project>/instances/<instance>/appProfiles/_a-zA-Z0-9*`.
- "multiClusterRoutingUseAny": { # Read/write requests may be routed to any cluster in the instance, and will # Use a multi-cluster routing policy that may pick any cluster.
- # fail over to another cluster in the event of transient errors or delays.
- # Choosing this option sacrifices read-your-writes consistency to improve
- # availability.
+ # `projects/<project>/instances/<instance>/appProfiles/_a-zA-Z0-9*`.
+ "multiClusterRoutingUseAny": { # Read/write requests are routed to the nearest cluster in the instance, and # Use a multi-cluster routing policy.
+ # will fail over to the nearest cluster that is available in the event of
+ # transient errors or delays. Clusters in a region are considered
+ # equidistant. Choosing this option sacrifices read-your-writes consistency
+ # to improve availability.
},
}
ignoreWarnings: boolean, If true, ignore safety checks when updating the app profile.
- updateMask: string, The subset of app profile fields which should be replaced.
+ updateMask: string, Required. The subset of app profile fields which should be replaced.
If unset, all fields will be replaced.
x__xgafv: string, V1 error format.
Allowed values
@@ -379,64 +391,35 @@
{ # 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
+ # method returns no data on success, such as `Delete`, the response is
+ # `google.protobuf.Empty`. If the original method is standard
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
+ # is the original method name. For example, if the original method name
+ # is `TakeSnapshot()`, the inferred response type is
+ # `TakeSnapshotResponse`.
+ "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
+ # originally returns it. If you use the default HTTP mapping, the
+ # `name` should be a resource name ending with `operations/{unique_id}`.
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). The error model is designed to be:
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
#
- # - Simple to use and understand for most users
- # - Flexible enough to meet unexpected needs
- #
- # # Overview
- #
- # The `Status` message contains three pieces of data: error code, error
- # message, and error details. The error code should be an enum value of
- # google.rpc.Code, but it may accept additional error codes if needed. The
- # error message should be a developer-facing English message that helps
- # developers *understand* and *resolve* the error. If a localized user-facing
- # error message is needed, put the localized message in the error details or
- # localize it in the client. The optional error details may contain arbitrary
- # information about the error. There is a predefined set of error detail types
- # in the package `google.rpc` that can be used for common error conditions.
- #
- # # Language mapping
- #
- # The `Status` message is the logical representation of the error model, but it
- # is not necessarily the actual wire format. When the `Status` message is
- # exposed in different client libraries and different wire protocols, it can be
- # mapped differently. For example, it will likely be mapped to some exceptions
- # in Java, but more likely mapped to some error codes in C.
- #
- # # Other uses
- #
- # The error model and the `Status` message can be used in a variety of
- # environments, either with or without APIs, to provide a
- # consistent developer experience across different environments.
- #
- # Example uses of this error model include:
- #
- # - Partial errors. If a service needs to return partial errors to the client,
- # it may embed the `Status` in the normal response to indicate the partial
- # errors.
- #
- # - Workflow errors. A typical workflow has multiple steps. Each step may
- # have a `Status` message for error reporting.
- #
- # - Batch operations. If a client uses batch request and batch response, the
- # `Status` message should be used directly inside batch response, one for
- # each error sub-response.
- #
- # - Asynchronous operations. If an API call embeds asynchronous operation
- # results in its response, the status of those operations should be
- # represented directly using the `Status` message.
- #
- # - Logging. If some API errors are stored in logs, the message `Status` could
- # be used directly after any stripping needed for security/privacy reasons.
+ # 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
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
@@ -448,22 +431,6 @@
},
],
},
- "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
- # methods, the response should have the type `XxxResponse`, where `Xxx`
- # is the original method name. For example, if the original method name
- # is `TakeSnapshot()`, the inferred response type is
- # `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "name": "A String", # The server-assigned name, which is only unique within the same service that
- # originally returns it. If you use the default HTTP mapping, the
- # `name` should have the format of `operations/some/unique/name`.
}</pre>
</div>