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