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_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> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#create">create(parent, body, nodeId=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Creates a node.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes a node.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Gets the details of a node.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Lists nodes.</p> 89<p class="toc_element"> 90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 91<p class="firstline">Retrieves the next page of results.</p> 92<p class="toc_element"> 93 <code><a href="#reimage">reimage(name, body, x__xgafv=None)</a></code></p> 94<p class="firstline">Reimages a node's OS.</p> 95<p class="toc_element"> 96 <code><a href="#start">start(name, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Starts a node.</p> 98<p class="toc_element"> 99 <code><a href="#stop">stop(name, body=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Stops a node.</p> 101<h3>Method Details</h3> 102<div class="method"> 103 <code class="details" id="create">create(parent, body, nodeId=None, x__xgafv=None)</code> 104 <pre>Creates a node. 105 106Args: 107 parent: string, The parent resource name. (required) 108 body: object, The request body. (required) 109 The object takes the form of: 110 111{ # A TPU instance. 112 "schedulingConfig": { 113 "preemptible": True or False, 114 "reserved": True or False, # Whether the node is created under a reservation. 115 }, 116 "cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address. 117 # This CIDR block must be a /29 block; the Compute Engine networks API 118 # forbids a smaller block, and using a larger block would be wasteful (a 119 # node can only consume one IP address). Errors will occur if the CIDR block 120 # has already been used for a currently existing TPU node, the CIDR block 121 # conflicts with any subnetworks in the user's provided network, or the 122 # provided network is peered with another network that is using that CIDR 123 # block. 124 # Required. 125 "description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters. 126 "healthDescription": "A String", # Output only. 127 # If this field is populated, it contains a description of why the TPU Node 128 # is unhealthy. 129 "labels": { # Resource labels to represent user-provided metadata. 130 "a_key": "A String", 131 }, 132 "serviceAccount": "A String", # Output only. 133 # The service account used to run the tensor flow services within the node. 134 # To share resources, including Google Cloud Storage data, with the 135 # Tensorflow job running in the Node, this account must have permissions to 136 # that data. 137 "createTime": "A String", # Output only. 138 # The time when the node was created. 139 "tensorflowVersion": "A String", # The version of Tensorflow running in the Node. 140 # Required. 141 "network": "A String", # The name of a network they wish to peer the TPU node to. It must be a 142 # preexisting Compute Engine network inside of the project on which this API 143 # has been activated. If none is provided, "default" will be used. 144 "state": "A String", # Output only. 145 # The current state for the TPU Node. 146 "health": "A String", # The health status of the TPU node. 147 "networkEndpoints": [ # Output only. The network endpoints where TPU workers can be accessed and 148 # sent work. It is recommended that Tensorflow clients of the node reach out 149 # to the 0th entry in this map first. 150 { # A network endpoint over which a TPU worker can be reached. 151 "ipAddress": "A String", # The IP address of this network endpoint. 152 "port": 42, # The port of this network endpoint. 153 }, 154 ], 155 "acceleratorType": "A String", # The type of hardware accelerators associated with this node. 156 # Required. 157 "ipAddress": "A String", # Output only. 158 # DEPRECATED! Use network_endpoints instead. 159 # The network address for the TPU Node as visible to Compute Engine 160 # instances. 161 "port": "A String", # Output only. 162 # DEPRECATED! Use network_endpoints instead. 163 # The network port for the TPU Node as visible to Compute Engine instances. 164 "name": "A String", # Output only. 165 # The immutable name of the TPU 166} 167 168 nodeId: string, The unqualified resource name. 169 x__xgafv: string, V1 error format. 170 Allowed values 171 1 - v1 error format 172 2 - v2 error format 173 174Returns: 175 An object of the form: 176 177 { # This resource represents a long-running operation that is the result of a 178 # network API call. 179 "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. 180 # different programming environments, including REST APIs and RPC APIs. It is 181 # used by [gRPC](https://github.com/grpc). The error model is designed to be: 182 # 183 # - Simple to use and understand for most users 184 # - Flexible enough to meet unexpected needs 185 # 186 # # Overview 187 # 188 # The `Status` message contains three pieces of data: error code, error 189 # message, and error details. The error code should be an enum value of 190 # google.rpc.Code, but it may accept additional error codes if needed. The 191 # error message should be a developer-facing English message that helps 192 # developers *understand* and *resolve* the error. If a localized user-facing 193 # error message is needed, put the localized message in the error details or 194 # localize it in the client. The optional error details may contain arbitrary 195 # information about the error. There is a predefined set of error detail types 196 # in the package `google.rpc` that can be used for common error conditions. 197 # 198 # # Language mapping 199 # 200 # The `Status` message is the logical representation of the error model, but it 201 # is not necessarily the actual wire format. When the `Status` message is 202 # exposed in different client libraries and different wire protocols, it can be 203 # mapped differently. For example, it will likely be mapped to some exceptions 204 # in Java, but more likely mapped to some error codes in C. 205 # 206 # # Other uses 207 # 208 # The error model and the `Status` message can be used in a variety of 209 # environments, either with or without APIs, to provide a 210 # consistent developer experience across different environments. 211 # 212 # Example uses of this error model include: 213 # 214 # - Partial errors. If a service needs to return partial errors to the client, 215 # it may embed the `Status` in the normal response to indicate the partial 216 # errors. 217 # 218 # - Workflow errors. A typical workflow has multiple steps. Each step may 219 # have a `Status` message for error reporting. 220 # 221 # - Batch operations. If a client uses batch request and batch response, the 222 # `Status` message should be used directly inside batch response, one for 223 # each error sub-response. 224 # 225 # - Asynchronous operations. If an API call embeds asynchronous operation 226 # results in its response, the status of those operations should be 227 # represented directly using the `Status` message. 228 # 229 # - Logging. If some API errors are stored in logs, the message `Status` could 230 # be used directly after any stripping needed for security/privacy reasons. 231 "message": "A String", # A developer-facing error message, which should be in English. Any 232 # user-facing error message should be localized and sent in the 233 # google.rpc.Status.details field, or localized by the client. 234 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 235 "details": [ # A list of messages that carry the error details. There is a common set of 236 # message types for APIs to use. 237 { 238 "a_key": "", # Properties of the object. Contains field @type with type URL. 239 }, 240 ], 241 }, 242 "done": True or False, # If the value is `false`, it means the operation is still in progress. 243 # If `true`, the operation is completed, and either `error` or `response` is 244 # available. 245 "response": { # The normal response of the operation in case of success. If the original 246 # method returns no data on success, such as `Delete`, the response is 247 # `google.protobuf.Empty`. If the original method is standard 248 # `Get`/`Create`/`Update`, the response should be the resource. For other 249 # methods, the response should have the type `XxxResponse`, where `Xxx` 250 # is the original method name. For example, if the original method name 251 # is `TakeSnapshot()`, the inferred response type is 252 # `TakeSnapshotResponse`. 253 "a_key": "", # Properties of the object. Contains field @type with type URL. 254 }, 255 "name": "A String", # The server-assigned name, which is only unique within the same service that 256 # originally returns it. If you use the default HTTP mapping, the 257 # `name` should be a resource name ending with `operations/{unique_id}`. 258 "metadata": { # Service-specific metadata associated with the operation. It typically 259 # contains progress information and common metadata such as create time. 260 # Some services might not provide such metadata. Any method that returns a 261 # long-running operation should document the metadata type, if any. 262 "a_key": "", # Properties of the object. Contains field @type with type URL. 263 }, 264 }</pre> 265</div> 266 267<div class="method"> 268 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 269 <pre>Deletes a node. 270 271Args: 272 name: string, The resource name. (required) 273 x__xgafv: string, V1 error format. 274 Allowed values 275 1 - v1 error format 276 2 - v2 error format 277 278Returns: 279 An object of the form: 280 281 { # This resource represents a long-running operation that is the result of a 282 # network API call. 283 "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. 284 # different programming environments, including REST APIs and RPC APIs. It is 285 # used by [gRPC](https://github.com/grpc). The error model is designed to be: 286 # 287 # - Simple to use and understand for most users 288 # - Flexible enough to meet unexpected needs 289 # 290 # # Overview 291 # 292 # The `Status` message contains three pieces of data: error code, error 293 # message, and error details. The error code should be an enum value of 294 # google.rpc.Code, but it may accept additional error codes if needed. The 295 # error message should be a developer-facing English message that helps 296 # developers *understand* and *resolve* the error. If a localized user-facing 297 # error message is needed, put the localized message in the error details or 298 # localize it in the client. The optional error details may contain arbitrary 299 # information about the error. There is a predefined set of error detail types 300 # in the package `google.rpc` that can be used for common error conditions. 301 # 302 # # Language mapping 303 # 304 # The `Status` message is the logical representation of the error model, but it 305 # is not necessarily the actual wire format. When the `Status` message is 306 # exposed in different client libraries and different wire protocols, it can be 307 # mapped differently. For example, it will likely be mapped to some exceptions 308 # in Java, but more likely mapped to some error codes in C. 309 # 310 # # Other uses 311 # 312 # The error model and the `Status` message can be used in a variety of 313 # environments, either with or without APIs, to provide a 314 # consistent developer experience across different environments. 315 # 316 # Example uses of this error model include: 317 # 318 # - Partial errors. If a service needs to return partial errors to the client, 319 # it may embed the `Status` in the normal response to indicate the partial 320 # errors. 321 # 322 # - Workflow errors. A typical workflow has multiple steps. Each step may 323 # have a `Status` message for error reporting. 324 # 325 # - Batch operations. If a client uses batch request and batch response, the 326 # `Status` message should be used directly inside batch response, one for 327 # each error sub-response. 328 # 329 # - Asynchronous operations. If an API call embeds asynchronous operation 330 # results in its response, the status of those operations should be 331 # represented directly using the `Status` message. 332 # 333 # - Logging. If some API errors are stored in logs, the message `Status` could 334 # be used directly after any stripping needed for security/privacy reasons. 335 "message": "A String", # A developer-facing error message, which should be in English. Any 336 # user-facing error message should be localized and sent in the 337 # google.rpc.Status.details field, or localized by the client. 338 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 339 "details": [ # A list of messages that carry the error details. There is a common set of 340 # message types for APIs to use. 341 { 342 "a_key": "", # Properties of the object. Contains field @type with type URL. 343 }, 344 ], 345 }, 346 "done": True or False, # If the value is `false`, it means the operation is still in progress. 347 # If `true`, the operation is completed, and either `error` or `response` is 348 # available. 349 "response": { # The normal response of the operation in case of success. If the original 350 # method returns no data on success, such as `Delete`, the response is 351 # `google.protobuf.Empty`. If the original method is standard 352 # `Get`/`Create`/`Update`, the response should be the resource. For other 353 # methods, the response should have the type `XxxResponse`, where `Xxx` 354 # is the original method name. For example, if the original method name 355 # is `TakeSnapshot()`, the inferred response type is 356 # `TakeSnapshotResponse`. 357 "a_key": "", # Properties of the object. Contains field @type with type URL. 358 }, 359 "name": "A String", # The server-assigned name, which is only unique within the same service that 360 # originally returns it. If you use the default HTTP mapping, the 361 # `name` should be a resource name ending with `operations/{unique_id}`. 362 "metadata": { # Service-specific metadata associated with the operation. It typically 363 # contains progress information and common metadata such as create time. 364 # Some services might not provide such metadata. Any method that returns a 365 # long-running operation should document the metadata type, if any. 366 "a_key": "", # Properties of the object. Contains field @type with type URL. 367 }, 368 }</pre> 369</div> 370 371<div class="method"> 372 <code class="details" id="get">get(name, x__xgafv=None)</code> 373 <pre>Gets the details of a node. 374 375Args: 376 name: string, The resource name. (required) 377 x__xgafv: string, V1 error format. 378 Allowed values 379 1 - v1 error format 380 2 - v2 error format 381 382Returns: 383 An object of the form: 384 385 { # A TPU instance. 386 "schedulingConfig": { 387 "preemptible": True or False, 388 "reserved": True or False, # Whether the node is created under a reservation. 389 }, 390 "cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address. 391 # This CIDR block must be a /29 block; the Compute Engine networks API 392 # forbids a smaller block, and using a larger block would be wasteful (a 393 # node can only consume one IP address). Errors will occur if the CIDR block 394 # has already been used for a currently existing TPU node, the CIDR block 395 # conflicts with any subnetworks in the user's provided network, or the 396 # provided network is peered with another network that is using that CIDR 397 # block. 398 # Required. 399 "description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters. 400 "healthDescription": "A String", # Output only. 401 # If this field is populated, it contains a description of why the TPU Node 402 # is unhealthy. 403 "labels": { # Resource labels to represent user-provided metadata. 404 "a_key": "A String", 405 }, 406 "serviceAccount": "A String", # Output only. 407 # The service account used to run the tensor flow services within the node. 408 # To share resources, including Google Cloud Storage data, with the 409 # Tensorflow job running in the Node, this account must have permissions to 410 # that data. 411 "createTime": "A String", # Output only. 412 # The time when the node was created. 413 "tensorflowVersion": "A String", # The version of Tensorflow running in the Node. 414 # Required. 415 "network": "A String", # The name of a network they wish to peer the TPU node to. It must be a 416 # preexisting Compute Engine network inside of the project on which this API 417 # has been activated. If none is provided, "default" will be used. 418 "state": "A String", # Output only. 419 # The current state for the TPU Node. 420 "health": "A String", # The health status of the TPU node. 421 "networkEndpoints": [ # Output only. The network endpoints where TPU workers can be accessed and 422 # sent work. It is recommended that Tensorflow clients of the node reach out 423 # to the 0th entry in this map first. 424 { # A network endpoint over which a TPU worker can be reached. 425 "ipAddress": "A String", # The IP address of this network endpoint. 426 "port": 42, # The port of this network endpoint. 427 }, 428 ], 429 "acceleratorType": "A String", # The type of hardware accelerators associated with this node. 430 # Required. 431 "ipAddress": "A String", # Output only. 432 # DEPRECATED! Use network_endpoints instead. 433 # The network address for the TPU Node as visible to Compute Engine 434 # instances. 435 "port": "A String", # Output only. 436 # DEPRECATED! Use network_endpoints instead. 437 # The network port for the TPU Node as visible to Compute Engine instances. 438 "name": "A String", # Output only. 439 # The immutable name of the TPU 440 }</pre> 441</div> 442 443<div class="method"> 444 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 445 <pre>Lists nodes. 446 447Args: 448 parent: string, The parent resource name. (required) 449 pageSize: integer, The maximum number of items to return. 450 pageToken: string, The next_page_token value returned from a previous List request, if any. 451 x__xgafv: string, V1 error format. 452 Allowed values 453 1 - v1 error format 454 2 - v2 error format 455 456Returns: 457 An object of the form: 458 459 { # Response for ListNodes. 460 "nextPageToken": "A String", # The next page token or empty if none. 461 "unreachable": [ # Locations that could not be reached. 462 "A String", 463 ], 464 "nodes": [ # The listed nodes. 465 { # A TPU instance. 466 "schedulingConfig": { 467 "preemptible": True or False, 468 "reserved": True or False, # Whether the node is created under a reservation. 469 }, 470 "cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address. 471 # This CIDR block must be a /29 block; the Compute Engine networks API 472 # forbids a smaller block, and using a larger block would be wasteful (a 473 # node can only consume one IP address). Errors will occur if the CIDR block 474 # has already been used for a currently existing TPU node, the CIDR block 475 # conflicts with any subnetworks in the user's provided network, or the 476 # provided network is peered with another network that is using that CIDR 477 # block. 478 # Required. 479 "description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters. 480 "healthDescription": "A String", # Output only. 481 # If this field is populated, it contains a description of why the TPU Node 482 # is unhealthy. 483 "labels": { # Resource labels to represent user-provided metadata. 484 "a_key": "A String", 485 }, 486 "serviceAccount": "A String", # Output only. 487 # The service account used to run the tensor flow services within the node. 488 # To share resources, including Google Cloud Storage data, with the 489 # Tensorflow job running in the Node, this account must have permissions to 490 # that data. 491 "createTime": "A String", # Output only. 492 # The time when the node was created. 493 "tensorflowVersion": "A String", # The version of Tensorflow running in the Node. 494 # Required. 495 "network": "A String", # The name of a network they wish to peer the TPU node to. It must be a 496 # preexisting Compute Engine network inside of the project on which this API 497 # has been activated. If none is provided, "default" will be used. 498 "state": "A String", # Output only. 499 # The current state for the TPU Node. 500 "health": "A String", # The health status of the TPU node. 501 "networkEndpoints": [ # Output only. The network endpoints where TPU workers can be accessed and 502 # sent work. It is recommended that Tensorflow clients of the node reach out 503 # to the 0th entry in this map first. 504 { # A network endpoint over which a TPU worker can be reached. 505 "ipAddress": "A String", # The IP address of this network endpoint. 506 "port": 42, # The port of this network endpoint. 507 }, 508 ], 509 "acceleratorType": "A String", # The type of hardware accelerators associated with this node. 510 # Required. 511 "ipAddress": "A String", # Output only. 512 # DEPRECATED! Use network_endpoints instead. 513 # The network address for the TPU Node as visible to Compute Engine 514 # instances. 515 "port": "A String", # Output only. 516 # DEPRECATED! Use network_endpoints instead. 517 # The network port for the TPU Node as visible to Compute Engine instances. 518 "name": "A String", # Output only. 519 # The immutable name of the TPU 520 }, 521 ], 522 }</pre> 523</div> 524 525<div class="method"> 526 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 527 <pre>Retrieves the next page of results. 528 529Args: 530 previous_request: The request for the previous page. (required) 531 previous_response: The response from the request for the previous page. (required) 532 533Returns: 534 A request object that you can call 'execute()' on to request the next 535 page. Returns None if there are no more items in the collection. 536 </pre> 537</div> 538 539<div class="method"> 540 <code class="details" id="reimage">reimage(name, body, x__xgafv=None)</code> 541 <pre>Reimages a node's OS. 542 543Args: 544 name: string, The resource name. (required) 545 body: object, The request body. (required) 546 The object takes the form of: 547 548{ # Request for ReimageNode. 549 "tensorflowVersion": "A String", # The version for reimage to create. 550 } 551 552 x__xgafv: string, V1 error format. 553 Allowed values 554 1 - v1 error format 555 2 - v2 error format 556 557Returns: 558 An object of the form: 559 560 { # This resource represents a long-running operation that is the result of a 561 # network API call. 562 "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. 563 # different programming environments, including REST APIs and RPC APIs. It is 564 # used by [gRPC](https://github.com/grpc). The error model is designed to be: 565 # 566 # - Simple to use and understand for most users 567 # - Flexible enough to meet unexpected needs 568 # 569 # # Overview 570 # 571 # The `Status` message contains three pieces of data: error code, error 572 # message, and error details. The error code should be an enum value of 573 # google.rpc.Code, but it may accept additional error codes if needed. The 574 # error message should be a developer-facing English message that helps 575 # developers *understand* and *resolve* the error. If a localized user-facing 576 # error message is needed, put the localized message in the error details or 577 # localize it in the client. The optional error details may contain arbitrary 578 # information about the error. There is a predefined set of error detail types 579 # in the package `google.rpc` that can be used for common error conditions. 580 # 581 # # Language mapping 582 # 583 # The `Status` message is the logical representation of the error model, but it 584 # is not necessarily the actual wire format. When the `Status` message is 585 # exposed in different client libraries and different wire protocols, it can be 586 # mapped differently. For example, it will likely be mapped to some exceptions 587 # in Java, but more likely mapped to some error codes in C. 588 # 589 # # Other uses 590 # 591 # The error model and the `Status` message can be used in a variety of 592 # environments, either with or without APIs, to provide a 593 # consistent developer experience across different environments. 594 # 595 # Example uses of this error model include: 596 # 597 # - Partial errors. If a service needs to return partial errors to the client, 598 # it may embed the `Status` in the normal response to indicate the partial 599 # errors. 600 # 601 # - Workflow errors. A typical workflow has multiple steps. Each step may 602 # have a `Status` message for error reporting. 603 # 604 # - Batch operations. If a client uses batch request and batch response, the 605 # `Status` message should be used directly inside batch response, one for 606 # each error sub-response. 607 # 608 # - Asynchronous operations. If an API call embeds asynchronous operation 609 # results in its response, the status of those operations should be 610 # represented directly using the `Status` message. 611 # 612 # - Logging. If some API errors are stored in logs, the message `Status` could 613 # be used directly after any stripping needed for security/privacy reasons. 614 "message": "A String", # A developer-facing error message, which should be in English. Any 615 # user-facing error message should be localized and sent in the 616 # google.rpc.Status.details field, or localized by the client. 617 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 618 "details": [ # A list of messages that carry the error details. There is a common set of 619 # message types for APIs to use. 620 { 621 "a_key": "", # Properties of the object. Contains field @type with type URL. 622 }, 623 ], 624 }, 625 "done": True or False, # If the value is `false`, it means the operation is still in progress. 626 # If `true`, the operation is completed, and either `error` or `response` is 627 # available. 628 "response": { # The normal response of the operation in case of success. If the original 629 # method returns no data on success, such as `Delete`, the response is 630 # `google.protobuf.Empty`. If the original method is standard 631 # `Get`/`Create`/`Update`, the response should be the resource. For other 632 # methods, the response should have the type `XxxResponse`, where `Xxx` 633 # is the original method name. For example, if the original method name 634 # is `TakeSnapshot()`, the inferred response type is 635 # `TakeSnapshotResponse`. 636 "a_key": "", # Properties of the object. Contains field @type with type URL. 637 }, 638 "name": "A String", # The server-assigned name, which is only unique within the same service that 639 # originally returns it. If you use the default HTTP mapping, the 640 # `name` should be a resource name ending with `operations/{unique_id}`. 641 "metadata": { # Service-specific metadata associated with the operation. It typically 642 # contains progress information and common metadata such as create time. 643 # Some services might not provide such metadata. Any method that returns a 644 # long-running operation should document the metadata type, if any. 645 "a_key": "", # Properties of the object. Contains field @type with type URL. 646 }, 647 }</pre> 648</div> 649 650<div class="method"> 651 <code class="details" id="start">start(name, body=None, x__xgafv=None)</code> 652 <pre>Starts a node. 653 654Args: 655 name: string, The resource name. (required) 656 body: object, The request body. 657 The object takes the form of: 658 659{ # Request for StartNode. 660 } 661 662 x__xgafv: string, V1 error format. 663 Allowed values 664 1 - v1 error format 665 2 - v2 error format 666 667Returns: 668 An object of the form: 669 670 { # This resource represents a long-running operation that is the result of a 671 # network API call. 672 "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. 673 # different programming environments, including REST APIs and RPC APIs. It is 674 # used by [gRPC](https://github.com/grpc). The error model is designed to be: 675 # 676 # - Simple to use and understand for most users 677 # - Flexible enough to meet unexpected needs 678 # 679 # # Overview 680 # 681 # The `Status` message contains three pieces of data: error code, error 682 # message, and error details. The error code should be an enum value of 683 # google.rpc.Code, but it may accept additional error codes if needed. The 684 # error message should be a developer-facing English message that helps 685 # developers *understand* and *resolve* the error. If a localized user-facing 686 # error message is needed, put the localized message in the error details or 687 # localize it in the client. The optional error details may contain arbitrary 688 # information about the error. There is a predefined set of error detail types 689 # in the package `google.rpc` that can be used for common error conditions. 690 # 691 # # Language mapping 692 # 693 # The `Status` message is the logical representation of the error model, but it 694 # is not necessarily the actual wire format. When the `Status` message is 695 # exposed in different client libraries and different wire protocols, it can be 696 # mapped differently. For example, it will likely be mapped to some exceptions 697 # in Java, but more likely mapped to some error codes in C. 698 # 699 # # Other uses 700 # 701 # The error model and the `Status` message can be used in a variety of 702 # environments, either with or without APIs, to provide a 703 # consistent developer experience across different environments. 704 # 705 # Example uses of this error model include: 706 # 707 # - Partial errors. If a service needs to return partial errors to the client, 708 # it may embed the `Status` in the normal response to indicate the partial 709 # errors. 710 # 711 # - Workflow errors. A typical workflow has multiple steps. Each step may 712 # have a `Status` message for error reporting. 713 # 714 # - Batch operations. If a client uses batch request and batch response, the 715 # `Status` message should be used directly inside batch response, one for 716 # each error sub-response. 717 # 718 # - Asynchronous operations. If an API call embeds asynchronous operation 719 # results in its response, the status of those operations should be 720 # represented directly using the `Status` message. 721 # 722 # - Logging. If some API errors are stored in logs, the message `Status` could 723 # be used directly after any stripping needed for security/privacy reasons. 724 "message": "A String", # A developer-facing error message, which should be in English. Any 725 # user-facing error message should be localized and sent in the 726 # google.rpc.Status.details field, or localized by the client. 727 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 728 "details": [ # A list of messages that carry the error details. There is a common set of 729 # message types for APIs to use. 730 { 731 "a_key": "", # Properties of the object. Contains field @type with type URL. 732 }, 733 ], 734 }, 735 "done": True or False, # If the value is `false`, it means the operation is still in progress. 736 # If `true`, the operation is completed, and either `error` or `response` is 737 # available. 738 "response": { # The normal response of the operation in case of success. If the original 739 # method returns no data on success, such as `Delete`, the response is 740 # `google.protobuf.Empty`. If the original method is standard 741 # `Get`/`Create`/`Update`, the response should be the resource. For other 742 # methods, the response should have the type `XxxResponse`, where `Xxx` 743 # is the original method name. For example, if the original method name 744 # is `TakeSnapshot()`, the inferred response type is 745 # `TakeSnapshotResponse`. 746 "a_key": "", # Properties of the object. Contains field @type with type URL. 747 }, 748 "name": "A String", # The server-assigned name, which is only unique within the same service that 749 # originally returns it. If you use the default HTTP mapping, the 750 # `name` should be a resource name ending with `operations/{unique_id}`. 751 "metadata": { # Service-specific metadata associated with the operation. It typically 752 # contains progress information and common metadata such as create time. 753 # Some services might not provide such metadata. Any method that returns a 754 # long-running operation should document the metadata type, if any. 755 "a_key": "", # Properties of the object. Contains field @type with type URL. 756 }, 757 }</pre> 758</div> 759 760<div class="method"> 761 <code class="details" id="stop">stop(name, body=None, x__xgafv=None)</code> 762 <pre>Stops a node. 763 764Args: 765 name: string, The resource name. (required) 766 body: object, The request body. 767 The object takes the form of: 768 769{ # Request for StopNode. 770 } 771 772 x__xgafv: string, V1 error format. 773 Allowed values 774 1 - v1 error format 775 2 - v2 error format 776 777Returns: 778 An object of the form: 779 780 { # This resource represents a long-running operation that is the result of a 781 # network API call. 782 "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. 783 # different programming environments, including REST APIs and RPC APIs. It is 784 # used by [gRPC](https://github.com/grpc). The error model is designed to be: 785 # 786 # - Simple to use and understand for most users 787 # - Flexible enough to meet unexpected needs 788 # 789 # # Overview 790 # 791 # The `Status` message contains three pieces of data: error code, error 792 # message, and error details. The error code should be an enum value of 793 # google.rpc.Code, but it may accept additional error codes if needed. The 794 # error message should be a developer-facing English message that helps 795 # developers *understand* and *resolve* the error. If a localized user-facing 796 # error message is needed, put the localized message in the error details or 797 # localize it in the client. The optional error details may contain arbitrary 798 # information about the error. There is a predefined set of error detail types 799 # in the package `google.rpc` that can be used for common error conditions. 800 # 801 # # Language mapping 802 # 803 # The `Status` message is the logical representation of the error model, but it 804 # is not necessarily the actual wire format. When the `Status` message is 805 # exposed in different client libraries and different wire protocols, it can be 806 # mapped differently. For example, it will likely be mapped to some exceptions 807 # in Java, but more likely mapped to some error codes in C. 808 # 809 # # Other uses 810 # 811 # The error model and the `Status` message can be used in a variety of 812 # environments, either with or without APIs, to provide a 813 # consistent developer experience across different environments. 814 # 815 # Example uses of this error model include: 816 # 817 # - Partial errors. If a service needs to return partial errors to the client, 818 # it may embed the `Status` in the normal response to indicate the partial 819 # errors. 820 # 821 # - Workflow errors. A typical workflow has multiple steps. Each step may 822 # have a `Status` message for error reporting. 823 # 824 # - Batch operations. If a client uses batch request and batch response, the 825 # `Status` message should be used directly inside batch response, one for 826 # each error sub-response. 827 # 828 # - Asynchronous operations. If an API call embeds asynchronous operation 829 # results in its response, the status of those operations should be 830 # represented directly using the `Status` message. 831 # 832 # - Logging. If some API errors are stored in logs, the message `Status` could 833 # be used directly after any stripping needed for security/privacy reasons. 834 "message": "A String", # A developer-facing error message, which should be in English. Any 835 # user-facing error message should be localized and sent in the 836 # google.rpc.Status.details field, or localized by the client. 837 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 838 "details": [ # A list of messages that carry the error details. There is a common set of 839 # message types for APIs to use. 840 { 841 "a_key": "", # Properties of the object. Contains field @type with type URL. 842 }, 843 ], 844 }, 845 "done": True or False, # If the value is `false`, it means the operation is still in progress. 846 # If `true`, the operation is completed, and either `error` or `response` is 847 # available. 848 "response": { # The normal response of the operation in case of success. If the original 849 # method returns no data on success, such as `Delete`, the response is 850 # `google.protobuf.Empty`. If the original method is standard 851 # `Get`/`Create`/`Update`, the response should be the resource. For other 852 # methods, the response should have the type `XxxResponse`, where `Xxx` 853 # is the original method name. For example, if the original method name 854 # is `TakeSnapshot()`, the inferred response type is 855 # `TakeSnapshotResponse`. 856 "a_key": "", # Properties of the object. Contains field @type with type URL. 857 }, 858 "name": "A String", # The server-assigned name, which is only unique within the same service that 859 # originally returns it. If you use the default HTTP mapping, the 860 # `name` should be a resource name ending with `operations/{unique_id}`. 861 "metadata": { # Service-specific metadata associated with the operation. It typically 862 # contains progress information and common metadata such as create time. 863 # Some services might not provide such metadata. Any method that returns a 864 # long-running operation should document the metadata type, if any. 865 "a_key": "", # Properties of the object. Contains field @type with type URL. 866 }, 867 }</pre> 868</div> 869 870</body></html>