Skip to content

Commit 36420b6

Browse files
feat(tpu): update the api
#### tpu:v2alpha1 The following keys were added: - resources.projects.resources.locations.resources.queuedResources.methods.reset (Total Keys: 12) - schemas.MultiNodeParams (Total Keys: 5) - schemas.NodeSpec.properties.multiNodeParams.$ref (Total Keys: 1) - schemas.ResetQueuedResourceRequest (Total Keys: 2)
1 parent 5f84615 commit 36420b6

File tree

5 files changed

+114
-4
lines changed

5 files changed

+114
-4
lines changed

docs/dyn/tpu_v2alpha1.projects.locations.queuedResources.html

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,9 @@ <h2>Instance Methods</h2>
9292
<p class="toc_element">
9393
<code><a href="#list_next">list_next()</a></code></p>
9494
<p class="firstline">Retrieves the next page of results.</p>
95+
<p class="toc_element">
96+
<code><a href="#reset">reset(name, body=None, x__xgafv=None)</a></code></p>
97+
<p class="firstline">Resets a QueuedResource TPU instance</p>
9598
<h3>Method Details</h3>
9699
<div class="method">
97100
<code class="details" id="close">close()</code>
@@ -160,6 +163,10 @@ <h3>Method Details</h3>
160163
&quot;tpu&quot;: { # Details of the TPU resource(s) being requested. # Defines a TPU resource.
161164
&quot;nodeSpec&quot;: [ # The TPU node(s) being requested.
162165
{ # 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.
166+
&quot;multiNodeParams&quot;: { # Parameters to specify for multi-node QueuedResource requests. This field must be populated in case of multi-node requests instead of node_id. It&#x27;s an error to specify both node_id and multi_node_params. # Optional. Fields to specify in case of multi-node request.
167+
&quot;nodeCount&quot;: 42, # Required. Number of nodes with this spec. The system will attempt to provison &quot;node_count&quot; nodes as part of the request. This needs to be &gt; 1.
168+
&quot;nodeIdPrefix&quot;: &quot;A String&quot;, # Prefix of node_ids in case of multi-node request Should follow the `^[A-Za-z0-9_.~+%-]+$` regex format. If node_count = 3 and node_id_prefix = &quot;np&quot;, node ids of nodes created will be &quot;np-0&quot;, &quot;np-1&quot;, &quot;np-2&quot;. If this field is not provided we use queued_resource_id as the node_id_prefix.
169+
},
163170
&quot;node&quot;: { # A TPU instance. # Required. The node.
164171
&quot;acceleratorConfig&quot;: { # A TPU accelerator configuration. # The AccleratorConfig for the TPU Node.
165172
&quot;topology&quot;: &quot;A String&quot;, # Required. Topology of TPU in chips.
@@ -372,6 +379,10 @@ <h3>Method Details</h3>
372379
&quot;tpu&quot;: { # Details of the TPU resource(s) being requested. # Defines a TPU resource.
373380
&quot;nodeSpec&quot;: [ # The TPU node(s) being requested.
374381
{ # 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.
382+
&quot;multiNodeParams&quot;: { # Parameters to specify for multi-node QueuedResource requests. This field must be populated in case of multi-node requests instead of node_id. It&#x27;s an error to specify both node_id and multi_node_params. # Optional. Fields to specify in case of multi-node request.
383+
&quot;nodeCount&quot;: 42, # Required. Number of nodes with this spec. The system will attempt to provison &quot;node_count&quot; nodes as part of the request. This needs to be &gt; 1.
384+
&quot;nodeIdPrefix&quot;: &quot;A String&quot;, # Prefix of node_ids in case of multi-node request Should follow the `^[A-Za-z0-9_.~+%-]+$` regex format. If node_count = 3 and node_id_prefix = &quot;np&quot;, node ids of nodes created will be &quot;np-0&quot;, &quot;np-1&quot;, &quot;np-2&quot;. If this field is not provided we use queued_resource_id as the node_id_prefix.
385+
},
375386
&quot;node&quot;: { # A TPU instance. # Required. The node.
376387
&quot;acceleratorConfig&quot;: { # A TPU accelerator configuration. # The AccleratorConfig for the TPU Node.
377388
&quot;topology&quot;: &quot;A String&quot;, # Required. Topology of TPU in chips.
@@ -522,6 +533,10 @@ <h3>Method Details</h3>
522533
&quot;tpu&quot;: { # Details of the TPU resource(s) being requested. # Defines a TPU resource.
523534
&quot;nodeSpec&quot;: [ # The TPU node(s) being requested.
524535
{ # 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.
536+
&quot;multiNodeParams&quot;: { # Parameters to specify for multi-node QueuedResource requests. This field must be populated in case of multi-node requests instead of node_id. It&#x27;s an error to specify both node_id and multi_node_params. # Optional. Fields to specify in case of multi-node request.
537+
&quot;nodeCount&quot;: 42, # Required. Number of nodes with this spec. The system will attempt to provison &quot;node_count&quot; nodes as part of the request. This needs to be &gt; 1.
538+
&quot;nodeIdPrefix&quot;: &quot;A String&quot;, # Prefix of node_ids in case of multi-node request Should follow the `^[A-Za-z0-9_.~+%-]+$` regex format. If node_count = 3 and node_id_prefix = &quot;np&quot;, node ids of nodes created will be &quot;np-0&quot;, &quot;np-1&quot;, &quot;np-2&quot;. If this field is not provided we use queued_resource_id as the node_id_prefix.
539+
},
525540
&quot;node&quot;: { # A TPU instance. # Required. The node.
526541
&quot;acceleratorConfig&quot;: { # A TPU accelerator configuration. # The AccleratorConfig for the TPU Node.
527542
&quot;topology&quot;: &quot;A String&quot;, # Required. Topology of TPU in chips.
@@ -619,4 +634,45 @@ <h3>Method Details</h3>
619634
</pre>
620635
</div>
621636

637+
<div class="method">
638+
<code class="details" id="reset">reset(name, body=None, x__xgafv=None)</code>
639+
<pre>Resets a QueuedResource TPU instance
640+
641+
Args:
642+
name: string, Required. The name of the queued resource. (required)
643+
body: object, The request body.
644+
The object takes the form of:
645+
646+
{ # Request for ResetQueuedResource.
647+
}
648+
649+
x__xgafv: string, V1 error format.
650+
Allowed values
651+
1 - v1 error format
652+
2 - v2 error format
653+
654+
Returns:
655+
An object of the form:
656+
657+
{ # This resource represents a long-running operation that is the result of a network API call.
658+
&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.
659+
&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.
660+
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
661+
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
662+
{
663+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
664+
},
665+
],
666+
&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.
667+
},
668+
&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.
669+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
670+
},
671+
&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}`.
672+
&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`.
673+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
674+
},
675+
}</pre>
676+
</div>
677+
622678
</body></html>

googleapiclient/discovery_cache/documents/tpu.v1.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -659,7 +659,7 @@
659659
}
660660
}
661661
},
662-
"revision": "20230720",
662+
"revision": "20230731",
663663
"rootUrl": "https://tpu.googleapis.com/",
664664
"schemas": {
665665
"AcceleratorType": {

googleapiclient/discovery_cache/documents/tpu.v1alpha1.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -669,7 +669,7 @@
669669
}
670670
}
671671
},
672-
"revision": "20230720",
672+
"revision": "20230731",
673673
"rootUrl": "https://tpu.googleapis.com/",
674674
"schemas": {
675675
"AcceleratorType": {

googleapiclient/discovery_cache/documents/tpu.v2.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -721,7 +721,7 @@
721721
}
722722
}
723723
},
724-
"revision": "20230720",
724+
"revision": "20230731",
725725
"rootUrl": "https://tpu.googleapis.com/",
726726
"schemas": {
727727
"AcceleratorConfig": {

googleapiclient/discovery_cache/documents/tpu.v2alpha1.json

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -814,6 +814,34 @@
814814
"scopes": [
815815
"https://www.googleapis.com/auth/cloud-platform"
816816
]
817+
},
818+
"reset": {
819+
"description": "Resets a QueuedResource TPU instance",
820+
"flatPath": "v2alpha1/projects/{projectsId}/locations/{locationsId}/queuedResources/{queuedResourcesId}:reset",
821+
"httpMethod": "POST",
822+
"id": "tpu.projects.locations.queuedResources.reset",
823+
"parameterOrder": [
824+
"name"
825+
],
826+
"parameters": {
827+
"name": {
828+
"description": "Required. The name of the queued resource.",
829+
"location": "path",
830+
"pattern": "^projects/[^/]+/locations/[^/]+/queuedResources/[^/]+$",
831+
"required": true,
832+
"type": "string"
833+
}
834+
},
835+
"path": "v2alpha1/{+name}:reset",
836+
"request": {
837+
"$ref": "ResetQueuedResourceRequest"
838+
},
839+
"response": {
840+
"$ref": "Operation"
841+
},
842+
"scopes": [
843+
"https://www.googleapis.com/auth/cloud-platform"
844+
]
817845
}
818846
}
819847
},
@@ -897,7 +925,7 @@
897925
}
898926
}
899927
},
900-
"revision": "20230720",
928+
"revision": "20230731",
901929
"rootUrl": "https://tpu.googleapis.com/",
902930
"schemas": {
903931
"AcceleratorConfig": {
@@ -1333,6 +1361,22 @@
13331361
},
13341362
"type": "object"
13351363
},
1364+
"MultiNodeParams": {
1365+
"description": "Parameters to specify for multi-node QueuedResource requests. This field must be populated in case of multi-node requests instead of node_id. It's an error to specify both node_id and multi_node_params.",
1366+
"id": "MultiNodeParams",
1367+
"properties": {
1368+
"nodeCount": {
1369+
"description": "Required. Number of nodes with this spec. The system will attempt to provison \"node_count\" nodes as part of the request. This needs to be > 1.",
1370+
"format": "int32",
1371+
"type": "integer"
1372+
},
1373+
"nodeIdPrefix": {
1374+
"description": "Prefix of node_ids in case of multi-node 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.",
1375+
"type": "string"
1376+
}
1377+
},
1378+
"type": "object"
1379+
},
13361380
"NetworkConfig": {
13371381
"description": "Network related configurations.",
13381382
"id": "NetworkConfig",
@@ -1573,6 +1617,10 @@
15731617
"description": "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.",
15741618
"id": "NodeSpec",
15751619
"properties": {
1620+
"multiNodeParams": {
1621+
"$ref": "MultiNodeParams",
1622+
"description": "Optional. Fields to specify in case of multi-node request."
1623+
},
15761624
"node": {
15771625
"$ref": "Node",
15781626
"description": "Required. The node."
@@ -1818,6 +1866,12 @@
18181866
},
18191867
"type": "object"
18201868
},
1869+
"ResetQueuedResourceRequest": {
1870+
"description": "Request for ResetQueuedResource.",
1871+
"id": "ResetQueuedResourceRequest",
1872+
"properties": {},
1873+
"type": "object"
1874+
},
18211875
"RuntimeVersion": {
18221876
"description": "A runtime version that a Node can be configured with.",
18231877
"id": "RuntimeVersion",

0 commit comments

Comments
 (0)