docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/tpu_v1.projects.locations.nodes.html b/docs/dyn/tpu_v1.projects.locations.nodes.html
index a890e0c..8455e51 100644
--- a/docs/dyn/tpu_v1.projects.locations.nodes.html
+++ b/docs/dyn/tpu_v1.projects.locations.nodes.html
@@ -75,6 +75,9 @@
<h1><a href="tpu_v1.html">Cloud TPU API</a> . <a href="tpu_v1.projects.html">projects</a> . <a href="tpu_v1.projects.locations.html">locations</a> . <a href="tpu_v1.projects.locations.nodes.html">nodes</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
<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">
@@ -100,6 +103,11 @@
<p class="firstline">Stops a node.</p>
<h3>Method Details</h3>
<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
<code class="details" id="create">create(parent, body=None, nodeId=None, x__xgafv=None)</code>
<pre>Creates a node.
@@ -109,52 +117,41 @@
The object takes the form of:
{ # A TPU instance.
- "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.
- "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.
- "ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
- # The network address for the TPU Node as visible to Compute Engine
- # instances.
- "name": "A String", # Output only. The immutable name of the TPU
- "state": "A String", # Output only. The current state for the TPU Node.
- "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.
+ "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.
+ "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 provided network is peered with another network that is using that CIDR block.
+ "createTime": "A String", # Output only. The time when the node was created.
+ "useServiceNetworking": True or False, # Whether the VPC peering for the node is set up through Service Networking API. The VPC Peering should be set up before provisioning the node. If this field is set, cidr_block field should not be specified. If the network, that you want to peer the TPU Node to, is Shared VPC networks, the node must be created with this this field enabled.
+ "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.
},
],
- "healthDescription": "A String", # Output only. If this field is populated, it contains a description of why the TPU Node
- # is unhealthy.
- "schedulingConfig": { # Sets the scheduling options for this node.
- "preemptible": True or False, # Defines whether the node is preemptible.
- "reserved": True or False, # Whether the node is created under a reservation.
- },
+ "description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters.
+ "ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead. The network address 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. Required.
"health": "A String", # The health status of the TPU node.
- "port": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
- # The network port for the TPU Node as visible to Compute Engine instances.
- "acceleratorType": "A String", # The type of hardware accelerators associated with this node.
- # Required.
+ "port": "A String", # Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances.
+ "symptoms": [ # Output only. The Symptoms that have occurred to the TPU Node.
+ { # A Symptom instance.
+ "details": "A String", # Detailed information of the current Symptom.
+ "workerId": "A String", # A string used to uniquely distinguish a worker within a TPU node.
+ "symptomType": "A String", # Type of the Symptom.
+ "createTime": "A String", # Timestamp when the Symptom is created.
+ },
+ ],
+ "acceleratorType": "A String", # The type of hardware accelerators associated with this node. Required.
+ "schedulingConfig": { # Sets the scheduling options for this node.
+ "reserved": True or False, # Whether the node is created under a reservation.
+ "preemptible": True or False, # Defines whether the node is preemptible.
+ },
"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.
- # 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
- # provided network is peered with another network that is using that CIDR
- # block.
- "createTime": "A String", # Output only. The time when the node was created.
- "tensorflowVersion": "A String", # The version of Tensorflow running in the Node.
- # Required.
+ "state": "A String", # Output only. The current state for the TPU Node.
+ "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.
}
nodeId: string, The unqualified resource name.
@@ -166,48 +163,24 @@
Returns:
An object of the form:
- { # This resource represents a long-running operation that is the result of a
- # network API call.
- "response": { # The normal response of the operation in case of success. If the original
- # method returns no data on success, such as `Delete`, the response is
- # `google.protobuf.Empty`. If the original method is standard
- # `Get`/`Create`/`Update`, the response should be the resource. For other
- # methods, the response should have the type `XxxResponse`, where `Xxx`
- # is the original method name. For example, if the original method name
- # is `TakeSnapshot()`, the inferred response type is
- # `TakeSnapshotResponse`.
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "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}`.
+ "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). 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).
+ "error": { # The `Status` type defines a logical error model that is suitable for 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). # The error result of the operation in case of failure or cancellation.
"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.
+ "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.
},
],
- "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.
+ "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.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that
- # originally returns it. If you use the default HTTP mapping, the
- # `name` should be a resource name ending with `operations/{unique_id}`.
- "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.
}</pre>
</div>
@@ -225,48 +198,24 @@
Returns:
An object of the form:
- { # This resource represents a long-running operation that is the result of a
- # network API call.
- "response": { # The normal response of the operation in case of success. If the original
- # method returns no data on success, such as `Delete`, the response is
- # `google.protobuf.Empty`. If the original method is standard
- # `Get`/`Create`/`Update`, the response should be the resource. For other
- # methods, the response should have the type `XxxResponse`, where `Xxx`
- # is the original method name. For example, if the original method name
- # is `TakeSnapshot()`, the inferred response type is
- # `TakeSnapshotResponse`.
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "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}`.
+ "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). 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).
+ "error": { # The `Status` type defines a logical error model that is suitable for 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). # The error result of the operation in case of failure or cancellation.
"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.
+ "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.
},
],
- "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.
+ "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.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that
- # originally returns it. If you use the default HTTP mapping, the
- # `name` should be a resource name ending with `operations/{unique_id}`.
- "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.
}</pre>
</div>
@@ -285,52 +234,41 @@
An object of the form:
{ # A TPU instance.
- "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.
- "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.
- "ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
- # The network address for the TPU Node as visible to Compute Engine
- # instances.
- "name": "A String", # Output only. The immutable name of the TPU
- "state": "A String", # Output only. The current state for the TPU Node.
- "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.
+ "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.
+ "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 provided network is peered with another network that is using that CIDR block.
+ "createTime": "A String", # Output only. The time when the node was created.
+ "useServiceNetworking": True or False, # Whether the VPC peering for the node is set up through Service Networking API. The VPC Peering should be set up before provisioning the node. If this field is set, cidr_block field should not be specified. If the network, that you want to peer the TPU Node to, is Shared VPC networks, the node must be created with this this field enabled.
+ "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.
},
],
- "healthDescription": "A String", # Output only. If this field is populated, it contains a description of why the TPU Node
- # is unhealthy.
- "schedulingConfig": { # Sets the scheduling options for this node.
- "preemptible": True or False, # Defines whether the node is preemptible.
- "reserved": True or False, # Whether the node is created under a reservation.
- },
+ "description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters.
+ "ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead. The network address 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. Required.
"health": "A String", # The health status of the TPU node.
- "port": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
- # The network port for the TPU Node as visible to Compute Engine instances.
- "acceleratorType": "A String", # The type of hardware accelerators associated with this node.
- # Required.
+ "port": "A String", # Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances.
+ "symptoms": [ # Output only. The Symptoms that have occurred to the TPU Node.
+ { # A Symptom instance.
+ "details": "A String", # Detailed information of the current Symptom.
+ "workerId": "A String", # A string used to uniquely distinguish a worker within a TPU node.
+ "symptomType": "A String", # Type of the Symptom.
+ "createTime": "A String", # Timestamp when the Symptom is created.
+ },
+ ],
+ "acceleratorType": "A String", # The type of hardware accelerators associated with this node. Required.
+ "schedulingConfig": { # Sets the scheduling options for this node.
+ "reserved": True or False, # Whether the node is created under a reservation.
+ "preemptible": True or False, # Defines whether the node is preemptible.
+ },
"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.
- # 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
- # provided network is peered with another network that is using that CIDR
- # block.
- "createTime": "A String", # Output only. The time when the node was created.
- "tensorflowVersion": "A String", # The version of Tensorflow running in the Node.
- # Required.
+ "state": "A String", # Output only. The current state for the TPU Node.
+ "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.
}</pre>
</div>
@@ -354,57 +292,46 @@
"unreachable": [ # Locations that could not be reached.
"A String",
],
- "nextPageToken": "A String", # The next page token or empty if none.
"nodes": [ # The listed nodes.
{ # A TPU instance.
- "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.
- "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.
- "ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
- # The network address for the TPU Node as visible to Compute Engine
- # instances.
- "name": "A String", # Output only. The immutable name of the TPU
- "state": "A String", # Output only. The current state for the TPU Node.
- "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.
+ "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.
+ "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 provided network is peered with another network that is using that CIDR block.
+ "createTime": "A String", # Output only. The time when the node was created.
+ "useServiceNetworking": True or False, # Whether the VPC peering for the node is set up through Service Networking API. The VPC Peering should be set up before provisioning the node. If this field is set, cidr_block field should not be specified. If the network, that you want to peer the TPU Node to, is Shared VPC networks, the node must be created with this this field enabled.
+ "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.
},
],
- "healthDescription": "A String", # Output only. If this field is populated, it contains a description of why the TPU Node
- # is unhealthy.
- "schedulingConfig": { # Sets the scheduling options for this node.
- "preemptible": True or False, # Defines whether the node is preemptible.
- "reserved": True or False, # Whether the node is created under a reservation.
- },
+ "description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters.
+ "ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead. The network address 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. Required.
"health": "A String", # The health status of the TPU node.
- "port": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
- # The network port for the TPU Node as visible to Compute Engine instances.
- "acceleratorType": "A String", # The type of hardware accelerators associated with this node.
- # Required.
+ "port": "A String", # Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances.
+ "symptoms": [ # Output only. The Symptoms that have occurred to the TPU Node.
+ { # A Symptom instance.
+ "details": "A String", # Detailed information of the current Symptom.
+ "workerId": "A String", # A string used to uniquely distinguish a worker within a TPU node.
+ "symptomType": "A String", # Type of the Symptom.
+ "createTime": "A String", # Timestamp when the Symptom is created.
+ },
+ ],
+ "acceleratorType": "A String", # The type of hardware accelerators associated with this node. Required.
+ "schedulingConfig": { # Sets the scheduling options for this node.
+ "reserved": True or False, # Whether the node is created under a reservation.
+ "preemptible": True or False, # Defines whether the node is preemptible.
+ },
"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.
- # 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
- # provided network is peered with another network that is using that CIDR
- # block.
- "createTime": "A String", # Output only. The time when the node was created.
- "tensorflowVersion": "A String", # The version of Tensorflow running in the Node.
- # Required.
+ "state": "A String", # Output only. The current state for the TPU Node.
+ "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.
},
],
+ "nextPageToken": "A String", # The next page token or empty if none.
}</pre>
</div>
@@ -443,48 +370,24 @@
Returns:
An object of the form:
- { # This resource represents a long-running operation that is the result of a
- # network API call.
- "response": { # The normal response of the operation in case of success. If the original
- # method returns no data on success, such as `Delete`, the response is
- # `google.protobuf.Empty`. If the original method is standard
- # `Get`/`Create`/`Update`, the response should be the resource. For other
- # methods, the response should have the type `XxxResponse`, where `Xxx`
- # is the original method name. For example, if the original method name
- # is `TakeSnapshot()`, the inferred response type is
- # `TakeSnapshotResponse`.
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "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}`.
+ "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). 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).
+ "error": { # The `Status` type defines a logical error model that is suitable for 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). # The error result of the operation in case of failure or cancellation.
"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.
+ "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.
},
],
- "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.
+ "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.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that
- # originally returns it. If you use the default HTTP mapping, the
- # `name` should be a resource name ending with `operations/{unique_id}`.
- "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.
}</pre>
</div>
@@ -508,48 +411,24 @@
Returns:
An object of the form:
- { # This resource represents a long-running operation that is the result of a
- # network API call.
- "response": { # The normal response of the operation in case of success. If the original
- # method returns no data on success, such as `Delete`, the response is
- # `google.protobuf.Empty`. If the original method is standard
- # `Get`/`Create`/`Update`, the response should be the resource. For other
- # methods, the response should have the type `XxxResponse`, where `Xxx`
- # is the original method name. For example, if the original method name
- # is `TakeSnapshot()`, the inferred response type is
- # `TakeSnapshotResponse`.
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "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}`.
+ "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). 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).
+ "error": { # The `Status` type defines a logical error model that is suitable for 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). # The error result of the operation in case of failure or cancellation.
"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.
+ "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.
},
],
- "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.
+ "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.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that
- # originally returns it. If you use the default HTTP mapping, the
- # `name` should be a resource name ending with `operations/{unique_id}`.
- "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.
}</pre>
</div>
@@ -573,48 +452,24 @@
Returns:
An object of the form:
- { # This resource represents a long-running operation that is the result of a
- # network API call.
- "response": { # The normal response of the operation in case of success. If the original
- # method returns no data on success, such as `Delete`, the response is
- # `google.protobuf.Empty`. If the original method is standard
- # `Get`/`Create`/`Update`, the response should be the resource. For other
- # methods, the response should have the type `XxxResponse`, where `Xxx`
- # is the original method name. For example, if the original method name
- # is `TakeSnapshot()`, the inferred response type is
- # `TakeSnapshotResponse`.
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "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}`.
+ "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). 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).
+ "error": { # The `Status` type defines a logical error model that is suitable for 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). # The error result of the operation in case of failure or cancellation.
"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.
+ "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.
},
],
- "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.
+ "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.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that
- # originally returns it. If you use the default HTTP mapping, the
- # `name` should be a resource name ending with `operations/{unique_id}`.
- "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.
}</pre>
</div>