Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / tpu_v1alpha1.projects.locations.nodes.html
blob: c20d724d79b95c0f7306739eb1ee349ec397e942 [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">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]87 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]112 &quot;networkEndpoints&quot;: [ # Output only. The network endpoints where TPU workers can be accessed and
113 # sent work. It is recommended that Tensorflow clients of the node reach out
114 # to the 0th entry in this map first.
115 { # A network endpoint over which a TPU worker can be reached.
116 &quot;port&quot;: 42, # The port of this network endpoint.
117 &quot;ipAddress&quot;: &quot;A String&quot;, # The IP address of this network endpoint.
118 },
119 ],
120 &quot;labels&quot;: { # Resource labels to represent user-provided metadata.
121 &quot;a_key&quot;: &quot;A String&quot;,
122 },
123 &quot;name&quot;: &quot;A String&quot;, # Output only. The immutable name of the TPU
124 &quot;tensorflowVersion&quot;: &quot;A String&quot;, # The version of Tensorflow running in the Node.
125 # Required.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]126 &quot;health&quot;: &quot;A String&quot;, # The health status of the TPU node.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]127 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state for the TPU Node.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]128 &quot;cidrBlock&quot;: &quot;A String&quot;, # The CIDR block that the TPU node will use when selecting an IP address.
129 # This CIDR block must be a /29 block; the Compute Engine networks API
130 # forbids a smaller block, and using a larger block would be wasteful (a
131 # node can only consume one IP address). Errors will occur if the CIDR block
132 # has already been used for a currently existing TPU node, the CIDR block
133 # conflicts with any subnetworks in the user&#x27;s provided network, or the
134 # provided network is peered with another network that is using that CIDR
135 # block.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]136 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the node was created.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]137 &quot;description&quot;: &quot;A String&quot;, # The user-supplied description of the TPU. Maximum of 512 characters.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]138 &quot;schedulingConfig&quot;: { # Sets the scheduling options for this node.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]139 &quot;reserved&quot;: True or False, # Whether the node is created under a reservation.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]140 &quot;preemptible&quot;: True or False, # Defines whether the node is preemptible.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]141 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]142 &quot;ipAddress&quot;: &quot;A String&quot;, # Output only. DEPRECATED! Use network_endpoints instead.
143 # The network address for the TPU Node as visible to Compute Engine
144 # instances.
145 &quot;network&quot;: &quot;A String&quot;, # The name of a network they wish to peer the TPU node to. It must be a
146 # preexisting Compute Engine network inside of the project on which this API
147 # has been activated. If none is provided, &quot;default&quot; will be used.
148 &quot;healthDescription&quot;: &quot;A String&quot;, # Output only. If this field is populated, it contains a description of why the TPU Node
149 # is unhealthy.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]150 &quot;port&quot;: &quot;A String&quot;, # Output only. DEPRECATED! Use network_endpoints instead.
151 # The network port for the TPU Node as visible to Compute Engine instances.
152 &quot;serviceAccount&quot;: &quot;A String&quot;, # Output only. The service account used to run the tensor flow services within the node.
153 # To share resources, including Google Cloud Storage data, with the
154 # Tensorflow job running in the Node, this account must have permissions to
155 # that data.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]156 &quot;acceleratorType&quot;: &quot;A String&quot;, # The type of hardware accelerators associated with this node.
157 # Required.
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 Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]171 &quot;metadata&quot;: { # 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 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
176 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]177 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
178 # If `true`, the operation is completed, and either `error` or `response` is
179 # available.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]180 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
181 # originally returns it. If you use the default HTTP mapping, the
182 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]183 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]184 # method returns no data on success, such as `Delete`, the response is
185 # `google.protobuf.Empty`. If the original method is standard
186 # `Get`/`Create`/`Update`, the response should be the resource. For other
187 # methods, the response should have the type `XxxResponse`, where `Xxx`
188 # is the original method name. For example, if the original method name
189 # is `TakeSnapshot()`, the inferred response type is
190 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]191 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]192 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]193 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
194 # different programming environments, including REST APIs and RPC APIs. It is
195 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
196 # three pieces of data: error code, error message, and error details.
197 #
198 # You can find out more about this error model and how to work with it in the
199 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]200 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
201 # user-facing error message should be localized and sent in the
202 # google.rpc.Status.details field, or localized by the client.
203 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]204 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
205 # message types for APIs to use.
206 {
207 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
208 },
209 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]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 Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]230 &quot;metadata&quot;: { # 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 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
235 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]236 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
237 # If `true`, the operation is completed, and either `error` or `response` is
238 # available.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]239 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
240 # originally returns it. If you use the default HTTP mapping, the
241 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]242 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]243 # method returns no data on success, such as `Delete`, the response is
244 # `google.protobuf.Empty`. If the original method is standard
245 # `Get`/`Create`/`Update`, the response should be the resource. For other
246 # methods, the response should have the type `XxxResponse`, where `Xxx`
247 # is the original method name. For example, if the original method name
248 # is `TakeSnapshot()`, the inferred response type is
249 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]250 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]251 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]252 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
253 # different programming environments, including REST APIs and RPC APIs. It is
254 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
255 # three pieces of data: error code, error message, and error details.
256 #
257 # You can find out more about this error model and how to work with it in the
258 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]259 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
260 # user-facing error message should be localized and sent in the
261 # google.rpc.Status.details field, or localized by the client.
262 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]263 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
264 # message types for APIs to use.
265 {
266 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
267 },
268 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]288 &quot;networkEndpoints&quot;: [ # Output only. The network endpoints where TPU workers can be accessed and
289 # sent work. It is recommended that Tensorflow clients of the node reach out
290 # to the 0th entry in this map first.
291 { # A network endpoint over which a TPU worker can be reached.
292 &quot;port&quot;: 42, # The port of this network endpoint.
293 &quot;ipAddress&quot;: &quot;A String&quot;, # The IP address of this network endpoint.
294 },
295 ],
296 &quot;labels&quot;: { # Resource labels to represent user-provided metadata.
297 &quot;a_key&quot;: &quot;A String&quot;,
298 },
299 &quot;name&quot;: &quot;A String&quot;, # Output only. The immutable name of the TPU
300 &quot;tensorflowVersion&quot;: &quot;A String&quot;, # The version of Tensorflow running in the Node.
301 # Required.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]302 &quot;health&quot;: &quot;A String&quot;, # The health status of the TPU node.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]303 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state for the TPU Node.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]304 &quot;cidrBlock&quot;: &quot;A String&quot;, # The CIDR block that the TPU node will use when selecting an IP address.
305 # This CIDR block must be a /29 block; the Compute Engine networks API
306 # forbids a smaller block, and using a larger block would be wasteful (a
307 # node can only consume one IP address). Errors will occur if the CIDR block
308 # has already been used for a currently existing TPU node, the CIDR block
309 # conflicts with any subnetworks in the user&#x27;s provided network, or the
310 # provided network is peered with another network that is using that CIDR
311 # block.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]312 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the node was created.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]313 &quot;description&quot;: &quot;A String&quot;, # The user-supplied description of the TPU. Maximum of 512 characters.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]314 &quot;schedulingConfig&quot;: { # Sets the scheduling options for this node.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]315 &quot;reserved&quot;: True or False, # Whether the node is created under a reservation.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]316 &quot;preemptible&quot;: True or False, # Defines whether the node is preemptible.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]317 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]318 &quot;ipAddress&quot;: &quot;A String&quot;, # Output only. DEPRECATED! Use network_endpoints instead.
319 # The network address for the TPU Node as visible to Compute Engine
320 # instances.
321 &quot;network&quot;: &quot;A String&quot;, # The name of a network they wish to peer the TPU node to. It must be a
322 # preexisting Compute Engine network inside of the project on which this API
323 # has been activated. If none is provided, &quot;default&quot; will be used.
324 &quot;healthDescription&quot;: &quot;A String&quot;, # Output only. If this field is populated, it contains a description of why the TPU Node
325 # is unhealthy.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]326 &quot;port&quot;: &quot;A String&quot;, # Output only. DEPRECATED! Use network_endpoints instead.
327 # The network port for the TPU Node as visible to Compute Engine instances.
328 &quot;serviceAccount&quot;: &quot;A String&quot;, # Output only. The service account used to run the tensor flow services within the node.
329 # To share resources, including Google Cloud Storage data, with the
330 # Tensorflow job running in the Node, this account must have permissions to
331 # that data.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]332 &quot;acceleratorType&quot;: &quot;A String&quot;, # The type of hardware accelerators associated with this node.
333 # Required.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]334 }</pre>
335</div>
336
337<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]338 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]339 <pre>Lists nodes.
340
341Args:
342 parent: string, The parent resource name. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]343 pageSize: integer, The maximum number of items to return.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]344 pageToken: string, The next_page_token value returned from a previous List request, if any.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]354 &quot;unreachable&quot;: [ # Locations that could not be reached.
355 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]356 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]357 &quot;nodes&quot;: [ # The listed nodes.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]358 { # A TPU instance.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]359 &quot;networkEndpoints&quot;: [ # Output only. The network endpoints where TPU workers can be accessed and
360 # sent work. It is recommended that Tensorflow clients of the node reach out
361 # to the 0th entry in this map first.
362 { # A network endpoint over which a TPU worker can be reached.
363 &quot;port&quot;: 42, # The port of this network endpoint.
364 &quot;ipAddress&quot;: &quot;A String&quot;, # The IP address of this network endpoint.
365 },
366 ],
367 &quot;labels&quot;: { # Resource labels to represent user-provided metadata.
368 &quot;a_key&quot;: &quot;A String&quot;,
369 },
370 &quot;name&quot;: &quot;A String&quot;, # Output only. The immutable name of the TPU
371 &quot;tensorflowVersion&quot;: &quot;A String&quot;, # The version of Tensorflow running in the Node.
372 # Required.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]373 &quot;health&quot;: &quot;A String&quot;, # The health status of the TPU node.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]374 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state for the TPU Node.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]375 &quot;cidrBlock&quot;: &quot;A String&quot;, # The CIDR block that the TPU node will use when selecting an IP address.
376 # This CIDR block must be a /29 block; the Compute Engine networks API
377 # forbids a smaller block, and using a larger block would be wasteful (a
378 # node can only consume one IP address). Errors will occur if the CIDR block
379 # has already been used for a currently existing TPU node, the CIDR block
380 # conflicts with any subnetworks in the user&#x27;s provided network, or the
381 # provided network is peered with another network that is using that CIDR
382 # block.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]383 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the node was created.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]384 &quot;description&quot;: &quot;A String&quot;, # The user-supplied description of the TPU. Maximum of 512 characters.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]385 &quot;schedulingConfig&quot;: { # Sets the scheduling options for this node.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]386 &quot;reserved&quot;: True or False, # Whether the node is created under a reservation.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]387 &quot;preemptible&quot;: True or False, # Defines whether the node is preemptible.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]388 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]389 &quot;ipAddress&quot;: &quot;A String&quot;, # Output only. DEPRECATED! Use network_endpoints instead.
390 # The network address for the TPU Node as visible to Compute Engine
391 # instances.
392 &quot;network&quot;: &quot;A String&quot;, # The name of a network they wish to peer the TPU node to. It must be a
393 # preexisting Compute Engine network inside of the project on which this API
394 # has been activated. If none is provided, &quot;default&quot; will be used.
395 &quot;healthDescription&quot;: &quot;A String&quot;, # Output only. If this field is populated, it contains a description of why the TPU Node
396 # is unhealthy.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]397 &quot;port&quot;: &quot;A String&quot;, # Output only. DEPRECATED! Use network_endpoints instead.
398 # The network port for the TPU Node as visible to Compute Engine instances.
399 &quot;serviceAccount&quot;: &quot;A String&quot;, # Output only. The service account used to run the tensor flow services within the node.
400 # To share resources, including Google Cloud Storage data, with the
401 # Tensorflow job running in the Node, this account must have permissions to
402 # that data.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]403 &quot;acceleratorType&quot;: &quot;A String&quot;, # The type of hardware accelerators associated with this node.
404 # Required.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]405 },
406 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]407 &quot;nextPageToken&quot;: &quot;A String&quot;, # The next page token or empty if none.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]420 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame]427 <pre>Reimages a node&#x27;s OS.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]435 &quot;tensorflowVersion&quot;: &quot;A String&quot;, # The version for reimage to create.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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 Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]448 &quot;metadata&quot;: { # 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 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
453 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]454 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
455 # If `true`, the operation is completed, and either `error` or `response` is
456 # available.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]457 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
458 # originally returns it. If you use the default HTTP mapping, the
459 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]460 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]461 # method returns no data on success, such as `Delete`, the response is
462 # `google.protobuf.Empty`. If the original method is standard
463 # `Get`/`Create`/`Update`, the response should be the resource. For other
464 # methods, the response should have the type `XxxResponse`, where `Xxx`
465 # is the original method name. For example, if the original method name
466 # is `TakeSnapshot()`, the inferred response type is
467 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]468 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]469 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]470 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
471 # different programming environments, including REST APIs and RPC APIs. It is
472 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
473 # three pieces of data: error code, error message, and error details.
474 #
475 # You can find out more about this error model and how to work with it in the
476 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]477 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
478 # user-facing error message should be localized and sent in the
479 # google.rpc.Status.details field, or localized by the client.
480 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]481 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
482 # message types for APIs to use.
483 {
484 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
485 },
486 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]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 Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]513 &quot;metadata&quot;: { # 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 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
518 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]519 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
520 # If `true`, the operation is completed, and either `error` or `response` is
521 # available.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]522 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
523 # originally returns it. If you use the default HTTP mapping, the
524 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]525 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]526 # method returns no data on success, such as `Delete`, the response is
527 # `google.protobuf.Empty`. If the original method is standard
528 # `Get`/`Create`/`Update`, the response should be the resource. For other
529 # methods, the response should have the type `XxxResponse`, where `Xxx`
530 # is the original method name. For example, if the original method name
531 # is `TakeSnapshot()`, the inferred response type is
532 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]533 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]534 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]535 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
536 # different programming environments, including REST APIs and RPC APIs. It is
537 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
538 # three pieces of data: error code, error message, and error details.
539 #
540 # You can find out more about this error model and how to work with it in the
541 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]542 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
543 # user-facing error message should be localized and sent in the
544 # google.rpc.Status.details field, or localized by the client.
545 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]546 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
547 # message types for APIs to use.
548 {
549 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
550 },
551 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]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 Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]578 &quot;metadata&quot;: { # 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 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
583 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]584 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
585 # If `true`, the operation is completed, and either `error` or `response` is
586 # available.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]587 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
588 # originally returns it. If you use the default HTTP mapping, the
589 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]590 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]591 # method returns no data on success, such as `Delete`, the response is
592 # `google.protobuf.Empty`. If the original method is standard
593 # `Get`/`Create`/`Update`, the response should be the resource. For other
594 # methods, the response should have the type `XxxResponse`, where `Xxx`
595 # is the original method name. For example, if the original method name
596 # is `TakeSnapshot()`, the inferred response type is
597 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]598 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]599 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]600 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
601 # different programming environments, including REST APIs and RPC APIs. It is
602 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
603 # three pieces of data: error code, error message, and error details.
604 #
605 # You can find out more about this error model and how to work with it in the
606 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]607 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
608 # user-facing error message should be localized and sent in the
609 # google.rpc.Status.details field, or localized by the client.
610 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]611 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
612 # message types for APIs to use.
613 {
614 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
615 },
616 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]617 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]618 }</pre>
619</div>
620
621</body></html>