Skip to content

Commit 0b9b482

Browse files
feat(tpu): update the api
#### tpu:v2alpha1 The following keys were added: - resources.projects.resources.locations.resources.nodes.methods.performMaintenance (Total Keys: 12) - resources.projects.resources.locations.resources.queuedResources.methods.performMaintenanceQueuedResource (Total Keys: 12) - schemas.Node.properties.upcomingMaintenance (Total Keys: 2) - schemas.PerformMaintenanceQueuedResourceRequest (Total Keys: 4) - schemas.PerformMaintenanceRequest (Total Keys: 2) - schemas.UpcomingMaintenance (Total Keys: 8)
1 parent 5f01e66 commit 0b9b482

File tree

3 files changed

+284
-3
lines changed

3 files changed

+284
-3
lines changed

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

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,9 @@ <h2>Instance Methods</h2>
9898
<p class="toc_element">
9999
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
100100
<p class="firstline">Updates the configurations of a node.</p>
101+
<p class="toc_element">
102+
<code><a href="#performMaintenance">performMaintenance(name, body=None, x__xgafv=None)</a></code></p>
103+
<p class="firstline">Perform manual maintenance on a node.</p>
101104
<p class="toc_element">
102105
<code><a href="#simulateMaintenanceEvent">simulateMaintenanceEvent(name, body=None, x__xgafv=None)</a></code></p>
103106
<p class="firstline">Simulates a maintenance event.</p>
@@ -209,6 +212,14 @@ <h3>Method Details</h3>
209212
&quot;tags&quot;: [ # Tags to apply to the TPU Node. Tags are used to identify valid sources or targets for network firewalls.
210213
&quot;A String&quot;,
211214
],
215+
&quot;upcomingMaintenance&quot;: { # Upcoming Maintenance notification information. # Output only. Upcoming maintenance on this TPU node.
216+
&quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
217+
&quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.
218+
&quot;maintenanceStatus&quot;: &quot;A String&quot;, # The status of the maintenance.
219+
&quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
220+
&quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.
221+
&quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window. This timestamp value is in RFC3339 text format.
222+
},
212223
}
213224

214225
nodeId: string, The unqualified resource name.
@@ -379,6 +390,14 @@ <h3>Method Details</h3>
379390
&quot;tags&quot;: [ # Tags to apply to the TPU Node. Tags are used to identify valid sources or targets for network firewalls.
380391
&quot;A String&quot;,
381392
],
393+
&quot;upcomingMaintenance&quot;: { # Upcoming Maintenance notification information. # Output only. Upcoming maintenance on this TPU node.
394+
&quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
395+
&quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.
396+
&quot;maintenanceStatus&quot;: &quot;A String&quot;, # The status of the maintenance.
397+
&quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
398+
&quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.
399+
&quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window. This timestamp value is in RFC3339 text format.
400+
},
382401
}</pre>
383402
</div>
384403

@@ -530,6 +549,14 @@ <h3>Method Details</h3>
530549
&quot;tags&quot;: [ # Tags to apply to the TPU Node. Tags are used to identify valid sources or targets for network firewalls.
531550
&quot;A String&quot;,
532551
],
552+
&quot;upcomingMaintenance&quot;: { # Upcoming Maintenance notification information. # Output only. Upcoming maintenance on this TPU node.
553+
&quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
554+
&quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.
555+
&quot;maintenanceStatus&quot;: &quot;A String&quot;, # The status of the maintenance.
556+
&quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
557+
&quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.
558+
&quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window. This timestamp value is in RFC3339 text format.
559+
},
533560
},
534561
],
535562
&quot;unreachable&quot;: [ # Locations that could not be reached.
@@ -648,6 +675,14 @@ <h3>Method Details</h3>
648675
&quot;tags&quot;: [ # Tags to apply to the TPU Node. Tags are used to identify valid sources or targets for network firewalls.
649676
&quot;A String&quot;,
650677
],
678+
&quot;upcomingMaintenance&quot;: { # Upcoming Maintenance notification information. # Output only. Upcoming maintenance on this TPU node.
679+
&quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
680+
&quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.
681+
&quot;maintenanceStatus&quot;: &quot;A String&quot;, # The status of the maintenance.
682+
&quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
683+
&quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.
684+
&quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window. This timestamp value is in RFC3339 text format.
685+
},
651686
}
652687

653688
updateMask: string, Required. Mask of fields from Node to update. Supported fields: [description, tags, labels, metadata, network_config.enable_external_ips].
@@ -680,6 +715,47 @@ <h3>Method Details</h3>
680715
}</pre>
681716
</div>
682717

718+
<div class="method">
719+
<code class="details" id="performMaintenance">performMaintenance(name, body=None, x__xgafv=None)</code>
720+
<pre>Perform manual maintenance on a node.
721+
722+
Args:
723+
name: string, Required. The resource name. (required)
724+
body: object, The request body.
725+
The object takes the form of:
726+
727+
{ # Request for PerformMaintenance.
728+
}
729+
730+
x__xgafv: string, V1 error format.
731+
Allowed values
732+
1 - v1 error format
733+
2 - v2 error format
734+
735+
Returns:
736+
An object of the form:
737+
738+
{ # This resource represents a long-running operation that is the result of a network API call.
739+
&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.
740+
&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.
741+
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
742+
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
743+
{
744+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
745+
},
746+
],
747+
&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.
748+
},
749+
&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.
750+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
751+
},
752+
&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}`.
753+
&quot;response&quot;: { # 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`.
754+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
755+
},
756+
}</pre>
757+
</div>
758+
683759
<div class="method">
684760
<code class="details" id="simulateMaintenanceEvent">simulateMaintenanceEvent(name, body=None, x__xgafv=None)</code>
685761
<pre>Simulates a maintenance event.

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

Lines changed: 71 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="#performMaintenanceQueuedResource">performMaintenanceQueuedResource(name, body=None, x__xgafv=None)</a></code></p>
97+
<p class="firstline">Perform manual maintenance on specific nodes of a QueuedResource.</p>
9598
<p class="toc_element">
9699
<code><a href="#reset">reset(name, body=None, x__xgafv=None)</a></code></p>
97100
<p class="firstline">Resets a QueuedResource TPU instance</p>
@@ -256,6 +259,14 @@ <h3>Method Details</h3>
256259
&quot;tags&quot;: [ # Tags to apply to the TPU Node. Tags are used to identify valid sources or targets for network firewalls.
257260
&quot;A String&quot;,
258261
],
262+
&quot;upcomingMaintenance&quot;: { # Upcoming Maintenance notification information. # Output only. Upcoming maintenance on this TPU node.
263+
&quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
264+
&quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.
265+
&quot;maintenanceStatus&quot;: &quot;A String&quot;, # The status of the maintenance.
266+
&quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
267+
&quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.
268+
&quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window. This timestamp value is in RFC3339 text format.
269+
},
259270
},
260271
&quot;nodeId&quot;: &quot;A String&quot;, # 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 multi-node requests, multi_node_params must be populated instead. It&#x27;s an error to specify both node_id and multi_node_params.
261272
&quot;parent&quot;: &quot;A String&quot;, # Required. The parent resource name.
@@ -492,6 +503,14 @@ <h3>Method Details</h3>
492503
&quot;tags&quot;: [ # Tags to apply to the TPU Node. Tags are used to identify valid sources or targets for network firewalls.
493504
&quot;A String&quot;,
494505
],
506+
&quot;upcomingMaintenance&quot;: { # Upcoming Maintenance notification information. # Output only. Upcoming maintenance on this TPU node.
507+
&quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
508+
&quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.
509+
&quot;maintenanceStatus&quot;: &quot;A String&quot;, # The status of the maintenance.
510+
&quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
511+
&quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.
512+
&quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window. This timestamp value is in RFC3339 text format.
513+
},
495514
},
496515
&quot;nodeId&quot;: &quot;A String&quot;, # 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 multi-node requests, multi_node_params must be populated instead. It&#x27;s an error to specify both node_id and multi_node_params.
497516
&quot;parent&quot;: &quot;A String&quot;, # Required. The parent resource name.
@@ -666,6 +685,14 @@ <h3>Method Details</h3>
666685
&quot;tags&quot;: [ # Tags to apply to the TPU Node. Tags are used to identify valid sources or targets for network firewalls.
667686
&quot;A String&quot;,
668687
],
688+
&quot;upcomingMaintenance&quot;: { # Upcoming Maintenance notification information. # Output only. Upcoming maintenance on this TPU node.
689+
&quot;canReschedule&quot;: True or False, # Indicates if the maintenance can be customer triggered.
690+
&quot;latestWindowStartTime&quot;: &quot;A String&quot;, # The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.
691+
&quot;maintenanceStatus&quot;: &quot;A String&quot;, # The status of the maintenance.
692+
&quot;type&quot;: &quot;A String&quot;, # Defines the type of maintenance.
693+
&quot;windowEndTime&quot;: &quot;A String&quot;, # The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.
694+
&quot;windowStartTime&quot;: &quot;A String&quot;, # The current start time of the maintenance window. This timestamp value is in RFC3339 text format.
695+
},
669696
},
670697
&quot;nodeId&quot;: &quot;A String&quot;, # 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 multi-node requests, multi_node_params must be populated instead. It&#x27;s an error to specify both node_id and multi_node_params.
671698
&quot;parent&quot;: &quot;A String&quot;, # Required. The parent resource name.
@@ -694,6 +721,50 @@ <h3>Method Details</h3>
694721
</pre>
695722
</div>
696723

724+
<div class="method">
725+
<code class="details" id="performMaintenanceQueuedResource">performMaintenanceQueuedResource(name, body=None, x__xgafv=None)</code>
726+
<pre>Perform manual maintenance on specific nodes of a QueuedResource.
727+
728+
Args:
729+
name: string, Required. The name of the QueuedResource which holds the nodes to perform maintenance on. (required)
730+
body: object, The request body.
731+
The object takes the form of:
732+
733+
{ # Request for PerformMaintenanceQueuedResource.
734+
&quot;nodeNames&quot;: [ # The names of the nodes to perform maintenance on.
735+
&quot;A String&quot;,
736+
],
737+
}
738+
739+
x__xgafv: string, V1 error format.
740+
Allowed values
741+
1 - v1 error format
742+
2 - v2 error format
743+
744+
Returns:
745+
An object of the form:
746+
747+
{ # This resource represents a long-running operation that is the result of a network API call.
748+
&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.
749+
&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.
750+
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
751+
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
752+
{
753+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
754+
},
755+
],
756+
&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.
757+
},
758+
&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.
759+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
760+
},
761+
&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}`.
762+
&quot;response&quot;: { # 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`.
763+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
764+
},
765+
}</pre>
766+
</div>
767+
697768
<div class="method">
698769
<code class="details" id="reset">reset(name, body=None, x__xgafv=None)</code>
699770
<pre>Resets a QueuedResource TPU instance

0 commit comments

Comments
 (0)