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/tpu_v1.projects.locations.nodes.html b/docs/dyn/tpu_v1.projects.locations.nodes.html
index d269175..6e7e81f 100644
--- a/docs/dyn/tpu_v1.projects.locations.nodes.html
+++ b/docs/dyn/tpu_v1.projects.locations.nodes.html
@@ -84,7 +84,7 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the details of a node.</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 nodes.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -109,52 +109,52 @@
The object takes the form of:
{ # A TPU instance.
- "schedulingConfig": {
- "preemptible": True or False,
- "reserved": True or False, # Whether the node is created under a reservation.
+ "ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
+ # The network address for the TPU Node as visible to Compute Engine
+ # instances.
+ "labels": { # Resource labels to represent user-provided metadata.
+ "a_key": "A String",
},
- "cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address.
+ "createTime": "A String", # Output only. The time when the node was created.
+ "cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address.
# This CIDR block must be a /29 block; the Compute Engine networks API
# forbids a smaller block, and using a larger block would be wasteful (a
# node can only consume one IP address). Errors will occur if the CIDR block
# has already been used for a currently existing TPU node, the CIDR block
- # conflicts with any subnetworks in the user's provided network, or the
+ # conflicts with any subnetworks in the user's provided network, or the
# provided network is peered with another network that is using that CIDR
# block.
- "network": "A String", # The name of a network they wish to peer the TPU node to. It must be a
- # preexisting Compute Engine network inside of the project on which this API
- # has been activated. If none is provided, "default" will be used.
- "healthDescription": "A String", # Output only. If this field is populated, it contains a description of why the TPU Node
- # is unhealthy.
- "labels": { # Resource labels to represent user-provided metadata.
- "a_key": "A String",
- },
- "serviceAccount": "A String", # Output only. The service account used to run the tensor flow services within the node.
- # To share resources, including Google Cloud Storage data, with the
- # Tensorflow job running in the Node, this account must have permissions to
- # that data.
- "port": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
- # The network port for the TPU Node as visible to Compute Engine instances.
- "name": "A String", # Output only. The immutable name of the TPU
- "tensorflowVersion": "A String", # The version of Tensorflow running in the Node.
+ "tensorflowVersion": "A String", # The version of Tensorflow running in the Node.
# Required.
- "state": "A String", # Output only. The current state for the TPU Node.
- "health": "A String", # The health status of the TPU node.
- "networkEndpoints": [ # Output only. The network endpoints where TPU workers can be accessed and
+ "description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters.
+ "networkEndpoints": [ # Output only. The network endpoints where TPU workers can be accessed and
# sent work. It is recommended that Tensorflow clients of the node reach out
# to the 0th entry in this map first.
{ # A network endpoint over which a TPU worker can be reached.
- "ipAddress": "A String", # The IP address of this network endpoint.
- "port": 42, # The port of this network endpoint.
+ "ipAddress": "A String", # The IP address of this network endpoint.
+ "port": 42, # The port of this network endpoint.
},
],
- "acceleratorType": "A String", # The type of hardware accelerators associated with this node.
+ "schedulingConfig": {
+ "reserved": True or False, # Whether the node is created under a reservation.
+ "preemptible": True or False,
+ },
+ "state": "A String", # Output only. The current state for the TPU Node.
+ "name": "A String", # Output only. The immutable name of the TPU
+ "acceleratorType": "A String", # The type of hardware accelerators associated with this node.
# Required.
- "ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
- # The network address for the TPU Node as visible to Compute Engine
- # instances.
- "createTime": "A String", # Output only. The time when the node was created.
- "description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters.
+ "port": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
+ # The network port for the TPU Node as visible to Compute Engine instances.
+ "serviceAccount": "A String", # Output only. The service account used to run the tensor flow services within the node.
+ # To share resources, including Google Cloud Storage data, with the
+ # Tensorflow job running in the Node, this account must have permissions to
+ # that data.
+ "network": "A String", # The name of a network they wish to peer the TPU node to. It must be a
+ # preexisting Compute Engine network inside of the project on which this API
+ # has been activated. If none is provided, "default" will be used.
+ "healthDescription": "A String", # Output only. If this field is populated, it contains a description of why the TPU Node
+ # is unhealthy.
+ "health": "A String", # The health status of the TPU node.
}
nodeId: string, The unqualified resource name.
@@ -168,28 +168,10 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "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
- # 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
- # message types for APIs to use.
- {
- "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.
+ "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
+ "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
@@ -197,16 +179,34 @@
# 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.
},
- "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}`.
- "metadata": { # Service-specific metadata associated with the operation. It typically
+ "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).
+ "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.
+ "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.
+ },
+ ],
+ },
+ "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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
@@ -227,28 +227,10 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "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
- # 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
- # message types for APIs to use.
- {
- "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.
+ "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
+ "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
@@ -256,16 +238,34 @@
# 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.
},
- "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}`.
- "metadata": { # Service-specific metadata associated with the operation. It typically
+ "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).
+ "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.
+ "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.
+ },
+ ],
+ },
+ "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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
@@ -285,126 +285,126 @@
An object of the form:
{ # A TPU instance.
- "schedulingConfig": {
- "preemptible": True or False,
- "reserved": True or False, # Whether the node is created under a reservation.
+ "ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
+ # The network address for the TPU Node as visible to Compute Engine
+ # instances.
+ "labels": { # Resource labels to represent user-provided metadata.
+ "a_key": "A String",
},
- "cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address.
+ "createTime": "A String", # Output only. The time when the node was created.
+ "cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address.
# This CIDR block must be a /29 block; the Compute Engine networks API
# forbids a smaller block, and using a larger block would be wasteful (a
# node can only consume one IP address). Errors will occur if the CIDR block
# has already been used for a currently existing TPU node, the CIDR block
- # conflicts with any subnetworks in the user's provided network, or the
+ # conflicts with any subnetworks in the user's provided network, or the
# provided network is peered with another network that is using that CIDR
# block.
- "network": "A String", # The name of a network they wish to peer the TPU node to. It must be a
- # preexisting Compute Engine network inside of the project on which this API
- # has been activated. If none is provided, "default" will be used.
- "healthDescription": "A String", # Output only. If this field is populated, it contains a description of why the TPU Node
- # is unhealthy.
- "labels": { # Resource labels to represent user-provided metadata.
- "a_key": "A String",
- },
- "serviceAccount": "A String", # Output only. The service account used to run the tensor flow services within the node.
- # To share resources, including Google Cloud Storage data, with the
- # Tensorflow job running in the Node, this account must have permissions to
- # that data.
- "port": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
- # The network port for the TPU Node as visible to Compute Engine instances.
- "name": "A String", # Output only. The immutable name of the TPU
- "tensorflowVersion": "A String", # The version of Tensorflow running in the Node.
+ "tensorflowVersion": "A String", # The version of Tensorflow running in the Node.
# Required.
- "state": "A String", # Output only. The current state for the TPU Node.
- "health": "A String", # The health status of the TPU node.
- "networkEndpoints": [ # Output only. The network endpoints where TPU workers can be accessed and
+ "description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters.
+ "networkEndpoints": [ # Output only. The network endpoints where TPU workers can be accessed and
# sent work. It is recommended that Tensorflow clients of the node reach out
# to the 0th entry in this map first.
{ # A network endpoint over which a TPU worker can be reached.
- "ipAddress": "A String", # The IP address of this network endpoint.
- "port": 42, # The port of this network endpoint.
+ "ipAddress": "A String", # The IP address of this network endpoint.
+ "port": 42, # The port of this network endpoint.
},
],
- "acceleratorType": "A String", # The type of hardware accelerators associated with this node.
+ "schedulingConfig": {
+ "reserved": True or False, # Whether the node is created under a reservation.
+ "preemptible": True or False,
+ },
+ "state": "A String", # Output only. The current state for the TPU Node.
+ "name": "A String", # Output only. The immutable name of the TPU
+ "acceleratorType": "A String", # The type of hardware accelerators associated with this node.
# Required.
- "ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
- # The network address for the TPU Node as visible to Compute Engine
- # instances.
- "createTime": "A String", # Output only. The time when the node was created.
- "description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters.
+ "port": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
+ # The network port for the TPU Node as visible to Compute Engine instances.
+ "serviceAccount": "A String", # Output only. The service account used to run the tensor flow services within the node.
+ # To share resources, including Google Cloud Storage data, with the
+ # Tensorflow job running in the Node, this account must have permissions to
+ # that data.
+ "network": "A String", # The name of a network they wish to peer the TPU node to. It must be a
+ # preexisting Compute Engine network inside of the project on which this API
+ # has been activated. If none is provided, "default" will be used.
+ "healthDescription": "A String", # Output only. If this field is populated, it contains a description of why the TPU Node
+ # is unhealthy.
+ "health": "A String", # The health status of the TPU node.
}</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 nodes.
Args:
parent: string, The parent resource name. (required)
pageToken: string, The next_page_token value returned from a previous List request, if any.
+ pageSize: integer, The maximum number of items to return.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
- pageSize: integer, The maximum number of items to return.
Returns:
An object of the form:
{ # Response for ListNodes.
- "nextPageToken": "A String", # The next page token or empty if none.
- "unreachable": [ # Locations that could not be reached.
- "A String",
+ "unreachable": [ # Locations that could not be reached.
+ "A String",
],
- "nodes": [ # The listed nodes.
+ "nodes": [ # The listed nodes.
{ # A TPU instance.
- "schedulingConfig": {
- "preemptible": True or False,
- "reserved": True or False, # Whether the node is created under a reservation.
+ "ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
+ # The network address for the TPU Node as visible to Compute Engine
+ # instances.
+ "labels": { # Resource labels to represent user-provided metadata.
+ "a_key": "A String",
},
- "cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address.
+ "createTime": "A String", # Output only. The time when the node was created.
+ "cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address.
# This CIDR block must be a /29 block; the Compute Engine networks API
# forbids a smaller block, and using a larger block would be wasteful (a
# node can only consume one IP address). Errors will occur if the CIDR block
# has already been used for a currently existing TPU node, the CIDR block
- # conflicts with any subnetworks in the user's provided network, or the
+ # conflicts with any subnetworks in the user's provided network, or the
# provided network is peered with another network that is using that CIDR
# block.
- "network": "A String", # The name of a network they wish to peer the TPU node to. It must be a
- # preexisting Compute Engine network inside of the project on which this API
- # has been activated. If none is provided, "default" will be used.
- "healthDescription": "A String", # Output only. If this field is populated, it contains a description of why the TPU Node
- # is unhealthy.
- "labels": { # Resource labels to represent user-provided metadata.
- "a_key": "A String",
- },
- "serviceAccount": "A String", # Output only. The service account used to run the tensor flow services within the node.
- # To share resources, including Google Cloud Storage data, with the
- # Tensorflow job running in the Node, this account must have permissions to
- # that data.
- "port": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
- # The network port for the TPU Node as visible to Compute Engine instances.
- "name": "A String", # Output only. The immutable name of the TPU
- "tensorflowVersion": "A String", # The version of Tensorflow running in the Node.
+ "tensorflowVersion": "A String", # The version of Tensorflow running in the Node.
# Required.
- "state": "A String", # Output only. The current state for the TPU Node.
- "health": "A String", # The health status of the TPU node.
- "networkEndpoints": [ # Output only. The network endpoints where TPU workers can be accessed and
+ "description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters.
+ "networkEndpoints": [ # Output only. The network endpoints where TPU workers can be accessed and
# sent work. It is recommended that Tensorflow clients of the node reach out
# to the 0th entry in this map first.
{ # A network endpoint over which a TPU worker can be reached.
- "ipAddress": "A String", # The IP address of this network endpoint.
- "port": 42, # The port of this network endpoint.
+ "ipAddress": "A String", # The IP address of this network endpoint.
+ "port": 42, # The port of this network endpoint.
},
],
- "acceleratorType": "A String", # The type of hardware accelerators associated with this node.
+ "schedulingConfig": {
+ "reserved": True or False, # Whether the node is created under a reservation.
+ "preemptible": True or False,
+ },
+ "state": "A String", # Output only. The current state for the TPU Node.
+ "name": "A String", # Output only. The immutable name of the TPU
+ "acceleratorType": "A String", # The type of hardware accelerators associated with this node.
# Required.
- "ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
- # The network address for the TPU Node as visible to Compute Engine
- # instances.
- "createTime": "A String", # Output only. The time when the node was created.
- "description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters.
+ "port": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
+ # The network port for the TPU Node as visible to Compute Engine instances.
+ "serviceAccount": "A String", # Output only. The service account used to run the tensor flow services within the node.
+ # To share resources, including Google Cloud Storage data, with the
+ # Tensorflow job running in the Node, this account must have permissions to
+ # that data.
+ "network": "A String", # The name of a network they wish to peer the TPU node to. It must be a
+ # preexisting Compute Engine network inside of the project on which this API
+ # has been activated. If none is provided, "default" will be used.
+ "healthDescription": "A String", # Output only. If this field is populated, it contains a description of why the TPU Node
+ # is unhealthy.
+ "health": "A String", # The health status of the TPU node.
},
],
+ "nextPageToken": "A String", # The next page token or empty if none.
}</pre>
</div>
@@ -417,14 +417,14 @@
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="reimage">reimage(name, body=None, x__xgafv=None)</code>
- <pre>Reimages a node's OS.
+ <pre>Reimages a node's OS.
Args:
name: string, The resource name. (required)
@@ -432,7 +432,7 @@
The object takes the form of:
{ # Request for ReimageNode.
- "tensorflowVersion": "A String", # The version for reimage to create.
+ "tensorflowVersion": "A String", # The version for reimage to create.
}
x__xgafv: string, V1 error format.
@@ -445,28 +445,10 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "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
- # 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
- # message types for APIs to use.
- {
- "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.
+ "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
+ "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
@@ -474,16 +456,34 @@
# 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.
},
- "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}`.
- "metadata": { # Service-specific metadata associated with the operation. It typically
+ "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).
+ "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.
+ "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.
+ },
+ ],
+ },
+ "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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
@@ -510,28 +510,10 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "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
- # 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
- # message types for APIs to use.
- {
- "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.
+ "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
+ "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
@@ -539,16 +521,34 @@
# 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.
},
- "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}`.
- "metadata": { # Service-specific metadata associated with the operation. It typically
+ "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).
+ "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.
+ "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.
+ },
+ ],
+ },
+ "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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
@@ -575,28 +575,10 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "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
- # 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
- # message types for APIs to use.
- {
- "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.
+ "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
+ "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
@@ -604,16 +586,34 @@
# 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.
},
- "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}`.
- "metadata": { # Service-specific metadata associated with the operation. It typically
+ "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).
+ "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.
+ "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.
+ },
+ ],
+ },
+ "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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>