chore: regens API reference docs (#889)
diff --git a/docs/dyn/tpu_v1alpha1.projects.locations.nodes.html b/docs/dyn/tpu_v1alpha1.projects.locations.nodes.html
index e366c6a..25aef57 100644
--- a/docs/dyn/tpu_v1alpha1.projects.locations.nodes.html
+++ b/docs/dyn/tpu_v1alpha1.projects.locations.nodes.html
@@ -75,7 +75,7 @@
<h1><a href="tpu_v1alpha1.html">Cloud TPU API</a> . <a href="tpu_v1alpha1.projects.html">projects</a> . <a href="tpu_v1alpha1.projects.locations.html">locations</a> . <a href="tpu_v1alpha1.projects.locations.nodes.html">nodes</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#create">create(parent, body, nodeId=None, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(parent, body=None, nodeId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a node.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
@@ -90,7 +90,7 @@
<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="#reimage">reimage(name, body, x__xgafv=None)</a></code></p>
+ <code><a href="#reimage">reimage(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Reimages a node's OS.</p>
<p class="toc_element">
<code><a href="#start">start(name, body=None, x__xgafv=None)</a></code></p>
@@ -100,12 +100,12 @@
<p class="firstline">Stops a node.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(parent, body, nodeId=None, x__xgafv=None)</code>
+ <code class="details" id="create">create(parent, body=None, nodeId=None, x__xgafv=None)</code>
<pre>Creates a node.
Args:
parent: string, The parent resource name. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # A TPU instance.
@@ -121,28 +121,23 @@
# 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.
- # Required.
"description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters.
- "healthDescription": "A String", # Output only.
- # If this field is populated, it contains a description of why the TPU Node
+ "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.
+ "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.
- "createTime": "A String", # Output only.
- # The time when the node was created.
+ "createTime": "A String", # Output only. The time when the node was created.
"tensorflowVersion": "A String", # The version of Tensorflow running in the Node.
# Required.
"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.
- "state": "A String", # Output only.
- # The current state for the TPU Node.
+ "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
# sent work. It is recommended that Tensorflow clients of the node reach out
@@ -154,15 +149,12 @@
],
"acceleratorType": "A String", # The type of hardware accelerators associated with this node.
# Required.
- "ipAddress": "A String", # Output only.
- # DEPRECATED! Use network_endpoints instead.
+ "ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
# The network address for the TPU Node as visible to Compute Engine
# instances.
- "port": "A String", # Output only.
- # DEPRECATED! Use network_endpoints instead.
+ "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
+ "name": "A String", # Output only. The immutable name of the TPU
}
nodeId: string, The unqualified resource name.
@@ -176,58 +168,19 @@
{ # 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.
+ },
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). The error model is designed to be:
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
#
- # - Simple to use and understand for most users
- # - Flexible enough to meet unexpected needs
- #
- # # Overview
- #
- # The `Status` message contains three pieces of data: error code, error
- # message, and error details. The error code should be an enum value of
- # google.rpc.Code, but it may accept additional error codes if needed. The
- # error message should be a developer-facing English message that helps
- # developers *understand* and *resolve* the error. If a localized user-facing
- # error message is needed, put the localized message in the error details or
- # localize it in the client. The optional error details may contain arbitrary
- # information about the error. There is a predefined set of error detail types
- # in the package `google.rpc` that can be used for common error conditions.
- #
- # # Language mapping
- #
- # The `Status` message is the logical representation of the error model, but it
- # is not necessarily the actual wire format. When the `Status` message is
- # exposed in different client libraries and different wire protocols, it can be
- # mapped differently. For example, it will likely be mapped to some exceptions
- # in Java, but more likely mapped to some error codes in C.
- #
- # # Other uses
- #
- # The error model and the `Status` message can be used in a variety of
- # environments, either with or without APIs, to provide a
- # consistent developer experience across different environments.
- #
- # Example uses of this error model include:
- #
- # - Partial errors. If a service needs to return partial errors to the client,
- # it may embed the `Status` in the normal response to indicate the partial
- # errors.
- #
- # - Workflow errors. A typical workflow has multiple steps. Each step may
- # have a `Status` message for error reporting.
- #
- # - Batch operations. If a client uses batch request and batch response, the
- # `Status` message should be used directly inside batch response, one for
- # each error sub-response.
- #
- # - Asynchronous operations. If an API call embeds asynchronous operation
- # results in its response, the status of those operations should be
- # represented directly using the `Status` message.
- #
- # - Logging. If some API errors are stored in logs, the message `Status` could
- # be used directly after any stripping needed for security/privacy reasons.
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
@@ -255,12 +208,6 @@
"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
- # 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>
@@ -280,58 +227,19 @@
{ # 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.
+ },
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). The error model is designed to be:
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
#
- # - Simple to use and understand for most users
- # - Flexible enough to meet unexpected needs
- #
- # # Overview
- #
- # The `Status` message contains three pieces of data: error code, error
- # message, and error details. The error code should be an enum value of
- # google.rpc.Code, but it may accept additional error codes if needed. The
- # error message should be a developer-facing English message that helps
- # developers *understand* and *resolve* the error. If a localized user-facing
- # error message is needed, put the localized message in the error details or
- # localize it in the client. The optional error details may contain arbitrary
- # information about the error. There is a predefined set of error detail types
- # in the package `google.rpc` that can be used for common error conditions.
- #
- # # Language mapping
- #
- # The `Status` message is the logical representation of the error model, but it
- # is not necessarily the actual wire format. When the `Status` message is
- # exposed in different client libraries and different wire protocols, it can be
- # mapped differently. For example, it will likely be mapped to some exceptions
- # in Java, but more likely mapped to some error codes in C.
- #
- # # Other uses
- #
- # The error model and the `Status` message can be used in a variety of
- # environments, either with or without APIs, to provide a
- # consistent developer experience across different environments.
- #
- # Example uses of this error model include:
- #
- # - Partial errors. If a service needs to return partial errors to the client,
- # it may embed the `Status` in the normal response to indicate the partial
- # errors.
- #
- # - Workflow errors. A typical workflow has multiple steps. Each step may
- # have a `Status` message for error reporting.
- #
- # - Batch operations. If a client uses batch request and batch response, the
- # `Status` message should be used directly inside batch response, one for
- # each error sub-response.
- #
- # - Asynchronous operations. If an API call embeds asynchronous operation
- # results in its response, the status of those operations should be
- # represented directly using the `Status` message.
- #
- # - Logging. If some API errors are stored in logs, the message `Status` could
- # be used directly after any stripping needed for security/privacy reasons.
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
@@ -359,12 +267,6 @@
"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
- # 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>
@@ -395,28 +297,23 @@
# 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.
- # Required.
"description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters.
- "healthDescription": "A String", # Output only.
- # If this field is populated, it contains a description of why the TPU Node
+ "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.
+ "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.
- "createTime": "A String", # Output only.
- # The time when the node was created.
+ "createTime": "A String", # Output only. The time when the node was created.
"tensorflowVersion": "A String", # The version of Tensorflow running in the Node.
# Required.
"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.
- "state": "A String", # Output only.
- # The current state for the TPU Node.
+ "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
# sent work. It is recommended that Tensorflow clients of the node reach out
@@ -428,15 +325,12 @@
],
"acceleratorType": "A String", # The type of hardware accelerators associated with this node.
# Required.
- "ipAddress": "A String", # Output only.
- # DEPRECATED! Use network_endpoints instead.
+ "ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
# The network address for the TPU Node as visible to Compute Engine
# instances.
- "port": "A String", # Output only.
- # DEPRECATED! Use network_endpoints instead.
+ "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
+ "name": "A String", # Output only. The immutable name of the TPU
}</pre>
</div>
@@ -475,28 +369,23 @@
# 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.
- # Required.
"description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters.
- "healthDescription": "A String", # Output only.
- # If this field is populated, it contains a description of why the TPU Node
+ "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.
+ "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.
- "createTime": "A String", # Output only.
- # The time when the node was created.
+ "createTime": "A String", # Output only. The time when the node was created.
"tensorflowVersion": "A String", # The version of Tensorflow running in the Node.
# Required.
"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.
- "state": "A String", # Output only.
- # The current state for the TPU Node.
+ "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
# sent work. It is recommended that Tensorflow clients of the node reach out
@@ -508,15 +397,12 @@
],
"acceleratorType": "A String", # The type of hardware accelerators associated with this node.
# Required.
- "ipAddress": "A String", # Output only.
- # DEPRECATED! Use network_endpoints instead.
+ "ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
# The network address for the TPU Node as visible to Compute Engine
# instances.
- "port": "A String", # Output only.
- # DEPRECATED! Use network_endpoints instead.
+ "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
+ "name": "A String", # Output only. The immutable name of the TPU
},
],
}</pre>
@@ -537,12 +423,12 @@
</div>
<div class="method">
- <code class="details" id="reimage">reimage(name, body, x__xgafv=None)</code>
+ <code class="details" id="reimage">reimage(name, body=None, x__xgafv=None)</code>
<pre>Reimages a node's OS.
Args:
name: string, The resource name. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request for ReimageNode.
@@ -559,58 +445,19 @@
{ # 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.
+ },
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). The error model is designed to be:
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
#
- # - Simple to use and understand for most users
- # - Flexible enough to meet unexpected needs
- #
- # # Overview
- #
- # The `Status` message contains three pieces of data: error code, error
- # message, and error details. The error code should be an enum value of
- # google.rpc.Code, but it may accept additional error codes if needed. The
- # error message should be a developer-facing English message that helps
- # developers *understand* and *resolve* the error. If a localized user-facing
- # error message is needed, put the localized message in the error details or
- # localize it in the client. The optional error details may contain arbitrary
- # information about the error. There is a predefined set of error detail types
- # in the package `google.rpc` that can be used for common error conditions.
- #
- # # Language mapping
- #
- # The `Status` message is the logical representation of the error model, but it
- # is not necessarily the actual wire format. When the `Status` message is
- # exposed in different client libraries and different wire protocols, it can be
- # mapped differently. For example, it will likely be mapped to some exceptions
- # in Java, but more likely mapped to some error codes in C.
- #
- # # Other uses
- #
- # The error model and the `Status` message can be used in a variety of
- # environments, either with or without APIs, to provide a
- # consistent developer experience across different environments.
- #
- # Example uses of this error model include:
- #
- # - Partial errors. If a service needs to return partial errors to the client,
- # it may embed the `Status` in the normal response to indicate the partial
- # errors.
- #
- # - Workflow errors. A typical workflow has multiple steps. Each step may
- # have a `Status` message for error reporting.
- #
- # - Batch operations. If a client uses batch request and batch response, the
- # `Status` message should be used directly inside batch response, one for
- # each error sub-response.
- #
- # - Asynchronous operations. If an API call embeds asynchronous operation
- # results in its response, the status of those operations should be
- # represented directly using the `Status` message.
- #
- # - Logging. If some API errors are stored in logs, the message `Status` could
- # be used directly after any stripping needed for security/privacy reasons.
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
@@ -638,12 +485,6 @@
"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
- # 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>
@@ -669,58 +510,19 @@
{ # 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.
+ },
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). The error model is designed to be:
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
#
- # - Simple to use and understand for most users
- # - Flexible enough to meet unexpected needs
- #
- # # Overview
- #
- # The `Status` message contains three pieces of data: error code, error
- # message, and error details. The error code should be an enum value of
- # google.rpc.Code, but it may accept additional error codes if needed. The
- # error message should be a developer-facing English message that helps
- # developers *understand* and *resolve* the error. If a localized user-facing
- # error message is needed, put the localized message in the error details or
- # localize it in the client. The optional error details may contain arbitrary
- # information about the error. There is a predefined set of error detail types
- # in the package `google.rpc` that can be used for common error conditions.
- #
- # # Language mapping
- #
- # The `Status` message is the logical representation of the error model, but it
- # is not necessarily the actual wire format. When the `Status` message is
- # exposed in different client libraries and different wire protocols, it can be
- # mapped differently. For example, it will likely be mapped to some exceptions
- # in Java, but more likely mapped to some error codes in C.
- #
- # # Other uses
- #
- # The error model and the `Status` message can be used in a variety of
- # environments, either with or without APIs, to provide a
- # consistent developer experience across different environments.
- #
- # Example uses of this error model include:
- #
- # - Partial errors. If a service needs to return partial errors to the client,
- # it may embed the `Status` in the normal response to indicate the partial
- # errors.
- #
- # - Workflow errors. A typical workflow has multiple steps. Each step may
- # have a `Status` message for error reporting.
- #
- # - Batch operations. If a client uses batch request and batch response, the
- # `Status` message should be used directly inside batch response, one for
- # each error sub-response.
- #
- # - Asynchronous operations. If an API call embeds asynchronous operation
- # results in its response, the status of those operations should be
- # represented directly using the `Status` message.
- #
- # - Logging. If some API errors are stored in logs, the message `Status` could
- # be used directly after any stripping needed for security/privacy reasons.
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
@@ -748,12 +550,6 @@
"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
- # 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>
@@ -779,58 +575,19 @@
{ # 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.
+ },
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). The error model is designed to be:
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
#
- # - Simple to use and understand for most users
- # - Flexible enough to meet unexpected needs
- #
- # # Overview
- #
- # The `Status` message contains three pieces of data: error code, error
- # message, and error details. The error code should be an enum value of
- # google.rpc.Code, but it may accept additional error codes if needed. The
- # error message should be a developer-facing English message that helps
- # developers *understand* and *resolve* the error. If a localized user-facing
- # error message is needed, put the localized message in the error details or
- # localize it in the client. The optional error details may contain arbitrary
- # information about the error. There is a predefined set of error detail types
- # in the package `google.rpc` that can be used for common error conditions.
- #
- # # Language mapping
- #
- # The `Status` message is the logical representation of the error model, but it
- # is not necessarily the actual wire format. When the `Status` message is
- # exposed in different client libraries and different wire protocols, it can be
- # mapped differently. For example, it will likely be mapped to some exceptions
- # in Java, but more likely mapped to some error codes in C.
- #
- # # Other uses
- #
- # The error model and the `Status` message can be used in a variety of
- # environments, either with or without APIs, to provide a
- # consistent developer experience across different environments.
- #
- # Example uses of this error model include:
- #
- # - Partial errors. If a service needs to return partial errors to the client,
- # it may embed the `Status` in the normal response to indicate the partial
- # errors.
- #
- # - Workflow errors. A typical workflow has multiple steps. Each step may
- # have a `Status` message for error reporting.
- #
- # - Batch operations. If a client uses batch request and batch response, the
- # `Status` message should be used directly inside batch response, one for
- # each error sub-response.
- #
- # - Asynchronous operations. If an API call embeds asynchronous operation
- # results in its response, the status of those operations should be
- # represented directly using the `Status` message.
- #
- # - Logging. If some API errors are stored in logs, the message `Status` could
- # be used directly after any stripping needed for security/privacy reasons.
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
@@ -858,12 +615,6 @@
"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
- # 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>