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