blob: b66e58cb62497373b86691be0052eecb96e8263c [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
yoshi-code-bot1a4514d2021-07-13 00:20:24 -070081 <code><a href="#create">create(parent, body=None, nodeId=None, requestId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070082<p class="firstline">Creates a node.</p>
83<p class="toc_element">
yoshi-code-bot1a4514d2021-07-13 00:20:24 -070084 <code><a href="#delete">delete(name, requestId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070085<p class="firstline">Deletes a node.</p>
86<p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88<p class="firstline">Gets the details of a node.</p>
89<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -080090 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070091<p class="firstline">Lists nodes.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070096 <code><a href="#reimage">reimage(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070097<p class="firstline">Reimages a node's OS.</p>
98<p class="toc_element">
99 <code><a href="#start">start(name, body=None, x__xgafv=None)</a></code></p>
100<p class="firstline">Starts a node.</p>
101<p class="toc_element">
102 <code><a href="#stop">stop(name, body=None, x__xgafv=None)</a></code></p>
103<p class="firstline">Stops a node.</p>
104<h3>Method Details</h3>
105<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700106 <code class="details" id="close">close()</code>
107 <pre>Close httplib2 connections.</pre>
108</div>
109
110<div class="method">
yoshi-code-bot1a4514d2021-07-13 00:20:24 -0700111 <code class="details" id="create">create(parent, body=None, nodeId=None, requestId=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700112 <pre>Creates a node.
113
114Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700115 parent: string, Required. The parent resource name. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700116 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700117 The object takes the form of:
118
119{ # A TPU instance.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800120 &quot;acceleratorType&quot;: &quot;A String&quot;, # Required. The type of hardware accelerators associated with this node.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400121 &quot;apiVersion&quot;: &quot;A String&quot;, # Output only. The API version that created this Node.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800122 &quot;cidrBlock&quot;: &quot;A String&quot;, # The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user&#x27;s provided network, or the provided network is peered with another network that is using that CIDR block.
123 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the node was created.
124 &quot;description&quot;: &quot;A String&quot;, # The user-supplied description of the TPU. Maximum of 512 characters.
125 &quot;health&quot;: &quot;A String&quot;, # The health status of the TPU node.
126 &quot;healthDescription&quot;: &quot;A String&quot;, # Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy.
127 &quot;ipAddress&quot;: &quot;A String&quot;, # Output only. DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances.
128 &quot;labels&quot;: { # Resource labels to represent user-provided metadata.
129 &quot;a_key&quot;: &quot;A String&quot;,
130 },
131 &quot;name&quot;: &quot;A String&quot;, # Output only. Immutable. The name of the TPU
132 &quot;network&quot;: &quot;A String&quot;, # The name of a network they wish to peer the TPU node to. It must be a preexisting Compute Engine network inside of the project on which this API has been activated. If none is provided, &quot;default&quot; will be used.
133 &quot;networkEndpoints&quot;: [ # Output only. The network endpoints where TPU workers can be accessed and sent work. It is recommended that Tensorflow clients of the node reach out to the 0th entry in this map first.
134 { # A network endpoint over which a TPU worker can be reached.
135 &quot;ipAddress&quot;: &quot;A String&quot;, # The IP address of this network endpoint.
136 &quot;port&quot;: 42, # The port of this network endpoint.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700137 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800138 ],
139 &quot;port&quot;: &quot;A String&quot;, # Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances.
140 &quot;schedulingConfig&quot;: { # Sets the scheduling options for this node. # The scheduling options for this node.
141 &quot;preemptible&quot;: True or False, # Defines whether the node is preemptible.
142 &quot;reserved&quot;: True or False, # Whether the node is created under a reservation.
143 },
144 &quot;serviceAccount&quot;: &quot;A String&quot;, # Output only. The service account used to run the tensor flow services within the node. To share resources, including Google Cloud Storage data, with the Tensorflow job running in the Node, this account must have permissions to that data.
145 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state for the TPU Node.
146 &quot;symptoms&quot;: [ # Output only. The Symptoms that have occurred to the TPU Node.
147 { # A Symptom instance.
148 &quot;createTime&quot;: &quot;A String&quot;, # Timestamp when the Symptom is created.
149 &quot;details&quot;: &quot;A String&quot;, # Detailed information of the current Symptom.
150 &quot;symptomType&quot;: &quot;A String&quot;, # Type of the Symptom.
151 &quot;workerId&quot;: &quot;A String&quot;, # A string used to uniquely distinguish a worker within a TPU node.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700152 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800153 ],
154 &quot;tensorflowVersion&quot;: &quot;A String&quot;, # Required. The version of Tensorflow running in the Node.
155 &quot;useServiceNetworking&quot;: True or False, # Whether the VPC peering for the node is set up through Service Networking API. The VPC Peering should be set up before provisioning the node. If this field is set, cidr_block field should not be specified. If the network, that you want to peer the TPU Node to, is Shared VPC networks, the node must be created with this this field enabled.
156}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700157
158 nodeId: string, The unqualified resource name.
yoshi-code-bot1a4514d2021-07-13 00:20:24 -0700159 requestId: string, Idempotent request UUID.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700160 x__xgafv: string, V1 error format.
161 Allowed values
162 1 - v1 error format
163 2 - v2 error format
164
165Returns:
166 An object of the form:
167
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700168 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800169 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
170 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
171 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
172 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
173 {
174 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
175 },
176 ],
177 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
178 },
179 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
180 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
181 },
182 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
183 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
184 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
185 },
186}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700187</div>
188
189<div class="method">
yoshi-code-bot1a4514d2021-07-13 00:20:24 -0700190 <code class="details" id="delete">delete(name, requestId=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700191 <pre>Deletes a node.
192
193Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700194 name: string, Required. The resource name. (required)
yoshi-code-bot1a4514d2021-07-13 00:20:24 -0700195 requestId: string, Idempotent request UUID.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700196 x__xgafv: string, V1 error format.
197 Allowed values
198 1 - v1 error format
199 2 - v2 error format
200
201Returns:
202 An object of the form:
203
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700204 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800205 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
206 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
207 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
208 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
209 {
210 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
211 },
212 ],
213 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
214 },
215 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
216 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
217 },
218 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
219 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
220 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
221 },
222}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700223</div>
224
225<div class="method">
226 <code class="details" id="get">get(name, x__xgafv=None)</code>
227 <pre>Gets the details of a node.
228
229Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700230 name: string, Required. The resource name. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700231 x__xgafv: string, V1 error format.
232 Allowed values
233 1 - v1 error format
234 2 - v2 error format
235
236Returns:
237 An object of the form:
238
239 { # A TPU instance.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800240 &quot;acceleratorType&quot;: &quot;A String&quot;, # Required. The type of hardware accelerators associated with this node.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400241 &quot;apiVersion&quot;: &quot;A String&quot;, # Output only. The API version that created this Node.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800242 &quot;cidrBlock&quot;: &quot;A String&quot;, # The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user&#x27;s provided network, or the provided network is peered with another network that is using that CIDR block.
243 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the node was created.
244 &quot;description&quot;: &quot;A String&quot;, # The user-supplied description of the TPU. Maximum of 512 characters.
245 &quot;health&quot;: &quot;A String&quot;, # The health status of the TPU node.
246 &quot;healthDescription&quot;: &quot;A String&quot;, # Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy.
247 &quot;ipAddress&quot;: &quot;A String&quot;, # Output only. DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances.
248 &quot;labels&quot;: { # Resource labels to represent user-provided metadata.
249 &quot;a_key&quot;: &quot;A String&quot;,
250 },
251 &quot;name&quot;: &quot;A String&quot;, # Output only. Immutable. The name of the TPU
252 &quot;network&quot;: &quot;A String&quot;, # The name of a network they wish to peer the TPU node to. It must be a preexisting Compute Engine network inside of the project on which this API has been activated. If none is provided, &quot;default&quot; will be used.
253 &quot;networkEndpoints&quot;: [ # Output only. The network endpoints where TPU workers can be accessed and sent work. It is recommended that Tensorflow clients of the node reach out to the 0th entry in this map first.
254 { # A network endpoint over which a TPU worker can be reached.
255 &quot;ipAddress&quot;: &quot;A String&quot;, # The IP address of this network endpoint.
256 &quot;port&quot;: 42, # The port of this network endpoint.
257 },
258 ],
259 &quot;port&quot;: &quot;A String&quot;, # Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances.
260 &quot;schedulingConfig&quot;: { # Sets the scheduling options for this node. # The scheduling options for this node.
261 &quot;preemptible&quot;: True or False, # Defines whether the node is preemptible.
262 &quot;reserved&quot;: True or False, # Whether the node is created under a reservation.
263 },
264 &quot;serviceAccount&quot;: &quot;A String&quot;, # Output only. The service account used to run the tensor flow services within the node. To share resources, including Google Cloud Storage data, with the Tensorflow job running in the Node, this account must have permissions to that data.
265 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state for the TPU Node.
266 &quot;symptoms&quot;: [ # Output only. The Symptoms that have occurred to the TPU Node.
267 { # A Symptom instance.
268 &quot;createTime&quot;: &quot;A String&quot;, # Timestamp when the Symptom is created.
269 &quot;details&quot;: &quot;A String&quot;, # Detailed information of the current Symptom.
270 &quot;symptomType&quot;: &quot;A String&quot;, # Type of the Symptom.
271 &quot;workerId&quot;: &quot;A String&quot;, # A string used to uniquely distinguish a worker within a TPU node.
272 },
273 ],
274 &quot;tensorflowVersion&quot;: &quot;A String&quot;, # Required. The version of Tensorflow running in the Node.
275 &quot;useServiceNetworking&quot;: True or False, # Whether the VPC peering for the node is set up through Service Networking API. The VPC Peering should be set up before provisioning the node. If this field is set, cidr_block field should not be specified. If the network, that you want to peer the TPU Node to, is Shared VPC networks, the node must be created with this this field enabled.
276}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700277</div>
278
279<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800280 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700281 <pre>Lists nodes.
282
283Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700284 parent: string, Required. The parent resource name. (required)
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800285 pageSize: integer, The maximum number of items to return.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800286 pageToken: string, The next_page_token value returned from a previous List request, if any.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700287 x__xgafv: string, V1 error format.
288 Allowed values
289 1 - v1 error format
290 2 - v2 error format
291
292Returns:
293 An object of the form:
294
295 { # Response for ListNodes.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800296 &quot;nextPageToken&quot;: &quot;A String&quot;, # The next page token or empty if none.
297 &quot;nodes&quot;: [ # The listed nodes.
298 { # A TPU instance.
299 &quot;acceleratorType&quot;: &quot;A String&quot;, # Required. The type of hardware accelerators associated with this node.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400300 &quot;apiVersion&quot;: &quot;A String&quot;, # Output only. The API version that created this Node.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800301 &quot;cidrBlock&quot;: &quot;A String&quot;, # The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user&#x27;s provided network, or the provided network is peered with another network that is using that CIDR block.
302 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the node was created.
303 &quot;description&quot;: &quot;A String&quot;, # The user-supplied description of the TPU. Maximum of 512 characters.
304 &quot;health&quot;: &quot;A String&quot;, # The health status of the TPU node.
305 &quot;healthDescription&quot;: &quot;A String&quot;, # Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy.
306 &quot;ipAddress&quot;: &quot;A String&quot;, # Output only. DEPRECATED! Use network_endpoints instead. The network address for the TPU Node as visible to Compute Engine instances.
307 &quot;labels&quot;: { # Resource labels to represent user-provided metadata.
308 &quot;a_key&quot;: &quot;A String&quot;,
309 },
310 &quot;name&quot;: &quot;A String&quot;, # Output only. Immutable. The name of the TPU
311 &quot;network&quot;: &quot;A String&quot;, # The name of a network they wish to peer the TPU node to. It must be a preexisting Compute Engine network inside of the project on which this API has been activated. If none is provided, &quot;default&quot; will be used.
312 &quot;networkEndpoints&quot;: [ # Output only. The network endpoints where TPU workers can be accessed and sent work. It is recommended that Tensorflow clients of the node reach out to the 0th entry in this map first.
313 { # A network endpoint over which a TPU worker can be reached.
314 &quot;ipAddress&quot;: &quot;A String&quot;, # The IP address of this network endpoint.
315 &quot;port&quot;: 42, # The port of this network endpoint.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800316 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800317 ],
318 &quot;port&quot;: &quot;A String&quot;, # Output only. DEPRECATED! Use network_endpoints instead. The network port for the TPU Node as visible to Compute Engine instances.
319 &quot;schedulingConfig&quot;: { # Sets the scheduling options for this node. # The scheduling options for this node.
320 &quot;preemptible&quot;: True or False, # Defines whether the node is preemptible.
321 &quot;reserved&quot;: True or False, # Whether the node is created under a reservation.
322 },
323 &quot;serviceAccount&quot;: &quot;A String&quot;, # Output only. The service account used to run the tensor flow services within the node. To share resources, including Google Cloud Storage data, with the Tensorflow job running in the Node, this account must have permissions to that data.
324 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state for the TPU Node.
325 &quot;symptoms&quot;: [ # Output only. The Symptoms that have occurred to the TPU Node.
326 { # A Symptom instance.
327 &quot;createTime&quot;: &quot;A String&quot;, # Timestamp when the Symptom is created.
328 &quot;details&quot;: &quot;A String&quot;, # Detailed information of the current Symptom.
329 &quot;symptomType&quot;: &quot;A String&quot;, # Type of the Symptom.
330 &quot;workerId&quot;: &quot;A String&quot;, # A string used to uniquely distinguish a worker within a TPU node.
331 },
332 ],
333 &quot;tensorflowVersion&quot;: &quot;A String&quot;, # Required. The version of Tensorflow running in the Node.
334 &quot;useServiceNetworking&quot;: True or False, # Whether the VPC peering for the node is set up through Service Networking API. The VPC Peering should be set up before provisioning the node. If this field is set, cidr_block field should not be specified. If the network, that you want to peer the TPU Node to, is Shared VPC networks, the node must be created with this this field enabled.
335 },
336 ],
337 &quot;unreachable&quot;: [ # Locations that could not be reached.
338 &quot;A String&quot;,
339 ],
340}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700341</div>
342
343<div class="method">
344 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
345 <pre>Retrieves the next page of results.
346
347Args:
348 previous_request: The request for the previous page. (required)
349 previous_response: The response from the request for the previous page. (required)
350
351Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700352 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700353 page. Returns None if there are no more items in the collection.
354 </pre>
355</div>
356
357<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700358 <code class="details" id="reimage">reimage(name, body=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700359 <pre>Reimages a node&#x27;s OS.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700360
361Args:
362 name: string, The resource name. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700363 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700364 The object takes the form of:
365
366{ # Request for ReimageNode.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800367 &quot;tensorflowVersion&quot;: &quot;A String&quot;, # The version for reimage to create.
368}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700369
370 x__xgafv: string, V1 error format.
371 Allowed values
372 1 - v1 error format
373 2 - v2 error format
374
375Returns:
376 An object of the form:
377
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700378 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800379 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
380 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
381 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
382 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
383 {
384 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
385 },
386 ],
387 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
388 },
389 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
390 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
391 },
392 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
393 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
394 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
395 },
396}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700397</div>
398
399<div class="method">
400 <code class="details" id="start">start(name, body=None, x__xgafv=None)</code>
401 <pre>Starts a node.
402
403Args:
404 name: string, The resource name. (required)
405 body: object, The request body.
406 The object takes the form of:
407
408{ # Request for StartNode.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800409}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700410
411 x__xgafv: string, V1 error format.
412 Allowed values
413 1 - v1 error format
414 2 - v2 error format
415
416Returns:
417 An object of the form:
418
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700419 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800420 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
421 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
422 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
423 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
424 {
425 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
426 },
427 ],
428 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
429 },
430 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
431 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
432 },
433 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
434 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
435 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
436 },
437}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700438</div>
439
440<div class="method">
441 <code class="details" id="stop">stop(name, body=None, x__xgafv=None)</code>
442 <pre>Stops a node.
443
444Args:
445 name: string, The resource name. (required)
446 body: object, The request body.
447 The object takes the form of:
448
449{ # Request for StopNode.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800450}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700451
452 x__xgafv: string, V1 error format.
453 Allowed values
454 1 - v1 error format
455 2 - v2 error format
456
457Returns:
458 An object of the form:
459
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700460 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800461 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
462 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
463 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
464 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
465 {
466 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
467 },
468 ],
469 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
470 },
471 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
472 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
473 },
474 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
475 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
476 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
477 },
478}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700479</div>
480
481</body></html>