docs: update generated docs (#981)
diff --git a/docs/dyn/tpu_v1alpha1.projects.locations.nodes.html b/docs/dyn/tpu_v1alpha1.projects.locations.nodes.html
index 108a7c9..c20d724 100644
--- a/docs/dyn/tpu_v1alpha1.projects.locations.nodes.html
+++ b/docs/dyn/tpu_v1alpha1.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, pageSize=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, pageSize=None, pageToken=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,15 +109,22 @@
The object takes the form of:
{ # A TPU instance.
- "healthDescription": "A String", # Output only. If this field is populated, it contains a description of why the TPU Node
- # is unhealthy.
- "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.
+ "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.
+ "port": 42, # The port of this network endpoint.
+ "ipAddress": "A String", # The IP address of this network endpoint.
+ },
+ ],
+ "labels": { # Resource labels to represent user-provided metadata.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. The immutable name of the TPU
+ "tensorflowVersion": "A String", # The version of Tensorflow running in the Node.
+ # Required.
"health": "A String", # The health status of the TPU node.
- "ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
- # The network address for the TPU Node as visible to Compute Engine
- # instances.
+ "state": "A String", # Output only. The current state for the TPU Node.
"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
@@ -126,35 +133,28 @@
# 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.
- "labels": { # Resource labels to represent user-provided metadata.
- "a_key": "A String",
- },
"createTime": "A String", # Output only. The time when the node was created.
- "tensorflowVersion": "A String", # The version of Tensorflow running in the Node.
- # Required.
"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.
- },
- ],
- "schedulingConfig": {
+ "schedulingConfig": { # Sets the scheduling options for this node.
"reserved": True or False, # Whether the node is created under a reservation.
- "preemptible": True or False,
+ "preemptible": True or False, # Defines whether the node is preemptible.
},
- "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.
+ "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.
"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.
+ "acceleratorType": "A String", # The type of hardware accelerators associated with this node.
+ # Required.
}
nodeId: string, The unqualified resource name.
@@ -168,9 +168,18 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "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}`.
"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
@@ -181,9 +190,6 @@
# `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 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). Each `Status` message contains
@@ -191,22 +197,16 @@
#
# 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.
},
],
- "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.
- },
- "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.
},
}</pre>
</div>
@@ -227,9 +227,18 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "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}`.
"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
@@ -240,9 +249,6 @@
# `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 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). Each `Status` message contains
@@ -250,22 +256,16 @@
#
# 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.
},
],
- "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.
- },
- "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.
},
}</pre>
</div>
@@ -285,15 +285,22 @@
An object of the form:
{ # A TPU instance.
- "healthDescription": "A String", # Output only. If this field is populated, it contains a description of why the TPU Node
- # is unhealthy.
- "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.
+ "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.
+ "port": 42, # The port of this network endpoint.
+ "ipAddress": "A String", # The IP address of this network endpoint.
+ },
+ ],
+ "labels": { # Resource labels to represent user-provided metadata.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. The immutable name of the TPU
+ "tensorflowVersion": "A String", # The version of Tensorflow running in the Node.
+ # Required.
"health": "A String", # The health status of the TPU node.
- "ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
- # The network address for the TPU Node as visible to Compute Engine
- # instances.
+ "state": "A String", # Output only. The current state for the TPU Node.
"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
@@ -302,46 +309,39 @@
# 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.
- "labels": { # Resource labels to represent user-provided metadata.
- "a_key": "A String",
- },
"createTime": "A String", # Output only. The time when the node was created.
- "tensorflowVersion": "A String", # The version of Tensorflow running in the Node.
- # Required.
"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.
- },
- ],
- "schedulingConfig": {
+ "schedulingConfig": { # Sets the scheduling options for this node.
"reserved": True or False, # Whether the node is created under a reservation.
- "preemptible": True or False,
+ "preemptible": True or False, # Defines whether the node is preemptible.
},
- "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.
+ "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.
"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.
+ "acceleratorType": "A String", # The type of hardware accelerators associated with this node.
+ # Required.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, pageSize=None, pageToken=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.
+ pageToken: string, The next_page_token value returned from a previous List request, if any.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -356,15 +356,22 @@
],
"nodes": [ # The listed nodes.
{ # A TPU instance.
- "healthDescription": "A String", # Output only. If this field is populated, it contains a description of why the TPU Node
- # is unhealthy.
- "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.
+ "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.
+ "port": 42, # The port of this network endpoint.
+ "ipAddress": "A String", # The IP address of this network endpoint.
+ },
+ ],
+ "labels": { # Resource labels to represent user-provided metadata.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. The immutable name of the TPU
+ "tensorflowVersion": "A String", # The version of Tensorflow running in the Node.
+ # Required.
"health": "A String", # The health status of the TPU node.
- "ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
- # The network address for the TPU Node as visible to Compute Engine
- # instances.
+ "state": "A String", # Output only. The current state for the TPU Node.
"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
@@ -373,35 +380,28 @@
# 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.
- "labels": { # Resource labels to represent user-provided metadata.
- "a_key": "A String",
- },
"createTime": "A String", # Output only. The time when the node was created.
- "tensorflowVersion": "A String", # The version of Tensorflow running in the Node.
- # Required.
"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.
- },
- ],
- "schedulingConfig": {
+ "schedulingConfig": { # Sets the scheduling options for this node.
"reserved": True or False, # Whether the node is created under a reservation.
- "preemptible": True or False,
+ "preemptible": True or False, # Defines whether the node is preemptible.
},
- "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.
+ "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.
"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.
+ "acceleratorType": "A String", # The type of hardware accelerators associated with this node.
+ # Required.
},
],
"nextPageToken": "A String", # The next page token or empty if none.
@@ -445,9 +445,18 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "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}`.
"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
@@ -458,9 +467,6 @@
# `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 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). Each `Status` message contains
@@ -468,22 +474,16 @@
#
# 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.
},
],
- "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.
- },
- "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.
},
}</pre>
</div>
@@ -510,9 +510,18 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "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}`.
"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
@@ -523,9 +532,6 @@
# `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 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). Each `Status` message contains
@@ -533,22 +539,16 @@
#
# 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.
},
],
- "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.
- },
- "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.
},
}</pre>
</div>
@@ -575,9 +575,18 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
+ "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}`.
"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
@@ -588,9 +597,6 @@
# `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 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). Each `Status` message contains
@@ -598,22 +604,16 @@
#
# 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.
},
],
- "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.
- },
- "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.
},
}</pre>
</div>