1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="tpu_v2.html">Cloud TPU API</a> . <a href="tpu_v2.projects.html">projects</a> . <a href="tpu_v2.projects.locations.html">locations</a> . <a href="tpu_v2.projects.locations.queuedResources.html">queuedResources</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, queuedResourceId=None, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a QueuedResource TPU instance.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, force=None, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a QueuedResource TPU instance.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a queued resource.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists queued resources.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#reset">reset(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Resets a QueuedResource TPU instance</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, queuedResourceId=None, requestId=None, x__xgafv=None)</code>
<pre>Creates a QueuedResource TPU instance.
Args:
parent: string, Required. The parent resource name. (required)
body: object, The request body.
The object takes the form of:
{ # A QueuedResource represents a request for resources that will be placed in a queue and fulfilled when the necessary resources are available.
"createTime": "A String", # Output only. The time when the QueuedResource was created.
"guaranteed": { # Guaranteed tier definition. # Optional. The Guaranteed tier
"minDuration": "A String", # Optional. Defines the minimum duration of the guarantee. If specified, the requested resources will only be provisioned if they can be allocated for at least the given duration.
},
"name": "A String", # Output only. Immutable. The name of the QueuedResource.
"queueingPolicy": { # Defines the policy of the QueuedRequest. # Optional. The queueing policy of the QueuedRequest.
"validAfterDuration": "A String", # Optional. A relative time after which resources may be created.
"validAfterTime": "A String", # Optional. An absolute time after which resources may be created.
"validInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Optional. An absolute time interval within which resources may be created.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
"validUntilDuration": "A String", # Optional. A relative time after which resources should not be created. If the request cannot be fulfilled by this time the request will be failed.
"validUntilTime": "A String", # Optional. An absolute time after which resources should not be created. If the request cannot be fulfilled by this time the request will be failed.
},
"reservationName": "A String", # Optional. Name of the reservation in which the resource should be provisioned. Format: projects/{project}/locations/{zone}/reservations/{reservation}
"spot": { # Spot tier definition. # Optional. The Spot tier.
},
"state": { # QueuedResourceState defines the details of the QueuedResource request. # Output only. State of the QueuedResource request.
"acceptedData": { # Further data for the accepted state. # Output only. Further data for the accepted state.
},
"activeData": { # Further data for the active state. # Output only. Further data for the active state.
},
"creatingData": { # Further data for the creating state. # Output only. Further data for the creating state.
},
"deletingData": { # Further data for the deleting state. # Output only. Further data for the deleting state.
},
"failedData": { # Further data for the failed state. # Output only. Further data for the failed state.
"error": { # 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). # Output only. The error that caused the queued resource to enter the FAILED state.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
},
"provisioningData": { # Further data for the provisioning state. # Output only. Further data for the provisioning state.
},
"state": "A String", # Output only. State of the QueuedResource request.
"stateInitiator": "A String", # Output only. The initiator of the QueuedResources's current state. Used to indicate whether the SUSPENDING/SUSPENDED state was initiated by the user or the service.
"suspendedData": { # Further data for the suspended state. # Output only. Further data for the suspended state.
},
"suspendingData": { # Further data for the suspending state. # Output only. Further data for the suspending state.
},
},
"tpu": { # Details of the TPU resource(s) being requested. # Optional. Defines a TPU resource.
"nodeSpec": [ # Optional. The TPU node(s) being requested.
{ # Details of the TPU node(s) being requested. Users can request either a single node or multiple nodes. NodeSpec provides the specification for node(s) to be created.
"multisliceParams": { # Parameters to specify for multislice QueuedResource requests. This message must be populated in case of multislice requests instead of node_id. # Optional. Fields to specify in case of multislice request.
"nodeCount": 42, # Required. Number of nodes with this spec. The system will attempt to provision "node_count" nodes as part of the request. This needs to be > 1.
"nodeIdPrefix": "A String", # Optional. Prefix of node_ids in case of multislice request. Should follow the `^[A-Za-z0-9_.~+%-]+$` regex format. If node_count = 3 and node_id_prefix = "np", node ids of nodes created will be "np-0", "np-1", "np-2". If this field is not provided we use queued_resource_id as the node_id_prefix.
},
"node": { # A TPU instance. # Required. The node.
"acceleratorConfig": { # A TPU accelerator configuration. # The AccleratorConfig for the TPU Node.
"topology": "A String", # Required. Topology of TPU in chips.
"type": "A String", # Required. Type of TPU.
},
"acceleratorType": "A String", # Optional. The type of hardware accelerators associated with this node.
"apiVersion": "A String", # Output only. The API version that created this Node.
"cidrBlock": "A String", # 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's provided network, or the provided network is peered with another network that is using that CIDR block.
"createTime": "A String", # Output only. The time when the node was created.
"dataDisks": [ # The additional data disks for the Node.
{ # A node-attached disk resource. Next ID: 8;
"mode": "A String", # The mode in which to attach this disk. If not specified, the default is READ_WRITE mode. Only applicable to data_disks.
"sourceDisk": "A String", # Specifies the full path to an existing disk. For example: "projects/my-project/zones/us-central1-c/disks/my-disk".
},
],
"description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters.
"health": "A String", # The health status of the TPU node.
"healthDescription": "A String", # Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy.
"id": "A String", # Output only. The unique identifier for the TPU Node.
"labels": { # Resource labels to represent user-provided metadata.
"a_key": "A String",
},
"metadata": { # Custom metadata to apply to the TPU Node. Can set startup-script and shutdown-script
"a_key": "A String",
},
"multisliceNode": True or False, # Output only. Whether the Node belongs to a Multislice group.
"name": "A String", # Output only. Immutable. The name of the TPU.
"networkConfig": { # Network related configurations. # Network configurations for the TPU node. network_config and network_configs are mutually exclusive, you can only specify one of them. If both are specified, an error will be returned.
"canIpForward": True or False, # Allows the TPU node to send and receive packets with non-matching destination or source IPs. This is required if you plan to use the TPU workers to forward routes.
"enableExternalIps": True or False, # Indicates that external IP addresses would be associated with the TPU workers. If set to false, the specified subnetwork or network should have Private Google Access enabled.
"network": "A String", # The name of the network for the TPU node. It must be a preexisting Google Compute Engine network. If none is provided, "default" will be used.
"queueCount": 42, # Optional. Specifies networking queue count for TPU VM instance's network interface.
"subnetwork": "A String", # The name of the subnetwork for the TPU node. It must be a preexisting Google Compute Engine subnetwork. If none is provided, "default" will be used.
},
"networkConfigs": [ # Optional. Repeated network configurations for the TPU node. This field is used to specify multiple networks configs for the TPU node. network_config and network_configs are mutually exclusive, you can only specify one of them. If both are specified, an error will be returned.
{ # Network related configurations.
"canIpForward": True or False, # Allows the TPU node to send and receive packets with non-matching destination or source IPs. This is required if you plan to use the TPU workers to forward routes.
"enableExternalIps": True or False, # Indicates that external IP addresses would be associated with the TPU workers. If set to false, the specified subnetwork or network should have Private Google Access enabled.
"network": "A String", # The name of the network for the TPU node. It must be a preexisting Google Compute Engine network. If none is provided, "default" will be used.
"queueCount": 42, # Optional. Specifies networking queue count for TPU VM instance's network interface.
"subnetwork": "A String", # The name of the subnetwork for the TPU node. It must be a preexisting Google Compute Engine subnetwork. If none is provided, "default" will be used.
},
],
"networkEndpoints": [ # Output only. The network endpoints where TPU workers can be accessed and sent work. It is recommended that runtime clients of the node reach out to the 0th entry in this map first.
{ # A network endpoint over which a TPU worker can be reached.
"accessConfig": { # An access config attached to the TPU worker. # The access config for the TPU worker.
"externalIp": "A String", # Output only. An external IP address associated with the TPU worker.
},
"ipAddress": "A String", # The internal IP address of this network endpoint.
"port": 42, # The port of this network endpoint.
},
],
"queuedResource": "A String", # Output only. The qualified name of the QueuedResource that requested this Node.
"runtimeVersion": "A String", # Required. The runtime version running in the Node.
"schedulingConfig": { # Sets the scheduling options for this node. # The scheduling options for this node.
"preemptible": True or False, # Defines whether the node is preemptible.
"reserved": True or False, # Whether the node is created under a reservation.
"spot": True or False, # Optional. Defines whether the node is Spot VM.
},
"serviceAccount": { # A service account. # The Google Cloud Platform Service Account to be used by the TPU node VMs. If None is specified, the default compute service account will be used.
"email": "A String", # Email address of the service account. If empty, default Compute service account will be used.
"scope": [ # The list of scopes to be made available for this service account. If empty, access to all Cloud APIs will be allowed.
"A String",
],
},
"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.
"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.
},
"state": "A String", # Output only. The current state for the TPU Node.
"symptoms": [ # Output only. The Symptoms that have occurred to the TPU Node.
{ # A Symptom instance.
"createTime": "A String", # Timestamp when the Symptom is created.
"details": "A String", # Detailed information of the current Symptom.
"symptomType": "A String", # Type of the Symptom.
"workerId": "A String", # A string used to uniquely distinguish a worker within a TPU node.
},
],
"tags": [ # Tags to apply to the TPU Node. Tags are used to identify valid sources or targets for network firewalls.
"A String",
],
"upcomingMaintenance": { # Upcoming Maintenance notification information. # Output only. Upcoming maintenance on this TPU node.
"canReschedule": True or False, # Indicates if the maintenance can be customer triggered.
"latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.
"maintenanceStatus": "A String", # The status of the maintenance.
"type": "A String", # Defines the type of maintenance.
"windowEndTime": "A String", # The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.
"windowStartTime": "A String", # The current start time of the maintenance window. This timestamp value is in RFC3339 text format.
},
},
"nodeId": "A String", # Optional. The unqualified resource name. Should follow the `^[A-Za-z0-9_.~+%-]+$` regex format. This is only specified when requesting a single node. In case of multislice requests, multislice_params must be populated instead.
"parent": "A String", # Required. The parent resource name.
},
],
},
}
queuedResourceId: string, Optional. The unqualified resource name. Should follow the `^[A-Za-z0-9_.~+%-]+$` regex format.
requestId: string, Optional. Idempotent request UUID.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": 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.
"error": { # 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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"metadata": { # 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # 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}`.
"response": { # The normal, successful response of the operation. 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, force=None, requestId=None, x__xgafv=None)</code>
<pre>Deletes a QueuedResource TPU instance.
Args:
name: string, Required. The resource name. (required)
force: boolean, Optional. If set to true, all running nodes belonging to this queued resource will be deleted first and then the queued resource will be deleted. Otherwise (i.e. force=false), the queued resource will only be deleted if its nodes have already been deleted or the queued resource is in the ACCEPTED, FAILED, or SUSPENDED state.
requestId: string, Optional. Idempotent request UUID.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": 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.
"error": { # 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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"metadata": { # 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # 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}`.
"response": { # The normal, successful response of the operation. 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets details of a queued resource.
Args:
name: string, Required. The resource name. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A QueuedResource represents a request for resources that will be placed in a queue and fulfilled when the necessary resources are available.
"createTime": "A String", # Output only. The time when the QueuedResource was created.
"guaranteed": { # Guaranteed tier definition. # Optional. The Guaranteed tier
"minDuration": "A String", # Optional. Defines the minimum duration of the guarantee. If specified, the requested resources will only be provisioned if they can be allocated for at least the given duration.
},
"name": "A String", # Output only. Immutable. The name of the QueuedResource.
"queueingPolicy": { # Defines the policy of the QueuedRequest. # Optional. The queueing policy of the QueuedRequest.
"validAfterDuration": "A String", # Optional. A relative time after which resources may be created.
"validAfterTime": "A String", # Optional. An absolute time after which resources may be created.
"validInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Optional. An absolute time interval within which resources may be created.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
"validUntilDuration": "A String", # Optional. A relative time after which resources should not be created. If the request cannot be fulfilled by this time the request will be failed.
"validUntilTime": "A String", # Optional. An absolute time after which resources should not be created. If the request cannot be fulfilled by this time the request will be failed.
},
"reservationName": "A String", # Optional. Name of the reservation in which the resource should be provisioned. Format: projects/{project}/locations/{zone}/reservations/{reservation}
"spot": { # Spot tier definition. # Optional. The Spot tier.
},
"state": { # QueuedResourceState defines the details of the QueuedResource request. # Output only. State of the QueuedResource request.
"acceptedData": { # Further data for the accepted state. # Output only. Further data for the accepted state.
},
"activeData": { # Further data for the active state. # Output only. Further data for the active state.
},
"creatingData": { # Further data for the creating state. # Output only. Further data for the creating state.
},
"deletingData": { # Further data for the deleting state. # Output only. Further data for the deleting state.
},
"failedData": { # Further data for the failed state. # Output only. Further data for the failed state.
"error": { # 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). # Output only. The error that caused the queued resource to enter the FAILED state.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
},
"provisioningData": { # Further data for the provisioning state. # Output only. Further data for the provisioning state.
},
"state": "A String", # Output only. State of the QueuedResource request.
"stateInitiator": "A String", # Output only. The initiator of the QueuedResources's current state. Used to indicate whether the SUSPENDING/SUSPENDED state was initiated by the user or the service.
"suspendedData": { # Further data for the suspended state. # Output only. Further data for the suspended state.
},
"suspendingData": { # Further data for the suspending state. # Output only. Further data for the suspending state.
},
},
"tpu": { # Details of the TPU resource(s) being requested. # Optional. Defines a TPU resource.
"nodeSpec": [ # Optional. The TPU node(s) being requested.
{ # Details of the TPU node(s) being requested. Users can request either a single node or multiple nodes. NodeSpec provides the specification for node(s) to be created.
"multisliceParams": { # Parameters to specify for multislice QueuedResource requests. This message must be populated in case of multislice requests instead of node_id. # Optional. Fields to specify in case of multislice request.
"nodeCount": 42, # Required. Number of nodes with this spec. The system will attempt to provision "node_count" nodes as part of the request. This needs to be > 1.
"nodeIdPrefix": "A String", # Optional. Prefix of node_ids in case of multislice request. Should follow the `^[A-Za-z0-9_.~+%-]+$` regex format. If node_count = 3 and node_id_prefix = "np", node ids of nodes created will be "np-0", "np-1", "np-2". If this field is not provided we use queued_resource_id as the node_id_prefix.
},
"node": { # A TPU instance. # Required. The node.
"acceleratorConfig": { # A TPU accelerator configuration. # The AccleratorConfig for the TPU Node.
"topology": "A String", # Required. Topology of TPU in chips.
"type": "A String", # Required. Type of TPU.
},
"acceleratorType": "A String", # Optional. The type of hardware accelerators associated with this node.
"apiVersion": "A String", # Output only. The API version that created this Node.
"cidrBlock": "A String", # 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's provided network, or the provided network is peered with another network that is using that CIDR block.
"createTime": "A String", # Output only. The time when the node was created.
"dataDisks": [ # The additional data disks for the Node.
{ # A node-attached disk resource. Next ID: 8;
"mode": "A String", # The mode in which to attach this disk. If not specified, the default is READ_WRITE mode. Only applicable to data_disks.
"sourceDisk": "A String", # Specifies the full path to an existing disk. For example: "projects/my-project/zones/us-central1-c/disks/my-disk".
},
],
"description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters.
"health": "A String", # The health status of the TPU node.
"healthDescription": "A String", # Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy.
"id": "A String", # Output only. The unique identifier for the TPU Node.
"labels": { # Resource labels to represent user-provided metadata.
"a_key": "A String",
},
"metadata": { # Custom metadata to apply to the TPU Node. Can set startup-script and shutdown-script
"a_key": "A String",
},
"multisliceNode": True or False, # Output only. Whether the Node belongs to a Multislice group.
"name": "A String", # Output only. Immutable. The name of the TPU.
"networkConfig": { # Network related configurations. # Network configurations for the TPU node. network_config and network_configs are mutually exclusive, you can only specify one of them. If both are specified, an error will be returned.
"canIpForward": True or False, # Allows the TPU node to send and receive packets with non-matching destination or source IPs. This is required if you plan to use the TPU workers to forward routes.
"enableExternalIps": True or False, # Indicates that external IP addresses would be associated with the TPU workers. If set to false, the specified subnetwork or network should have Private Google Access enabled.
"network": "A String", # The name of the network for the TPU node. It must be a preexisting Google Compute Engine network. If none is provided, "default" will be used.
"queueCount": 42, # Optional. Specifies networking queue count for TPU VM instance's network interface.
"subnetwork": "A String", # The name of the subnetwork for the TPU node. It must be a preexisting Google Compute Engine subnetwork. If none is provided, "default" will be used.
},
"networkConfigs": [ # Optional. Repeated network configurations for the TPU node. This field is used to specify multiple networks configs for the TPU node. network_config and network_configs are mutually exclusive, you can only specify one of them. If both are specified, an error will be returned.
{ # Network related configurations.
"canIpForward": True or False, # Allows the TPU node to send and receive packets with non-matching destination or source IPs. This is required if you plan to use the TPU workers to forward routes.
"enableExternalIps": True or False, # Indicates that external IP addresses would be associated with the TPU workers. If set to false, the specified subnetwork or network should have Private Google Access enabled.
"network": "A String", # The name of the network for the TPU node. It must be a preexisting Google Compute Engine network. If none is provided, "default" will be used.
"queueCount": 42, # Optional. Specifies networking queue count for TPU VM instance's network interface.
"subnetwork": "A String", # The name of the subnetwork for the TPU node. It must be a preexisting Google Compute Engine subnetwork. If none is provided, "default" will be used.
},
],
"networkEndpoints": [ # Output only. The network endpoints where TPU workers can be accessed and sent work. It is recommended that runtime clients of the node reach out to the 0th entry in this map first.
{ # A network endpoint over which a TPU worker can be reached.
"accessConfig": { # An access config attached to the TPU worker. # The access config for the TPU worker.
"externalIp": "A String", # Output only. An external IP address associated with the TPU worker.
},
"ipAddress": "A String", # The internal IP address of this network endpoint.
"port": 42, # The port of this network endpoint.
},
],
"queuedResource": "A String", # Output only. The qualified name of the QueuedResource that requested this Node.
"runtimeVersion": "A String", # Required. The runtime version running in the Node.
"schedulingConfig": { # Sets the scheduling options for this node. # The scheduling options for this node.
"preemptible": True or False, # Defines whether the node is preemptible.
"reserved": True or False, # Whether the node is created under a reservation.
"spot": True or False, # Optional. Defines whether the node is Spot VM.
},
"serviceAccount": { # A service account. # The Google Cloud Platform Service Account to be used by the TPU node VMs. If None is specified, the default compute service account will be used.
"email": "A String", # Email address of the service account. If empty, default Compute service account will be used.
"scope": [ # The list of scopes to be made available for this service account. If empty, access to all Cloud APIs will be allowed.
"A String",
],
},
"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.
"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.
},
"state": "A String", # Output only. The current state for the TPU Node.
"symptoms": [ # Output only. The Symptoms that have occurred to the TPU Node.
{ # A Symptom instance.
"createTime": "A String", # Timestamp when the Symptom is created.
"details": "A String", # Detailed information of the current Symptom.
"symptomType": "A String", # Type of the Symptom.
"workerId": "A String", # A string used to uniquely distinguish a worker within a TPU node.
},
],
"tags": [ # Tags to apply to the TPU Node. Tags are used to identify valid sources or targets for network firewalls.
"A String",
],
"upcomingMaintenance": { # Upcoming Maintenance notification information. # Output only. Upcoming maintenance on this TPU node.
"canReschedule": True or False, # Indicates if the maintenance can be customer triggered.
"latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.
"maintenanceStatus": "A String", # The status of the maintenance.
"type": "A String", # Defines the type of maintenance.
"windowEndTime": "A String", # The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.
"windowStartTime": "A String", # The current start time of the maintenance window. This timestamp value is in RFC3339 text format.
},
},
"nodeId": "A String", # Optional. The unqualified resource name. Should follow the `^[A-Za-z0-9_.~+%-]+$` regex format. This is only specified when requesting a single node. In case of multislice requests, multislice_params must be populated instead.
"parent": "A String", # Required. The parent resource name.
},
],
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists queued resources.
Args:
parent: string, Required. The parent resource name. (required)
pageSize: integer, Optional. The maximum number of items to return.
pageToken: string, Optional. The next_page_token value returned from a previous List request, if any.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for ListQueuedResources.
"nextPageToken": "A String", # The next page token or empty if none.
"queuedResources": [ # The listed queued resources.
{ # A QueuedResource represents a request for resources that will be placed in a queue and fulfilled when the necessary resources are available.
"createTime": "A String", # Output only. The time when the QueuedResource was created.
"guaranteed": { # Guaranteed tier definition. # Optional. The Guaranteed tier
"minDuration": "A String", # Optional. Defines the minimum duration of the guarantee. If specified, the requested resources will only be provisioned if they can be allocated for at least the given duration.
},
"name": "A String", # Output only. Immutable. The name of the QueuedResource.
"queueingPolicy": { # Defines the policy of the QueuedRequest. # Optional. The queueing policy of the QueuedRequest.
"validAfterDuration": "A String", # Optional. A relative time after which resources may be created.
"validAfterTime": "A String", # Optional. An absolute time after which resources may be created.
"validInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Optional. An absolute time interval within which resources may be created.
"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
"startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
},
"validUntilDuration": "A String", # Optional. A relative time after which resources should not be created. If the request cannot be fulfilled by this time the request will be failed.
"validUntilTime": "A String", # Optional. An absolute time after which resources should not be created. If the request cannot be fulfilled by this time the request will be failed.
},
"reservationName": "A String", # Optional. Name of the reservation in which the resource should be provisioned. Format: projects/{project}/locations/{zone}/reservations/{reservation}
"spot": { # Spot tier definition. # Optional. The Spot tier.
},
"state": { # QueuedResourceState defines the details of the QueuedResource request. # Output only. State of the QueuedResource request.
"acceptedData": { # Further data for the accepted state. # Output only. Further data for the accepted state.
},
"activeData": { # Further data for the active state. # Output only. Further data for the active state.
},
"creatingData": { # Further data for the creating state. # Output only. Further data for the creating state.
},
"deletingData": { # Further data for the deleting state. # Output only. Further data for the deleting state.
},
"failedData": { # Further data for the failed state. # Output only. Further data for the failed state.
"error": { # 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). # Output only. The error that caused the queued resource to enter the FAILED state.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
},
"provisioningData": { # Further data for the provisioning state. # Output only. Further data for the provisioning state.
},
"state": "A String", # Output only. State of the QueuedResource request.
"stateInitiator": "A String", # Output only. The initiator of the QueuedResources's current state. Used to indicate whether the SUSPENDING/SUSPENDED state was initiated by the user or the service.
"suspendedData": { # Further data for the suspended state. # Output only. Further data for the suspended state.
},
"suspendingData": { # Further data for the suspending state. # Output only. Further data for the suspending state.
},
},
"tpu": { # Details of the TPU resource(s) being requested. # Optional. Defines a TPU resource.
"nodeSpec": [ # Optional. The TPU node(s) being requested.
{ # Details of the TPU node(s) being requested. Users can request either a single node or multiple nodes. NodeSpec provides the specification for node(s) to be created.
"multisliceParams": { # Parameters to specify for multislice QueuedResource requests. This message must be populated in case of multislice requests instead of node_id. # Optional. Fields to specify in case of multislice request.
"nodeCount": 42, # Required. Number of nodes with this spec. The system will attempt to provision "node_count" nodes as part of the request. This needs to be > 1.
"nodeIdPrefix": "A String", # Optional. Prefix of node_ids in case of multislice request. Should follow the `^[A-Za-z0-9_.~+%-]+$` regex format. If node_count = 3 and node_id_prefix = "np", node ids of nodes created will be "np-0", "np-1", "np-2". If this field is not provided we use queued_resource_id as the node_id_prefix.
},
"node": { # A TPU instance. # Required. The node.
"acceleratorConfig": { # A TPU accelerator configuration. # The AccleratorConfig for the TPU Node.
"topology": "A String", # Required. Topology of TPU in chips.
"type": "A String", # Required. Type of TPU.
},
"acceleratorType": "A String", # Optional. The type of hardware accelerators associated with this node.
"apiVersion": "A String", # Output only. The API version that created this Node.
"cidrBlock": "A String", # 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's provided network, or the provided network is peered with another network that is using that CIDR block.
"createTime": "A String", # Output only. The time when the node was created.
"dataDisks": [ # The additional data disks for the Node.
{ # A node-attached disk resource. Next ID: 8;
"mode": "A String", # The mode in which to attach this disk. If not specified, the default is READ_WRITE mode. Only applicable to data_disks.
"sourceDisk": "A String", # Specifies the full path to an existing disk. For example: "projects/my-project/zones/us-central1-c/disks/my-disk".
},
],
"description": "A String", # The user-supplied description of the TPU. Maximum of 512 characters.
"health": "A String", # The health status of the TPU node.
"healthDescription": "A String", # Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy.
"id": "A String", # Output only. The unique identifier for the TPU Node.
"labels": { # Resource labels to represent user-provided metadata.
"a_key": "A String",
},
"metadata": { # Custom metadata to apply to the TPU Node. Can set startup-script and shutdown-script
"a_key": "A String",
},
"multisliceNode": True or False, # Output only. Whether the Node belongs to a Multislice group.
"name": "A String", # Output only. Immutable. The name of the TPU.
"networkConfig": { # Network related configurations. # Network configurations for the TPU node. network_config and network_configs are mutually exclusive, you can only specify one of them. If both are specified, an error will be returned.
"canIpForward": True or False, # Allows the TPU node to send and receive packets with non-matching destination or source IPs. This is required if you plan to use the TPU workers to forward routes.
"enableExternalIps": True or False, # Indicates that external IP addresses would be associated with the TPU workers. If set to false, the specified subnetwork or network should have Private Google Access enabled.
"network": "A String", # The name of the network for the TPU node. It must be a preexisting Google Compute Engine network. If none is provided, "default" will be used.
"queueCount": 42, # Optional. Specifies networking queue count for TPU VM instance's network interface.
"subnetwork": "A String", # The name of the subnetwork for the TPU node. It must be a preexisting Google Compute Engine subnetwork. If none is provided, "default" will be used.
},
"networkConfigs": [ # Optional. Repeated network configurations for the TPU node. This field is used to specify multiple networks configs for the TPU node. network_config and network_configs are mutually exclusive, you can only specify one of them. If both are specified, an error will be returned.
{ # Network related configurations.
"canIpForward": True or False, # Allows the TPU node to send and receive packets with non-matching destination or source IPs. This is required if you plan to use the TPU workers to forward routes.
"enableExternalIps": True or False, # Indicates that external IP addresses would be associated with the TPU workers. If set to false, the specified subnetwork or network should have Private Google Access enabled.
"network": "A String", # The name of the network for the TPU node. It must be a preexisting Google Compute Engine network. If none is provided, "default" will be used.
"queueCount": 42, # Optional. Specifies networking queue count for TPU VM instance's network interface.
"subnetwork": "A String", # The name of the subnetwork for the TPU node. It must be a preexisting Google Compute Engine subnetwork. If none is provided, "default" will be used.
},
],
"networkEndpoints": [ # Output only. The network endpoints where TPU workers can be accessed and sent work. It is recommended that runtime clients of the node reach out to the 0th entry in this map first.
{ # A network endpoint over which a TPU worker can be reached.
"accessConfig": { # An access config attached to the TPU worker. # The access config for the TPU worker.
"externalIp": "A String", # Output only. An external IP address associated with the TPU worker.
},
"ipAddress": "A String", # The internal IP address of this network endpoint.
"port": 42, # The port of this network endpoint.
},
],
"queuedResource": "A String", # Output only. The qualified name of the QueuedResource that requested this Node.
"runtimeVersion": "A String", # Required. The runtime version running in the Node.
"schedulingConfig": { # Sets the scheduling options for this node. # The scheduling options for this node.
"preemptible": True or False, # Defines whether the node is preemptible.
"reserved": True or False, # Whether the node is created under a reservation.
"spot": True or False, # Optional. Defines whether the node is Spot VM.
},
"serviceAccount": { # A service account. # The Google Cloud Platform Service Account to be used by the TPU node VMs. If None is specified, the default compute service account will be used.
"email": "A String", # Email address of the service account. If empty, default Compute service account will be used.
"scope": [ # The list of scopes to be made available for this service account. If empty, access to all Cloud APIs will be allowed.
"A String",
],
},
"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.
"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.
},
"state": "A String", # Output only. The current state for the TPU Node.
"symptoms": [ # Output only. The Symptoms that have occurred to the TPU Node.
{ # A Symptom instance.
"createTime": "A String", # Timestamp when the Symptom is created.
"details": "A String", # Detailed information of the current Symptom.
"symptomType": "A String", # Type of the Symptom.
"workerId": "A String", # A string used to uniquely distinguish a worker within a TPU node.
},
],
"tags": [ # Tags to apply to the TPU Node. Tags are used to identify valid sources or targets for network firewalls.
"A String",
],
"upcomingMaintenance": { # Upcoming Maintenance notification information. # Output only. Upcoming maintenance on this TPU node.
"canReschedule": True or False, # Indicates if the maintenance can be customer triggered.
"latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.
"maintenanceStatus": "A String", # The status of the maintenance.
"type": "A String", # Defines the type of maintenance.
"windowEndTime": "A String", # The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.
"windowStartTime": "A String", # The current start time of the maintenance window. This timestamp value is in RFC3339 text format.
},
},
"nodeId": "A String", # Optional. The unqualified resource name. Should follow the `^[A-Za-z0-9_.~+%-]+$` regex format. This is only specified when requesting a single node. In case of multislice requests, multislice_params must be populated instead.
"parent": "A String", # Required. The parent resource name.
},
],
},
},
],
"unreachable": [ # Locations that could not be reached.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="reset">reset(name, body=None, x__xgafv=None)</code>
<pre>Resets a QueuedResource TPU instance
Args:
name: string, Required. The name of the queued resource. (required)
body: object, The request body.
The object takes the form of:
{ # Request for ResetQueuedResource.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": 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.
"error": { # 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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"metadata": { # 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # 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}`.
"response": { # The normal, successful response of the operation. 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
</body></html>
|
