1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<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> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(parent, body=None, nodeId=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates a node.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes a node.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets the details of a node.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists nodes.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#reimage">reimage(name, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Reimages a node's OS.</p> 98<p class="toc_element"> 99 <code><a href="#start">start(name, body=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Starts a node.</p> 101<p class="toc_element"> 102 <code><a href="#stop">stop(name, body=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Stops a node, this operation is only available with single TPU nodes.</p> 104<h3>Method Details</h3> 105<div class="method"> 106 <code class="details" id="close">close()</code> 107 <pre>Close httplib2 connections.</pre> 108</div> 109 110<div class="method"> 111 <code class="details" id="create">create(parent, body=None, nodeId=None, x__xgafv=None)</code> 112 <pre>Creates a node. 113 114Args: 115 parent: string, Required. The parent resource name. (required) 116 body: object, The request body. 117 The object takes the form of: 118 119{ # A TPU instance. 120 "acceleratorType": "A String", # Required. The type of hardware accelerators associated with this node. 121 "apiVersion": "A String", # Output only. The API version that created this Node. 122 "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. 123 "createTime": "A String", # Output only. The time when the node was created. 124 "description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters. 125 "health": "A String", # The health status of the TPU node. 126 "healthDescription": "A String", # Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy. 127 "ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances. 128 "labels": { # Resource labels to represent user-provided metadata. 129 "a_key": "A String", 130 }, 131 "name": "A String", # Output only. Immutable. The name of the TPU 132 "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. 133 "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. 134 { # A network endpoint over which a TPU worker can be reached. 135 "ipAddress": "A String", # The IP address of this network endpoint. 136 "port": 42, # The port of this network endpoint. 137 }, 138 ], 139 "port": "A String", # Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances. 140 "schedulingConfig": { # Sets the scheduling options for this node. # The scheduling options for this node. 141 "preemptible": True or False, # Defines whether the node is preemptible. 142 "reserved": True or False, # Whether the node is created under a reservation. 143 }, 144 "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. 145 "state": "A String", # Output only. The current state for the TPU Node. 146 "symptoms": [ # Output only. The Symptoms that have occurred to the TPU Node. 147 { # A Symptom instance. 148 "createTime": "A String", # Timestamp when the Symptom is created. 149 "details": "A String", # Detailed information of the current Symptom. 150 "symptomType": "A String", # Type of the Symptom. 151 "workerId": "A String", # A string used to uniquely distinguish a worker within a TPU node. 152 }, 153 ], 154 "tensorflowVersion": "A String", # Required. The version of Tensorflow running in the Node. 155 "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. 156} 157 158 nodeId: string, The unqualified resource name. 159 x__xgafv: string, V1 error format. 160 Allowed values 161 1 - v1 error format 162 2 - v2 error format 163 164Returns: 165 An object of the form: 166 167 { # This resource represents a long-running operation that is the result of a network API call. 168 "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. 169 "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. 170 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 171 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 172 { 173 "a_key": "", # Properties of the object. Contains field @type with type URL. 174 }, 175 ], 176 "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. 177 }, 178 "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. 179 "a_key": "", # Properties of the object. Contains field @type with type URL. 180 }, 181 "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}`. 182 "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`. 183 "a_key": "", # Properties of the object. Contains field @type with type URL. 184 }, 185}</pre> 186</div> 187 188<div class="method"> 189 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 190 <pre>Deletes a node. 191 192Args: 193 name: string, Required. The resource name. (required) 194 x__xgafv: string, V1 error format. 195 Allowed values 196 1 - v1 error format 197 2 - v2 error format 198 199Returns: 200 An object of the form: 201 202 { # This resource represents a long-running operation that is the result of a network API call. 203 "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. 204 "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. 205 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 206 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 207 { 208 "a_key": "", # Properties of the object. Contains field @type with type URL. 209 }, 210 ], 211 "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. 212 }, 213 "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. 214 "a_key": "", # Properties of the object. Contains field @type with type URL. 215 }, 216 "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}`. 217 "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`. 218 "a_key": "", # Properties of the object. Contains field @type with type URL. 219 }, 220}</pre> 221</div> 222 223<div class="method"> 224 <code class="details" id="get">get(name, x__xgafv=None)</code> 225 <pre>Gets the details of a node. 226 227Args: 228 name: string, Required. The resource name. (required) 229 x__xgafv: string, V1 error format. 230 Allowed values 231 1 - v1 error format 232 2 - v2 error format 233 234Returns: 235 An object of the form: 236 237 { # A TPU instance. 238 "acceleratorType": "A String", # Required. The type of hardware accelerators associated with this node. 239 "apiVersion": "A String", # Output only. The API version that created this Node. 240 "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. 241 "createTime": "A String", # Output only. The time when the node was created. 242 "description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters. 243 "health": "A String", # The health status of the TPU node. 244 "healthDescription": "A String", # Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy. 245 "ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances. 246 "labels": { # Resource labels to represent user-provided metadata. 247 "a_key": "A String", 248 }, 249 "name": "A String", # Output only. Immutable. The name of the TPU 250 "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. 251 "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. 252 { # A network endpoint over which a TPU worker can be reached. 253 "ipAddress": "A String", # The IP address of this network endpoint. 254 "port": 42, # The port of this network endpoint. 255 }, 256 ], 257 "port": "A String", # Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances. 258 "schedulingConfig": { # Sets the scheduling options for this node. # The scheduling options for this node. 259 "preemptible": True or False, # Defines whether the node is preemptible. 260 "reserved": True or False, # Whether the node is created under a reservation. 261 }, 262 "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. 263 "state": "A String", # Output only. The current state for the TPU Node. 264 "symptoms": [ # Output only. The Symptoms that have occurred to the TPU Node. 265 { # A Symptom instance. 266 "createTime": "A String", # Timestamp when the Symptom is created. 267 "details": "A String", # Detailed information of the current Symptom. 268 "symptomType": "A String", # Type of the Symptom. 269 "workerId": "A String", # A string used to uniquely distinguish a worker within a TPU node. 270 }, 271 ], 272 "tensorflowVersion": "A String", # Required. The version of Tensorflow running in the Node. 273 "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. 274}</pre> 275</div> 276 277<div class="method"> 278 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 279 <pre>Lists nodes. 280 281Args: 282 parent: string, Required. The parent resource name. (required) 283 pageSize: integer, The maximum number of items to return. 284 pageToken: string, The next_page_token value returned from a previous List request, if any. 285 x__xgafv: string, V1 error format. 286 Allowed values 287 1 - v1 error format 288 2 - v2 error format 289 290Returns: 291 An object of the form: 292 293 { # Response for ListNodes. 294 "nextPageToken": "A String", # The next page token or empty if none. 295 "nodes": [ # The listed nodes. 296 { # A TPU instance. 297 "acceleratorType": "A String", # Required. The type of hardware accelerators associated with this node. 298 "apiVersion": "A String", # Output only. The API version that created this Node. 299 "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. 300 "createTime": "A String", # Output only. The time when the node was created. 301 "description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters. 302 "health": "A String", # The health status of the TPU node. 303 "healthDescription": "A String", # Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy. 304 "ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances. 305 "labels": { # Resource labels to represent user-provided metadata. 306 "a_key": "A String", 307 }, 308 "name": "A String", # Output only. Immutable. The name of the TPU 309 "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. 310 "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. 311 { # A network endpoint over which a TPU worker can be reached. 312 "ipAddress": "A String", # The IP address of this network endpoint. 313 "port": 42, # The port of this network endpoint. 314 }, 315 ], 316 "port": "A String", # Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances. 317 "schedulingConfig": { # Sets the scheduling options for this node. # The scheduling options for this node. 318 "preemptible": True or False, # Defines whether the node is preemptible. 319 "reserved": True or False, # Whether the node is created under a reservation. 320 }, 321 "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. 322 "state": "A String", # Output only. The current state for the TPU Node. 323 "symptoms": [ # Output only. The Symptoms that have occurred to the TPU Node. 324 { # A Symptom instance. 325 "createTime": "A String", # Timestamp when the Symptom is created. 326 "details": "A String", # Detailed information of the current Symptom. 327 "symptomType": "A String", # Type of the Symptom. 328 "workerId": "A String", # A string used to uniquely distinguish a worker within a TPU node. 329 }, 330 ], 331 "tensorflowVersion": "A String", # Required. The version of Tensorflow running in the Node. 332 "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. 333 }, 334 ], 335 "unreachable": [ # Locations that could not be reached. 336 "A String", 337 ], 338}</pre> 339</div> 340 341<div class="method"> 342 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 343 <pre>Retrieves the next page of results. 344 345Args: 346 previous_request: The request for the previous page. (required) 347 previous_response: The response from the request for the previous page. (required) 348 349Returns: 350 A request object that you can call 'execute()' on to request the next 351 page. Returns None if there are no more items in the collection. 352 </pre> 353</div> 354 355<div class="method"> 356 <code class="details" id="reimage">reimage(name, body=None, x__xgafv=None)</code> 357 <pre>Reimages a node's OS. 358 359Args: 360 name: string, The resource name. (required) 361 body: object, The request body. 362 The object takes the form of: 363 364{ # Request for ReimageNode. 365 "tensorflowVersion": "A String", # The version for reimage to create. 366} 367 368 x__xgafv: string, V1 error format. 369 Allowed values 370 1 - v1 error format 371 2 - v2 error format 372 373Returns: 374 An object of the form: 375 376 { # This resource represents a long-running operation that is the result of a network API call. 377 "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. 378 "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. 379 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 380 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 381 { 382 "a_key": "", # Properties of the object. Contains field @type with type URL. 383 }, 384 ], 385 "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. 386 }, 387 "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. 388 "a_key": "", # Properties of the object. Contains field @type with type URL. 389 }, 390 "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}`. 391 "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`. 392 "a_key": "", # Properties of the object. Contains field @type with type URL. 393 }, 394}</pre> 395</div> 396 397<div class="method"> 398 <code class="details" id="start">start(name, body=None, x__xgafv=None)</code> 399 <pre>Starts a node. 400 401Args: 402 name: string, The resource name. (required) 403 body: object, The request body. 404 The object takes the form of: 405 406{ # Request for StartNode. 407} 408 409 x__xgafv: string, V1 error format. 410 Allowed values 411 1 - v1 error format 412 2 - v2 error format 413 414Returns: 415 An object of the form: 416 417 { # This resource represents a long-running operation that is the result of a network API call. 418 "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. 419 "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. 420 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 421 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 422 { 423 "a_key": "", # Properties of the object. Contains field @type with type URL. 424 }, 425 ], 426 "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. 427 }, 428 "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. 429 "a_key": "", # Properties of the object. Contains field @type with type URL. 430 }, 431 "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}`. 432 "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`. 433 "a_key": "", # Properties of the object. Contains field @type with type URL. 434 }, 435}</pre> 436</div> 437 438<div class="method"> 439 <code class="details" id="stop">stop(name, body=None, x__xgafv=None)</code> 440 <pre>Stops a node, this operation is only available with single TPU nodes. 441 442Args: 443 name: string, The resource name. (required) 444 body: object, The request body. 445 The object takes the form of: 446 447{ # Request for StopNode. 448} 449 450 x__xgafv: string, V1 error format. 451 Allowed values 452 1 - v1 error format 453 2 - v2 error format 454 455Returns: 456 An object of the form: 457 458 { # This resource represents a long-running operation that is the result of a network API call. 459 "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. 460 "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. 461 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 462 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 463 { 464 "a_key": "", # Properties of the object. Contains field @type with type URL. 465 }, 466 ], 467 "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. 468 }, 469 "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. 470 "a_key": "", # Properties of the object. Contains field @type with type URL. 471 }, 472 "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}`. 473 "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`. 474 "a_key": "", # Properties of the object. Contains field @type with type URL. 475 }, 476}</pre> 477</div> 478 479</body></html>