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.appProfiles.html b/docs/dyn/bigtableadmin_v2.projects.instances.appProfiles.html
index 3cc7726..daf81af 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=None, ignoreWarnings=None, appProfileId=None, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(parent, body=None, appProfileId=None, ignoreWarnings=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>
@@ -84,17 +84,17 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets information about an app profile.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
+ <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists information about app profiles in an instance.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#patch">patch(name, body=None, ignoreWarnings=None, updateMask=None, x__xgafv=None)</a></code></p>
+ <code><a href="#patch">patch(name, body=None, updateMask=None, ignoreWarnings=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=None, ignoreWarnings=None, appProfileId=None, x__xgafv=None)</code>
+ <code class="details" id="create">create(parent, body=None, appProfileId=None, ignoreWarnings=None, x__xgafv=None)</code>
<pre>Creates an app profile within an instance.
Args:
@@ -105,39 +105,39 @@
The object takes the form of:
{ # A configuration object describing how Cloud Bigtable should treat traffic
- # from a particular end user application.
- "description": "A String", # Optional long form description of the use case for this AppProfile.
- "etag": "A String", # Strongly validated etag for optimistic concurrency control. Preserve the
- # value returned from `GetAppProfile` when calling `UpdateAppProfile` to
- # fail the request if there has been a modification in the mean time. The
- # `update_mask` of the request need not include `etag` for this protection
- # to apply.
- # See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and
- # [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
- # 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
- # allowed by this app profile. It is unsafe to send these requests to
- # the same table/row/column in multiple clusters.
- },
- "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 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.
- },
- }
+ # from a particular end user application.
+ "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.
+ },
+ "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*`.
+ "description": "A String", # Optional long form description of the use case for this AppProfile.
+ "etag": "A String", # Strongly validated etag for optimistic concurrency control. Preserve the
+ # value returned from `GetAppProfile` when calling `UpdateAppProfile` to
+ # fail the request if there has been a modification in the mean time. The
+ # `update_mask` of the request need not include `etag` for this protection
+ # to apply.
+ # See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and
+ # [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
+ # 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
+ # allowed by this app profile. It is unsafe to send these requests to
+ # the same table/row/column in multiple clusters.
+ },
+}
- ignoreWarnings: boolean, If true, ignore safety checks when creating the app profile.
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`.
+ ignoreWarnings: boolean, If true, ignore safety checks when creating the app profile.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -147,34 +147,34 @@
An object of the form:
{ # A configuration object describing how Cloud Bigtable should treat traffic
- # from a particular end user application.
- "description": "A String", # Optional long form description of the use case for this AppProfile.
- "etag": "A String", # Strongly validated etag for optimistic concurrency control. Preserve the
- # value returned from `GetAppProfile` when calling `UpdateAppProfile` to
- # fail the request if there has been a modification in the mean time. The
- # `update_mask` of the request need not include `etag` for this protection
- # to apply.
- # See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and
- # [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
- # 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
- # allowed by this app profile. It is unsafe to send these requests to
- # the same table/row/column in multiple clusters.
- },
- "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 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>
+ # from a particular end user application.
+ "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.
+ },
+ "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*`.
+ "description": "A String", # Optional long form description of the use case for this AppProfile.
+ "etag": "A String", # Strongly validated etag for optimistic concurrency control. Preserve the
+ # value returned from `GetAppProfile` when calling `UpdateAppProfile` to
+ # fail the request if there has been a modification in the mean time. The
+ # `update_mask` of the request need not include `etag` for this protection
+ # to apply.
+ # See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and
+ # [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
+ # 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
+ # allowed by this app profile. It is unsafe to send these requests to
+ # the same table/row/column in multiple clusters.
+ },
+ }</pre>
</div>
<div class="method">
@@ -221,51 +221,47 @@
An object of the form:
{ # A configuration object describing how Cloud Bigtable should treat traffic
- # from a particular end user application.
- "description": "A String", # Optional long form description of the use case for this AppProfile.
- "etag": "A String", # Strongly validated etag for optimistic concurrency control. Preserve the
- # value returned from `GetAppProfile` when calling `UpdateAppProfile` to
- # fail the request if there has been a modification in the mean time. The
- # `update_mask` of the request need not include `etag` for this protection
- # to apply.
- # See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and
- # [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
- # 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
- # allowed by this app profile. It is unsafe to send these requests to
- # the same table/row/column in multiple clusters.
- },
- "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 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>
+ # from a particular end user application.
+ "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.
+ },
+ "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*`.
+ "description": "A String", # Optional long form description of the use case for this AppProfile.
+ "etag": "A String", # Strongly validated etag for optimistic concurrency control. Preserve the
+ # value returned from `GetAppProfile` when calling `UpdateAppProfile` to
+ # fail the request if there has been a modification in the mean time. The
+ # `update_mask` of the request need not include `etag` for this protection
+ # to apply.
+ # See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and
+ # [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
+ # 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
+ # allowed by this app profile. It is unsafe to send these requests to
+ # the same table/row/column in multiple clusters.
+ },
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
+ <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
<pre>Lists information about app profiles in an instance.
Args:
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,
+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.
- 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.
@@ -275,50 +271,54 @@
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.
+ 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 BigtableInstanceAdmin.ListAppProfiles.
- "nextPageToken": "A String", # Set if not all app profiles could be returned in a single response.
+ "nextPageToken": "A String", # Set if not all app profiles could be returned in a single response.
# Pass this value to `page_token` in another request to get the next
# page of results.
- "failedLocations": [ # Locations from which AppProfile information could not be retrieved,
+ "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>`
- "A String",
+ "A String",
],
- "appProfiles": [ # The list of requested app profiles.
+ "appProfiles": [ # The list of requested app profiles.
{ # A configuration object describing how Cloud Bigtable should treat traffic
- # from a particular end user application.
- "description": "A String", # Optional long form description of the use case for this AppProfile.
- "etag": "A String", # Strongly validated etag for optimistic concurrency control. Preserve the
- # value returned from `GetAppProfile` when calling `UpdateAppProfile` to
- # fail the request if there has been a modification in the mean time. The
- # `update_mask` of the request need not include `etag` for this protection
- # to apply.
- # See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and
- # [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
- # 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
- # allowed by this app profile. It is unsafe to send these requests to
- # the same table/row/column in multiple clusters.
- },
- "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 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.
- },
+ # from a particular end user application.
+ "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.
},
+ "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*`.
+ "description": "A String", # Optional long form description of the use case for this AppProfile.
+ "etag": "A String", # Strongly validated etag for optimistic concurrency control. Preserve the
+ # value returned from `GetAppProfile` when calling `UpdateAppProfile` to
+ # fail the request if there has been a modification in the mean time. The
+ # `update_mask` of the request need not include `etag` for this protection
+ # to apply.
+ # See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and
+ # [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
+ # 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
+ # allowed by this app profile. It is unsafe to send these requests to
+ # the same table/row/column in multiple clusters.
+ },
+ },
],
}</pre>
</div>
@@ -332,13 +332,13 @@
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>
<div class="method">
- <code class="details" id="patch">patch(name, body=None, ignoreWarnings=None, updateMask=None, x__xgafv=None)</code>
+ <code class="details" id="patch">patch(name, body=None, updateMask=None, ignoreWarnings=None, x__xgafv=None)</code>
<pre>Updates an app profile within an instance.
Args:
@@ -349,38 +349,38 @@
The object takes the form of:
{ # A configuration object describing how Cloud Bigtable should treat traffic
- # from a particular end user application.
- "description": "A String", # Optional long form description of the use case for this AppProfile.
- "etag": "A String", # Strongly validated etag for optimistic concurrency control. Preserve the
- # value returned from `GetAppProfile` when calling `UpdateAppProfile` to
- # fail the request if there has been a modification in the mean time. The
- # `update_mask` of the request need not include `etag` for this protection
- # to apply.
- # See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and
- # [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
- # 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
- # allowed by this app profile. It is unsafe to send these requests to
- # the same table/row/column in multiple clusters.
- },
- "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 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.
- },
- }
+ # from a particular end user application.
+ "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.
+ },
+ "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*`.
+ "description": "A String", # Optional long form description of the use case for this AppProfile.
+ "etag": "A String", # Strongly validated etag for optimistic concurrency control. Preserve the
+ # value returned from `GetAppProfile` when calling `UpdateAppProfile` to
+ # fail the request if there has been a modification in the mean time. The
+ # `update_mask` of the request need not include `etag` for this protection
+ # to apply.
+ # See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and
+ # [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
+ # 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
+ # allowed by this app profile. It is unsafe to send these requests to
+ # the same table/row/column in multiple clusters.
+ },
+}
- ignoreWarnings: boolean, If true, ignore safety checks when updating the app profile.
updateMask: string, Required. The subset of app profile fields which should be replaced.
If unset, all fields will be replaced.
+ ignoreWarnings: boolean, If true, ignore safety checks when updating the app profile.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -391,7 +391,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
@@ -399,35 +408,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.
},
],
},