Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / tpu_v1.projects.locations.nodes.html
blob: d269175c3288cd7729bc494c3f8e56f11aa744ff [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_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">
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, pageToken=None, x__xgafv=None, pageSize=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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]124 "network": "A String", # The name of a network they wish to peer the TPU node to. It must be a
125 # preexisting Compute Engine network inside of the project on which this API
126 # has been activated. If none is provided, "default" will be used.
127 "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]128 # is unhealthy.
129 "labels": { # Resource labels to represent user-provided metadata.
130 "a_key": "A String",
131 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]132 "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]133 # To share resources, including Google Cloud Storage data, with the
134 # Tensorflow job running in the Node, this account must have permissions to
135 # that data.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]136 "port": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
137 # The network port for the TPU Node as visible to Compute Engine instances.
138 "name": "A String", # Output only. The immutable name of the TPU
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]139 "tensorflowVersion": "A String", # The version of Tensorflow running in the Node.
140 # Required.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]141 "state": "A String", # Output only. The current state for the TPU Node.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]142 "health": "A String", # The health status of the TPU node.
143 "networkEndpoints": [ # Output only. The network endpoints where TPU workers can be accessed and
144 # sent work. It is recommended that Tensorflow clients of the node reach out
145 # to the 0th entry in this map first.
146 { # A network endpoint over which a TPU worker can be reached.
147 "ipAddress": "A String", # The IP address of this network endpoint.
148 "port": 42, # The port of this network endpoint.
149 },
150 ],
151 "acceleratorType": "A String", # The type of hardware accelerators associated with this node.
152 # Required.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]153 "ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]154 # The network address for the TPU Node as visible to Compute Engine
155 # instances.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]156 "createTime": "A String", # Output only. The time when the node was created.
157 "description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters.
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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]171 "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.
172 # different programming environments, including REST APIs and RPC APIs. It is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]173 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
174 # three pieces of data: error code, error message, and error details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]175 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]176 # You can find out more about this error model and how to work with it in the
177 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]178 "message": "A String", # A developer-facing error message, which should be in English. Any
179 # user-facing error message should be localized and sent in the
180 # google.rpc.Status.details field, or localized by the client.
181 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
182 "details": [ # A list of messages that carry the error details. There is a common set of
183 # message types for APIs to use.
184 {
185 "a_key": "", # Properties of the object. Contains field @type with type URL.
186 },
187 ],
188 },
189 "done": True or False, # If the value is `false`, it means the operation is still in progress.
190 # If `true`, the operation is completed, and either `error` or `response` is
191 # available.
192 "response": { # The normal response of the operation in case of success. If the original
193 # method returns no data on success, such as `Delete`, the response is
194 # `google.protobuf.Empty`. If the original method is standard
195 # `Get`/`Create`/`Update`, the response should be the resource. For other
196 # methods, the response should have the type `XxxResponse`, where `Xxx`
197 # is the original method name. For example, if the original method name
198 # is `TakeSnapshot()`, the inferred response type is
199 # `TakeSnapshotResponse`.
200 "a_key": "", # Properties of the object. Contains field @type with type URL.
201 },
202 "name": "A String", # The server-assigned name, which is only unique within the same service that
203 # originally returns it. If you use the default HTTP mapping, the
204 # `name` should be a resource name ending with `operations/{unique_id}`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]205 "metadata": { # Service-specific metadata associated with the operation. It typically
206 # contains progress information and common metadata such as create time.
207 # Some services might not provide such metadata. Any method that returns a
208 # long-running operation should document the metadata type, if any.
209 "a_key": "", # Properties of the object. Contains field @type with type URL.
210 },
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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]230 "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.
231 # different programming environments, including REST APIs and RPC APIs. It is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]232 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
233 # three pieces of data: error code, error message, and error details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]234 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]235 # You can find out more about this error model and how to work with it in the
236 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]237 "message": "A String", # A developer-facing error message, which should be in English. Any
238 # user-facing error message should be localized and sent in the
239 # google.rpc.Status.details field, or localized by the client.
240 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
241 "details": [ # A list of messages that carry the error details. There is a common set of
242 # message types for APIs to use.
243 {
244 "a_key": "", # Properties of the object. Contains field @type with type URL.
245 },
246 ],
247 },
248 "done": True or False, # If the value is `false`, it means the operation is still in progress.
249 # If `true`, the operation is completed, and either `error` or `response` is
250 # available.
251 "response": { # The normal response of the operation in case of success. If the original
252 # method returns no data on success, such as `Delete`, the response is
253 # `google.protobuf.Empty`. If the original method is standard
254 # `Get`/`Create`/`Update`, the response should be the resource. For other
255 # methods, the response should have the type `XxxResponse`, where `Xxx`
256 # is the original method name. For example, if the original method name
257 # is `TakeSnapshot()`, the inferred response type is
258 # `TakeSnapshotResponse`.
259 "a_key": "", # Properties of the object. Contains field @type with type URL.
260 },
261 "name": "A String", # The server-assigned name, which is only unique within the same service that
262 # originally returns it. If you use the default HTTP mapping, the
263 # `name` should be a resource name ending with `operations/{unique_id}`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]264 "metadata": { # Service-specific metadata associated with the operation. It typically
265 # contains progress information and common metadata such as create time.
266 # Some services might not provide such metadata. Any method that returns a
267 # long-running operation should document the metadata type, if any.
268 "a_key": "", # Properties of the object. Contains field @type with type URL.
269 },
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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]300 "network": "A String", # The name of a network they wish to peer the TPU node to. It must be a
301 # preexisting Compute Engine network inside of the project on which this API
302 # has been activated. If none is provided, "default" will be used.
303 "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]304 # is unhealthy.
305 "labels": { # Resource labels to represent user-provided metadata.
306 "a_key": "A String",
307 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]308 "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]309 # To share resources, including Google Cloud Storage data, with the
310 # Tensorflow job running in the Node, this account must have permissions to
311 # that data.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]312 "port": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
313 # The network port for the TPU Node as visible to Compute Engine instances.
314 "name": "A String", # Output only. The immutable name of the TPU
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]315 "tensorflowVersion": "A String", # The version of Tensorflow running in the Node.
316 # Required.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]317 "state": "A String", # Output only. The current state for the TPU Node.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]318 "health": "A String", # The health status of the TPU node.
319 "networkEndpoints": [ # Output only. The network endpoints where TPU workers can be accessed and
320 # sent work. It is recommended that Tensorflow clients of the node reach out
321 # to the 0th entry in this map first.
322 { # A network endpoint over which a TPU worker can be reached.
323 "ipAddress": "A String", # The IP address of this network endpoint.
324 "port": 42, # The port of this network endpoint.
325 },
326 ],
327 "acceleratorType": "A String", # The type of hardware accelerators associated with this node.
328 # Required.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]329 "ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]330 # The network address for the TPU Node as visible to Compute Engine
331 # instances.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]332 "createTime": "A String", # Output only. The time when the node was created.
333 "description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters.
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, pageToken=None, x__xgafv=None, pageSize=None)</code>
339 <pre>Lists nodes.
340
341Args:
342 parent: string, The parent resource name. (required)
343 pageToken: string, The next_page_token value returned from a previous List request, if any.
344 x__xgafv: string, V1 error format.
345 Allowed values
346 1 - v1 error format
347 2 - v2 error format
348 pageSize: integer, The maximum number of items to return.
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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]372 "network": "A String", # The name of a network they wish to peer the TPU node to. It must be a
373 # preexisting Compute Engine network inside of the project on which this API
374 # has been activated. If none is provided, "default" will be used.
375 "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]376 # is unhealthy.
377 "labels": { # Resource labels to represent user-provided metadata.
378 "a_key": "A String",
379 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]380 "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]381 # To share resources, including Google Cloud Storage data, with the
382 # Tensorflow job running in the Node, this account must have permissions to
383 # that data.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]384 "port": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
385 # The network port for the TPU Node as visible to Compute Engine instances.
386 "name": "A String", # Output only. The immutable name of the TPU
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]387 "tensorflowVersion": "A String", # The version of Tensorflow running in the Node.
388 # Required.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]389 "state": "A String", # Output only. The current state for the TPU Node.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]390 "health": "A String", # The health status of the TPU node.
391 "networkEndpoints": [ # Output only. The network endpoints where TPU workers can be accessed and
392 # sent work. It is recommended that Tensorflow clients of the node reach out
393 # to the 0th entry in this map first.
394 { # A network endpoint over which a TPU worker can be reached.
395 "ipAddress": "A String", # The IP address of this network endpoint.
396 "port": 42, # The port of this network endpoint.
397 },
398 ],
399 "acceleratorType": "A String", # The type of hardware accelerators associated with this node.
400 # Required.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]401 "ipAddress": "A String", # Output only. DEPRECATED! Use network_endpoints instead.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]402 # The network address for the TPU Node as visible to Compute Engine
403 # instances.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]404 "createTime": "A String", # Output only. The time when the node was created.
405 "description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters.
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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]448 "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.
449 # different programming environments, including REST APIs and RPC APIs. It is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]450 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
451 # three pieces of data: error code, error message, and error details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]452 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]453 # You can find out more about this error model and how to work with it in the
454 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]455 "message": "A String", # A developer-facing error message, which should be in English. Any
456 # user-facing error message should be localized and sent in the
457 # google.rpc.Status.details field, or localized by the client.
458 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
459 "details": [ # A list of messages that carry the error details. There is a common set of
460 # message types for APIs to use.
461 {
462 "a_key": "", # Properties of the object. Contains field @type with type URL.
463 },
464 ],
465 },
466 "done": True or False, # If the value is `false`, it means the operation is still in progress.
467 # If `true`, the operation is completed, and either `error` or `response` is
468 # available.
469 "response": { # The normal response of the operation in case of success. If the original
470 # method returns no data on success, such as `Delete`, the response is
471 # `google.protobuf.Empty`. If the original method is standard
472 # `Get`/`Create`/`Update`, the response should be the resource. For other
473 # methods, the response should have the type `XxxResponse`, where `Xxx`
474 # is the original method name. For example, if the original method name
475 # is `TakeSnapshot()`, the inferred response type is
476 # `TakeSnapshotResponse`.
477 "a_key": "", # Properties of the object. Contains field @type with type URL.
478 },
479 "name": "A String", # The server-assigned name, which is only unique within the same service that
480 # originally returns it. If you use the default HTTP mapping, the
481 # `name` should be a resource name ending with `operations/{unique_id}`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]482 "metadata": { # Service-specific metadata associated with the operation. It typically
483 # contains progress information and common metadata such as create time.
484 # Some services might not provide such metadata. Any method that returns a
485 # long-running operation should document the metadata type, if any.
486 "a_key": "", # Properties of the object. Contains field @type with type URL.
487 },
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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]513 "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.
514 # different programming environments, including REST APIs and RPC APIs. It is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]515 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
516 # three pieces of data: error code, error message, and error details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]517 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]518 # You can find out more about this error model and how to work with it in the
519 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]520 "message": "A String", # A developer-facing error message, which should be in English. Any
521 # user-facing error message should be localized and sent in the
522 # google.rpc.Status.details field, or localized by the client.
523 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
524 "details": [ # A list of messages that carry the error details. There is a common set of
525 # message types for APIs to use.
526 {
527 "a_key": "", # Properties of the object. Contains field @type with type URL.
528 },
529 ],
530 },
531 "done": True or False, # If the value is `false`, it means the operation is still in progress.
532 # If `true`, the operation is completed, and either `error` or `response` is
533 # available.
534 "response": { # The normal response of the operation in case of success. If the original
535 # method returns no data on success, such as `Delete`, the response is
536 # `google.protobuf.Empty`. If the original method is standard
537 # `Get`/`Create`/`Update`, the response should be the resource. For other
538 # methods, the response should have the type `XxxResponse`, where `Xxx`
539 # is the original method name. For example, if the original method name
540 # is `TakeSnapshot()`, the inferred response type is
541 # `TakeSnapshotResponse`.
542 "a_key": "", # Properties of the object. Contains field @type with type URL.
543 },
544 "name": "A String", # The server-assigned name, which is only unique within the same service that
545 # originally returns it. If you use the default HTTP mapping, the
546 # `name` should be a resource name ending with `operations/{unique_id}`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]547 "metadata": { # Service-specific metadata associated with the operation. It typically
548 # contains progress information and common metadata such as create time.
549 # Some services might not provide such metadata. Any method that returns a
550 # long-running operation should document the metadata type, if any.
551 "a_key": "", # Properties of the object. Contains field @type with type URL.
552 },
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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]578 "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.
579 # different programming environments, including REST APIs and RPC APIs. It is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]580 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
581 # three pieces of data: error code, error message, and error details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]582 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]583 # You can find out more about this error model and how to work with it in the
584 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]585 "message": "A String", # A developer-facing error message, which should be in English. Any
586 # user-facing error message should be localized and sent in the
587 # google.rpc.Status.details field, or localized by the client.
588 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
589 "details": [ # A list of messages that carry the error details. There is a common set of
590 # message types for APIs to use.
591 {
592 "a_key": "", # Properties of the object. Contains field @type with type URL.
593 },
594 ],
595 },
596 "done": True or False, # If the value is `false`, it means the operation is still in progress.
597 # If `true`, the operation is completed, and either `error` or `response` is
598 # available.
599 "response": { # The normal response of the operation in case of success. If the original
600 # method returns no data on success, such as `Delete`, the response is
601 # `google.protobuf.Empty`. If the original method is standard
602 # `Get`/`Create`/`Update`, the response should be the resource. For other
603 # methods, the response should have the type `XxxResponse`, where `Xxx`
604 # is the original method name. For example, if the original method name
605 # is `TakeSnapshot()`, the inferred response type is
606 # `TakeSnapshotResponse`.
607 "a_key": "", # Properties of the object. Contains field @type with type URL.
608 },
609 "name": "A String", # The server-assigned name, which is only unique within the same service that
610 # originally returns it. If you use the default HTTP mapping, the
611 # `name` should be a resource name ending with `operations/{unique_id}`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]612 "metadata": { # Service-specific metadata associated with the operation. It typically
613 # contains progress information and common metadata such as create time.
614 # Some services might not provide such metadata. Any method that returns a
615 # long-running operation should document the metadata type, if any.
616 "a_key": "", # Properties of the object. Contains field @type with type URL.
617 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]618 }</pre>
619</div>
620
621</body></html>