Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / tpu_v1alpha1.projects.locations.nodes.html
blob: 25aef5773154b338932f3b9bf93ec794c5a48528 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#create">create(parent, body=None, nodeId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]93 <code><a href="#reimage">reimage(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]103 <code class="details" id="create">create(parent, body=None, nodeId=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]104 <pre>Creates a node.
105
106Args:
107 parent: string, The parent resource name. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]108 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]124 "description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]125 "healthDescription": "A String", # Output only. If this field is populated, it contains a description of why the TPU Node
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]126 # is unhealthy.
127 "labels": { # Resource labels to represent user-provided metadata.
128 "a_key": "A String",
129 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]130 "serviceAccount": "A String", # Output only. The service account used to run the tensor flow services within the node.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]131 # To share resources, including Google Cloud Storage data, with the
132 # Tensorflow job running in the Node, this account must have permissions to
133 # that data.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]134 "createTime": "A String", # Output only. The time when the node was created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]135 "tensorflowVersion": "A String", # The version of Tensorflow running in the Node.
136 # Required.
137 "network": "A String", # The name of a network they wish to peer the TPU node to. It must be a
138 # preexisting Compute Engine network inside of the project on which this API
139 # has been activated. If none is provided, "default" will be used.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]140 "state": "A String", # Output only. The current state for the TPU Node.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]141 "health": "A String", # The health status of the TPU node.
142 "networkEndpoints": [ # Output only. The network endpoints where TPU workers can be accessed and
143 # sent work. It is recommended that Tensorflow clients of the node reach out
144 # to the 0th entry in this map first.
145 { # A network endpoint over which a TPU worker can be reached.
146 "ipAddress": "A String", # The IP address of this network endpoint.
147 "port": 42, # The port of this network endpoint.
148 },
149 ],
150 "acceleratorType": "A String", # The type of hardware accelerators associated with this node.
151 # Required.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]152 "ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]153 # The network address for the TPU Node as visible to Compute Engine
154 # instances.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]155 "port": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]156 # The network port for the TPU Node as visible to Compute Engine instances.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]157 "name": "A String", # Output only. The immutable name of the TPU
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]158}
159
160 nodeId: string, The unqualified resource name.
161 x__xgafv: string, V1 error format.
162 Allowed values
163 1 - v1 error format
164 2 - v2 error format
165
166Returns:
167 An object of the form:
168
169 { # This resource represents a long-running operation that is the result of a
170 # network API call.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]171 "metadata": { # Service-specific metadata associated with the operation. It typically
172 # contains progress information and common metadata such as create time.
173 # Some services might not provide such metadata. Any method that returns a
174 # long-running operation should document the metadata type, if any.
175 "a_key": "", # Properties of the object. Contains field @type with type URL.
176 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]177 "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.
178 # different programming environments, including REST APIs and RPC APIs. It is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]179 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
180 # three pieces of data: error code, error message, and error details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]181 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]182 # You can find out more about this error model and how to work with it in the
183 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]184 "message": "A String", # A developer-facing error message, which should be in English. Any
185 # user-facing error message should be localized and sent in the
186 # google.rpc.Status.details field, or localized by the client.
187 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
188 "details": [ # A list of messages that carry the error details. There is a common set of
189 # message types for APIs to use.
190 {
191 "a_key": "", # Properties of the object. Contains field @type with type URL.
192 },
193 ],
194 },
195 "done": True or False, # If the value is `false`, it means the operation is still in progress.
196 # If `true`, the operation is completed, and either `error` or `response` is
197 # available.
198 "response": { # The normal response of the operation in case of success. If the original
199 # method returns no data on success, such as `Delete`, the response is
200 # `google.protobuf.Empty`. If the original method is standard
201 # `Get`/`Create`/`Update`, the response should be the resource. For other
202 # methods, the response should have the type `XxxResponse`, where `Xxx`
203 # is the original method name. For example, if the original method name
204 # is `TakeSnapshot()`, the inferred response type is
205 # `TakeSnapshotResponse`.
206 "a_key": "", # Properties of the object. Contains field @type with type URL.
207 },
208 "name": "A String", # The server-assigned name, which is only unique within the same service that
209 # originally returns it. If you use the default HTTP mapping, the
210 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]211 }</pre>
212</div>
213
214<div class="method">
215 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
216 <pre>Deletes a node.
217
218Args:
219 name: string, The resource name. (required)
220 x__xgafv: string, V1 error format.
221 Allowed values
222 1 - v1 error format
223 2 - v2 error format
224
225Returns:
226 An object of the form:
227
228 { # This resource represents a long-running operation that is the result of a
229 # network API call.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]230 "metadata": { # Service-specific metadata associated with the operation. It typically
231 # contains progress information and common metadata such as create time.
232 # Some services might not provide such metadata. Any method that returns a
233 # long-running operation should document the metadata type, if any.
234 "a_key": "", # Properties of the object. Contains field @type with type URL.
235 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]236 "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.
237 # different programming environments, including REST APIs and RPC APIs. It is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]238 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
239 # three pieces of data: error code, error message, and error details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]240 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]241 # You can find out more about this error model and how to work with it in the
242 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]243 "message": "A String", # A developer-facing error message, which should be in English. Any
244 # user-facing error message should be localized and sent in the
245 # google.rpc.Status.details field, or localized by the client.
246 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
247 "details": [ # A list of messages that carry the error details. There is a common set of
248 # message types for APIs to use.
249 {
250 "a_key": "", # Properties of the object. Contains field @type with type URL.
251 },
252 ],
253 },
254 "done": True or False, # If the value is `false`, it means the operation is still in progress.
255 # If `true`, the operation is completed, and either `error` or `response` is
256 # available.
257 "response": { # The normal response of the operation in case of success. If the original
258 # method returns no data on success, such as `Delete`, the response is
259 # `google.protobuf.Empty`. If the original method is standard
260 # `Get`/`Create`/`Update`, the response should be the resource. For other
261 # methods, the response should have the type `XxxResponse`, where `Xxx`
262 # is the original method name. For example, if the original method name
263 # is `TakeSnapshot()`, the inferred response type is
264 # `TakeSnapshotResponse`.
265 "a_key": "", # Properties of the object. Contains field @type with type URL.
266 },
267 "name": "A String", # The server-assigned name, which is only unique within the same service that
268 # originally returns it. If you use the default HTTP mapping, the
269 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]270 }</pre>
271</div>
272
273<div class="method">
274 <code class="details" id="get">get(name, x__xgafv=None)</code>
275 <pre>Gets the details of a node.
276
277Args:
278 name: string, The resource name. (required)
279 x__xgafv: string, V1 error format.
280 Allowed values
281 1 - v1 error format
282 2 - v2 error format
283
284Returns:
285 An object of the form:
286
287 { # A TPU instance.
288 "schedulingConfig": {
289 "preemptible": True or False,
290 "reserved": True or False, # Whether the node is created under a reservation.
291 },
292 "cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address.
293 # This CIDR block must be a /29 block; the Compute Engine networks API
294 # forbids a smaller block, and using a larger block would be wasteful (a
295 # node can only consume one IP address). Errors will occur if the CIDR block
296 # has already been used for a currently existing TPU node, the CIDR block
297 # conflicts with any subnetworks in the user's provided network, or the
298 # provided network is peered with another network that is using that CIDR
299 # block.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]300 "description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]301 "healthDescription": "A String", # Output only. If this field is populated, it contains a description of why the TPU Node
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]302 # is unhealthy.
303 "labels": { # Resource labels to represent user-provided metadata.
304 "a_key": "A String",
305 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]306 "serviceAccount": "A String", # Output only. The service account used to run the tensor flow services within the node.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]307 # To share resources, including Google Cloud Storage data, with the
308 # Tensorflow job running in the Node, this account must have permissions to
309 # that data.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]310 "createTime": "A String", # Output only. The time when the node was created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]311 "tensorflowVersion": "A String", # The version of Tensorflow running in the Node.
312 # Required.
313 "network": "A String", # The name of a network they wish to peer the TPU node to. It must be a
314 # preexisting Compute Engine network inside of the project on which this API
315 # has been activated. If none is provided, "default" will be used.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]316 "state": "A String", # Output only. The current state for the TPU Node.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]317 "health": "A String", # The health status of the TPU node.
318 "networkEndpoints": [ # Output only. The network endpoints where TPU workers can be accessed and
319 # sent work. It is recommended that Tensorflow clients of the node reach out
320 # to the 0th entry in this map first.
321 { # A network endpoint over which a TPU worker can be reached.
322 "ipAddress": "A String", # The IP address of this network endpoint.
323 "port": 42, # The port of this network endpoint.
324 },
325 ],
326 "acceleratorType": "A String", # The type of hardware accelerators associated with this node.
327 # Required.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]328 "ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]329 # The network address for the TPU Node as visible to Compute Engine
330 # instances.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]331 "port": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]332 # The network port for the TPU Node as visible to Compute Engine instances.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]333 "name": "A String", # Output only. The immutable name of the TPU
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]334 }</pre>
335</div>
336
337<div class="method">
338 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
339 <pre>Lists nodes.
340
341Args:
342 parent: string, The parent resource name. (required)
343 pageSize: integer, The maximum number of items to return.
344 pageToken: string, The next_page_token value returned from a previous List request, if any.
345 x__xgafv: string, V1 error format.
346 Allowed values
347 1 - v1 error format
348 2 - v2 error format
349
350Returns:
351 An object of the form:
352
353 { # Response for ListNodes.
354 "nextPageToken": "A String", # The next page token or empty if none.
355 "unreachable": [ # Locations that could not be reached.
356 "A String",
357 ],
358 "nodes": [ # The listed nodes.
359 { # A TPU instance.
360 "schedulingConfig": {
361 "preemptible": True or False,
362 "reserved": True or False, # Whether the node is created under a reservation.
363 },
364 "cidrBlock": "A String", # The CIDR block that the TPU node will use when selecting an IP address.
365 # This CIDR block must be a /29 block; the Compute Engine networks API
366 # forbids a smaller block, and using a larger block would be wasteful (a
367 # node can only consume one IP address). Errors will occur if the CIDR block
368 # has already been used for a currently existing TPU node, the CIDR block
369 # conflicts with any subnetworks in the user's provided network, or the
370 # provided network is peered with another network that is using that CIDR
371 # block.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]372 "description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]373 "healthDescription": "A String", # Output only. If this field is populated, it contains a description of why the TPU Node
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]374 # is unhealthy.
375 "labels": { # Resource labels to represent user-provided metadata.
376 "a_key": "A String",
377 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]378 "serviceAccount": "A String", # Output only. The service account used to run the tensor flow services within the node.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]379 # To share resources, including Google Cloud Storage data, with the
380 # Tensorflow job running in the Node, this account must have permissions to
381 # that data.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]382 "createTime": "A String", # Output only. The time when the node was created.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]383 "tensorflowVersion": "A String", # The version of Tensorflow running in the Node.
384 # Required.
385 "network": "A String", # The name of a network they wish to peer the TPU node to. It must be a
386 # preexisting Compute Engine network inside of the project on which this API
387 # has been activated. If none is provided, "default" will be used.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]388 "state": "A String", # Output only. The current state for the TPU Node.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]389 "health": "A String", # The health status of the TPU node.
390 "networkEndpoints": [ # Output only. The network endpoints where TPU workers can be accessed and
391 # sent work. It is recommended that Tensorflow clients of the node reach out
392 # to the 0th entry in this map first.
393 { # A network endpoint over which a TPU worker can be reached.
394 "ipAddress": "A String", # The IP address of this network endpoint.
395 "port": 42, # The port of this network endpoint.
396 },
397 ],
398 "acceleratorType": "A String", # The type of hardware accelerators associated with this node.
399 # Required.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]400 "ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]401 # The network address for the TPU Node as visible to Compute Engine
402 # instances.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]403 "port": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]404 # The network port for the TPU Node as visible to Compute Engine instances.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]405 "name": "A String", # Output only. The immutable name of the TPU
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]406 },
407 ],
408 }</pre>
409</div>
410
411<div class="method">
412 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
413 <pre>Retrieves the next page of results.
414
415Args:
416 previous_request: The request for the previous page. (required)
417 previous_response: The response from the request for the previous page. (required)
418
419Returns:
420 A request object that you can call 'execute()' on to request the next
421 page. Returns None if there are no more items in the collection.
422 </pre>
423</div>
424
425<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]426 <code class="details" id="reimage">reimage(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]427 <pre>Reimages a node's OS.
428
429Args:
430 name: string, The resource name. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]431 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]432 The object takes the form of:
433
434{ # Request for ReimageNode.
435 "tensorflowVersion": "A String", # The version for reimage to create.
436 }
437
438 x__xgafv: string, V1 error format.
439 Allowed values
440 1 - v1 error format
441 2 - v2 error format
442
443Returns:
444 An object of the form:
445
446 { # This resource represents a long-running operation that is the result of a
447 # network API call.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]448 "metadata": { # Service-specific metadata associated with the operation. It typically
449 # contains progress information and common metadata such as create time.
450 # Some services might not provide such metadata. Any method that returns a
451 # long-running operation should document the metadata type, if any.
452 "a_key": "", # Properties of the object. Contains field @type with type URL.
453 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]454 "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.
455 # different programming environments, including REST APIs and RPC APIs. It is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]456 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
457 # three pieces of data: error code, error message, and error details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]458 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]459 # You can find out more about this error model and how to work with it in the
460 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]461 "message": "A String", # A developer-facing error message, which should be in English. Any
462 # user-facing error message should be localized and sent in the
463 # google.rpc.Status.details field, or localized by the client.
464 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
465 "details": [ # A list of messages that carry the error details. There is a common set of
466 # message types for APIs to use.
467 {
468 "a_key": "", # Properties of the object. Contains field @type with type URL.
469 },
470 ],
471 },
472 "done": True or False, # If the value is `false`, it means the operation is still in progress.
473 # If `true`, the operation is completed, and either `error` or `response` is
474 # available.
475 "response": { # The normal response of the operation in case of success. If the original
476 # method returns no data on success, such as `Delete`, the response is
477 # `google.protobuf.Empty`. If the original method is standard
478 # `Get`/`Create`/`Update`, the response should be the resource. For other
479 # methods, the response should have the type `XxxResponse`, where `Xxx`
480 # is the original method name. For example, if the original method name
481 # is `TakeSnapshot()`, the inferred response type is
482 # `TakeSnapshotResponse`.
483 "a_key": "", # Properties of the object. Contains field @type with type URL.
484 },
485 "name": "A String", # The server-assigned name, which is only unique within the same service that
486 # originally returns it. If you use the default HTTP mapping, the
487 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]488 }</pre>
489</div>
490
491<div class="method">
492 <code class="details" id="start">start(name, body=None, x__xgafv=None)</code>
493 <pre>Starts a node.
494
495Args:
496 name: string, The resource name. (required)
497 body: object, The request body.
498 The object takes the form of:
499
500{ # Request for StartNode.
501 }
502
503 x__xgafv: string, V1 error format.
504 Allowed values
505 1 - v1 error format
506 2 - v2 error format
507
508Returns:
509 An object of the form:
510
511 { # This resource represents a long-running operation that is the result of a
512 # network API call.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]513 "metadata": { # Service-specific metadata associated with the operation. It typically
514 # contains progress information and common metadata such as create time.
515 # Some services might not provide such metadata. Any method that returns a
516 # long-running operation should document the metadata type, if any.
517 "a_key": "", # Properties of the object. Contains field @type with type URL.
518 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]519 "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.
520 # different programming environments, including REST APIs and RPC APIs. It is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]521 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
522 # three pieces of data: error code, error message, and error details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]523 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]524 # You can find out more about this error model and how to work with it in the
525 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]526 "message": "A String", # A developer-facing error message, which should be in English. Any
527 # user-facing error message should be localized and sent in the
528 # google.rpc.Status.details field, or localized by the client.
529 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
530 "details": [ # A list of messages that carry the error details. There is a common set of
531 # message types for APIs to use.
532 {
533 "a_key": "", # Properties of the object. Contains field @type with type URL.
534 },
535 ],
536 },
537 "done": True or False, # If the value is `false`, it means the operation is still in progress.
538 # If `true`, the operation is completed, and either `error` or `response` is
539 # available.
540 "response": { # The normal response of the operation in case of success. If the original
541 # method returns no data on success, such as `Delete`, the response is
542 # `google.protobuf.Empty`. If the original method is standard
543 # `Get`/`Create`/`Update`, the response should be the resource. For other
544 # methods, the response should have the type `XxxResponse`, where `Xxx`
545 # is the original method name. For example, if the original method name
546 # is `TakeSnapshot()`, the inferred response type is
547 # `TakeSnapshotResponse`.
548 "a_key": "", # Properties of the object. Contains field @type with type URL.
549 },
550 "name": "A String", # The server-assigned name, which is only unique within the same service that
551 # originally returns it. If you use the default HTTP mapping, the
552 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]553 }</pre>
554</div>
555
556<div class="method">
557 <code class="details" id="stop">stop(name, body=None, x__xgafv=None)</code>
558 <pre>Stops a node.
559
560Args:
561 name: string, The resource name. (required)
562 body: object, The request body.
563 The object takes the form of:
564
565{ # Request for StopNode.
566 }
567
568 x__xgafv: string, V1 error format.
569 Allowed values
570 1 - v1 error format
571 2 - v2 error format
572
573Returns:
574 An object of the form:
575
576 { # This resource represents a long-running operation that is the result of a
577 # network API call.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]578 "metadata": { # Service-specific metadata associated with the operation. It typically
579 # contains progress information and common metadata such as create time.
580 # Some services might not provide such metadata. Any method that returns a
581 # long-running operation should document the metadata type, if any.
582 "a_key": "", # Properties of the object. Contains field @type with type URL.
583 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]584 "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.
585 # different programming environments, including REST APIs and RPC APIs. It is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]586 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
587 # three pieces of data: error code, error message, and error details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]588 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]589 # You can find out more about this error model and how to work with it in the
590 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]591 "message": "A String", # A developer-facing error message, which should be in English. Any
592 # user-facing error message should be localized and sent in the
593 # google.rpc.Status.details field, or localized by the client.
594 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
595 "details": [ # A list of messages that carry the error details. There is a common set of
596 # message types for APIs to use.
597 {
598 "a_key": "", # Properties of the object. Contains field @type with type URL.
599 },
600 ],
601 },
602 "done": True or False, # If the value is `false`, it means the operation is still in progress.
603 # If `true`, the operation is completed, and either `error` or `response` is
604 # available.
605 "response": { # The normal response of the operation in case of success. If the original
606 # method returns no data on success, such as `Delete`, the response is
607 # `google.protobuf.Empty`. If the original method is standard
608 # `Get`/`Create`/`Update`, the response should be the resource. For other
609 # methods, the response should have the type `XxxResponse`, where `Xxx`
610 # is the original method name. For example, if the original method name
611 # is `TakeSnapshot()`, the inferred response type is
612 # `TakeSnapshotResponse`.
613 "a_key": "", # Properties of the object. Contains field @type with type URL.
614 },
615 "name": "A String", # The server-assigned name, which is only unique within the same service that
616 # originally returns it. If you use the default HTTP mapping, the
617 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]618 }</pre>
619</div>
620
621</body></html>