@googleapis/tpu 9.0.0 → 11.0.1

package/v2alpha1.ts

@@ -220,6 +220,10 @@ export namespace tpu_v2alpha1 {
      * Optional. Image from which boot disk is to be created. If not specified, the default image for the runtime version will be used. Example: `projects/$PROJECT_ID/global/images/$IMAGE_NAME`.
      */
     sourceImage?: string | null;
+    /**
+     * Optional. The storage pool in which the boot disk is created. You can provide this as a partial or full URL to the resource.
+     */
+    storagePool?: string | null;
   }
   /**
    * Further data for the creating state.
@@ -286,6 +290,15 @@ export namespace tpu_v2alpha1 {
      */
     guestAttributes?: Schema$GuestAttributes[];
   }
+  /**
+   * Response for GetMaintenanceInfo.
+   */
+  export interface Schema$GetMaintenanceInfoResponse {
+    /**
+     * The list of upcoming maintenance entries.
+     */
+    nodeUpcomingMaintenances?: Schema$NodeUpcomingMaintenanceInfo[];
+  }
   /**
    * Guaranteed tier definition.
    */
@@ -410,6 +423,10 @@ export namespace tpu_v2alpha1 {
      * A list of operations that matches the specified filter in the request.
      */
     operations?: Schema$Operation[];
+    /**
+     * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+     */
+    unreachable?: string[] | null;
   }
   /**
    * Response for ListQueuedResources.
@@ -680,6 +697,23 @@ export namespace tpu_v2alpha1 {
      */
     parent?: string | null;
   }
+  /**
+   * A tuple containing node name / ID and maintenance info.
+   */
+  export interface Schema$NodeUpcomingMaintenanceInfo {
+    /**
+     * Unqualified node name.
+     */
+    nodeName?: string | null;
+    /**
+     * UID of this node.
+     */
+    nodeUid?: string | null;
+    /**
+     * Upcoming maintenance info for this node.
+     */
+    upcomingMaintenance?: Schema$UpcomingMaintenance;
+  }
   /**
    * This resource represents a long-running operation that is the result of a network API call.
    */
@@ -1476,7 +1510,7 @@ export namespace tpu_v2alpha1 {
      *
      *   // Do the magic
      *   const res = await tpu.projects.locations.list({
-     *     // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.
+     *     // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.
      *     extraLocationTypes: 'placeholder-value',
      *     // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
      *     filter: 'placeholder-value',
@@ -1594,8 +1628,7 @@ export namespace tpu_v2alpha1 {
     }
   }
 
-  export interface Params$Resource$Projects$Locations$Generateserviceidentity
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Generateserviceidentity extends StandardParameters {
     /**
      * Required. The parent resource name.
      */
@@ -1606,17 +1639,15 @@ export namespace tpu_v2alpha1 {
      */
     requestBody?: Schema$GenerateServiceIdentityRequest;
   }
-  export interface Params$Resource$Projects$Locations$Get
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Get extends StandardParameters {
     /**
      * Resource name for the location.
      */
     name?: string;
   }
-  export interface Params$Resource$Projects$Locations$List
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$List extends StandardParameters {
     /**
-     * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.
+     * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.
      */
     extraLocationTypes?: string[];
     /**
@@ -1933,15 +1964,13 @@ export namespace tpu_v2alpha1 {
     }
   }
 
-  export interface Params$Resource$Projects$Locations$Acceleratortypes$Get
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Acceleratortypes$Get extends StandardParameters {
     /**
      * Required. The resource name.
      */
     name?: string;
   }
-  export interface Params$Resource$Projects$Locations$Acceleratortypes$List
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Acceleratortypes$List extends StandardParameters {
     /**
      * List filter.
      */
@@ -3514,8 +3543,7 @@ export namespace tpu_v2alpha1 {
     }
   }
 
-  export interface Params$Resource$Projects$Locations$Nodes$Create
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Nodes$Create extends StandardParameters {
     /**
      * The unqualified resource name.
      */
@@ -3534,8 +3562,7 @@ export namespace tpu_v2alpha1 {
      */
     requestBody?: Schema$Node;
   }
-  export interface Params$Resource$Projects$Locations$Nodes$Delete
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Nodes$Delete extends StandardParameters {
     /**
      * Required. The resource name.
      */
@@ -3545,15 +3572,13 @@ export namespace tpu_v2alpha1 {
      */
     requestId?: string;
   }
-  export interface Params$Resource$Projects$Locations$Nodes$Get
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Nodes$Get extends StandardParameters {
     /**
      * Required. The resource name.
      */
     name?: string;
   }
-  export interface Params$Resource$Projects$Locations$Nodes$Getguestattributes
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Nodes$Getguestattributes extends StandardParameters {
     /**
      * Required. The resource name.
      */
@@ -3564,8 +3589,7 @@ export namespace tpu_v2alpha1 {
      */
     requestBody?: Schema$GetGuestAttributesRequest;
   }
-  export interface Params$Resource$Projects$Locations$Nodes$List
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Nodes$List extends StandardParameters {
     /**
      * The maximum number of items to return.
      */
@@ -3579,8 +3603,7 @@ export namespace tpu_v2alpha1 {
      */
     parent?: string;
   }
-  export interface Params$Resource$Projects$Locations$Nodes$Patch
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Nodes$Patch extends StandardParameters {
     /**
      * Output only. Immutable. The name of the TPU.
      */
@@ -3595,8 +3618,7 @@ export namespace tpu_v2alpha1 {
      */
     requestBody?: Schema$Node;
   }
-  export interface Params$Resource$Projects$Locations$Nodes$Performmaintenance
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Nodes$Performmaintenance extends StandardParameters {
     /**
      * Required. The resource name.
      */
@@ -3607,8 +3629,7 @@ export namespace tpu_v2alpha1 {
      */
     requestBody?: Schema$PerformMaintenanceRequest;
   }
-  export interface Params$Resource$Projects$Locations$Nodes$Simulatemaintenanceevent
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Nodes$Simulatemaintenanceevent extends StandardParameters {
     /**
      * Required. The resource name.
      */
@@ -3619,8 +3640,7 @@ export namespace tpu_v2alpha1 {
      */
     requestBody?: Schema$SimulateMaintenanceEventRequest;
   }
-  export interface Params$Resource$Projects$Locations$Nodes$Start
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Nodes$Start extends StandardParameters {
     /**
      * Required. The resource name.
      */
@@ -3631,8 +3651,7 @@ export namespace tpu_v2alpha1 {
      */
     requestBody?: Schema$StartNodeRequest;
   }
-  export interface Params$Resource$Projects$Locations$Nodes$Stop
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Nodes$Stop extends StandardParameters {
     /**
      * Required. The resource name.
      */
@@ -4094,13 +4113,16 @@ export namespace tpu_v2alpha1 {
      *     pageSize: 'placeholder-value',
      *     // The standard list page token.
      *     pageToken: 'placeholder-value',
+     *     // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+     *     returnPartialSuccess: 'placeholder-value',
      *   });
      *   console.log(res.data);
      *
      *   // Example response
      *   // {
      *   //   "nextPageToken": "my_nextPageToken",
-     *   //   "operations": []
+     *   //   "operations": [],
+     *   //   "unreachable": []
      *   // }
      * }
      *
@@ -4202,29 +4224,25 @@ export namespace tpu_v2alpha1 {
     }
   }
 
-  export interface Params$Resource$Projects$Locations$Operations$Cancel
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Operations$Cancel extends StandardParameters {
     /**
      * The name of the operation resource to be cancelled.
      */
     name?: string;
   }
-  export interface Params$Resource$Projects$Locations$Operations$Delete
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Operations$Delete extends StandardParameters {
     /**
      * The name of the operation resource to be deleted.
      */
     name?: string;
   }
-  export interface Params$Resource$Projects$Locations$Operations$Get
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Operations$Get extends StandardParameters {
     /**
      * The name of the operation resource.
      */
     name?: string;
   }
-  export interface Params$Resource$Projects$Locations$Operations$List
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Operations$List extends StandardParameters {
     /**
      * The standard list filter.
      */
@@ -4241,6 +4259,10 @@ export namespace tpu_v2alpha1 {
      * The standard list page token.
      */
     pageToken?: string;
+    /**
+     * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+     */
+    returnPartialSuccess?: boolean;
   }
 
   export class Resource$Projects$Locations$Queuedresources {
@@ -4700,6 +4722,148 @@ export namespace tpu_v2alpha1 {
       }
     }
 
+    /**
+     * Gets the maintenance info for a queued resource.
+     * @example
+     * ```js
+     * // Before running the sample:
+     * // - Enable the API at:
+     * //   https://console.developers.google.com/apis/api/tpu.googleapis.com
+     * // - Login into gcloud by running:
+     * //   ```sh
+     * //   $ gcloud auth application-default login
+     * //   ```
+     * // - Install the npm module by running:
+     * //   ```sh
+     * //   $ npm install googleapis
+     * //   ```
+     *
+     * const {google} = require('googleapis');
+     * const tpu = google.tpu('v2alpha1');
+     *
+     * async function main() {
+     *   const auth = new google.auth.GoogleAuth({
+     *     // Scopes can be specified either as an array or as a single, space-delimited string.
+     *     scopes: ['https://www.googleapis.com/auth/cloud-platform'],
+     *   });
+     *
+     *   // Acquire an auth client, and bind it to all future calls
+     *   const authClient = await auth.getClient();
+     *   google.options({auth: authClient});
+     *
+     *   // Do the magic
+     *   const res = await tpu.projects.locations.queuedResources.getMaintenanceInfo({
+     *     // Required. The QueuedResource name.
+     *     name: 'projects/my-project/locations/my-location/queuedResources/my-queuedResource',
+     *   });
+     *   console.log(res.data);
+     *
+     *   // Example response
+     *   // {
+     *   //   "nodeUpcomingMaintenances": []
+     *   // }
+     * }
+     *
+     * main().catch(e => {
+     *   console.error(e);
+     *   throw e;
+     * });
+     *
+     * ```
+     *
+     * @param params - Parameters for request
+     * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
+     * @param callback - Optional callback that handles the response.
+     * @returns A promise if used with async/await, or void if used with a callback.
+     */
+    getMaintenanceInfo(
+      params: Params$Resource$Projects$Locations$Queuedresources$Getmaintenanceinfo,
+      options: StreamMethodOptions
+    ): Promise<GaxiosResponseWithHTTP2<Readable>>;
+    getMaintenanceInfo(
+      params?: Params$Resource$Projects$Locations$Queuedresources$Getmaintenanceinfo,
+      options?: MethodOptions
+    ): Promise<GaxiosResponseWithHTTP2<Schema$GetMaintenanceInfoResponse>>;
+    getMaintenanceInfo(
+      params: Params$Resource$Projects$Locations$Queuedresources$Getmaintenanceinfo,
+      options: StreamMethodOptions | BodyResponseCallback<Readable>,
+      callback: BodyResponseCallback<Readable>
+    ): void;
+    getMaintenanceInfo(
+      params: Params$Resource$Projects$Locations$Queuedresources$Getmaintenanceinfo,
+      options:
+        | MethodOptions
+        | BodyResponseCallback<Schema$GetMaintenanceInfoResponse>,
+      callback: BodyResponseCallback<Schema$GetMaintenanceInfoResponse>
+    ): void;
+    getMaintenanceInfo(
+      params: Params$Resource$Projects$Locations$Queuedresources$Getmaintenanceinfo,
+      callback: BodyResponseCallback<Schema$GetMaintenanceInfoResponse>
+    ): void;
+    getMaintenanceInfo(
+      callback: BodyResponseCallback<Schema$GetMaintenanceInfoResponse>
+    ): void;
+    getMaintenanceInfo(
+      paramsOrCallback?:
+        | Params$Resource$Projects$Locations$Queuedresources$Getmaintenanceinfo
+        | BodyResponseCallback<Schema$GetMaintenanceInfoResponse>
+        | BodyResponseCallback<Readable>,
+      optionsOrCallback?:
+        | MethodOptions
+        | StreamMethodOptions
+        | BodyResponseCallback<Schema$GetMaintenanceInfoResponse>
+        | BodyResponseCallback<Readable>,
+      callback?:
+        | BodyResponseCallback<Schema$GetMaintenanceInfoResponse>
+        | BodyResponseCallback<Readable>
+    ):
+      | void
+      | Promise<GaxiosResponseWithHTTP2<Schema$GetMaintenanceInfoResponse>>
+      | Promise<GaxiosResponseWithHTTP2<Readable>> {
+      let params = (paramsOrCallback ||
+        {}) as Params$Resource$Projects$Locations$Queuedresources$Getmaintenanceinfo;
+      let options = (optionsOrCallback || {}) as MethodOptions;
+
+      if (typeof paramsOrCallback === 'function') {
+        callback = paramsOrCallback;
+        params =
+          {} as Params$Resource$Projects$Locations$Queuedresources$Getmaintenanceinfo;
+        options = {};
+      }
+
+      if (typeof optionsOrCallback === 'function') {
+        callback = optionsOrCallback;
+        options = {};
+      }
+
+      const rootUrl = options.rootUrl || 'https://tpu.googleapis.com/';
+      const parameters = {
+        options: Object.assign(
+          {
+            url: (rootUrl + '/v2alpha1/{+name}:getMaintenanceInfo').replace(
+              /([^:]\/)\/+/g,
+              '$1'
+            ),
+            method: 'GET',
+            apiVersion: '',
+          },
+          options
+        ),
+        params,
+        requiredParams: ['name'],
+        pathParams: ['name'],
+        context: this.context,
+      };
+      if (callback) {
+        createAPIRequest<Schema$GetMaintenanceInfoResponse>(
+          parameters,
+          callback as BodyResponseCallback<unknown>
+        );
+      } else {
+        return createAPIRequest<Schema$GetMaintenanceInfoResponse>(parameters);
+      }
+    }
+
     /**
      * Lists queued resources.
      * @example
@@ -5149,8 +5313,7 @@ export namespace tpu_v2alpha1 {
     }
   }
 
-  export interface Params$Resource$Projects$Locations$Queuedresources$Create
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Queuedresources$Create extends StandardParameters {
     /**
      * Required. The parent resource name.
      */
@@ -5169,8 +5332,7 @@ export namespace tpu_v2alpha1 {
      */
     requestBody?: Schema$QueuedResource;
   }
-  export interface Params$Resource$Projects$Locations$Queuedresources$Delete
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Queuedresources$Delete extends StandardParameters {
     /**
      * 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.
      */
@@ -5184,15 +5346,19 @@ export namespace tpu_v2alpha1 {
      */
     requestId?: string;
   }
-  export interface Params$Resource$Projects$Locations$Queuedresources$Get
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Queuedresources$Get extends StandardParameters {
     /**
      * Required. The resource name.
      */
     name?: string;
   }
-  export interface Params$Resource$Projects$Locations$Queuedresources$List
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Queuedresources$Getmaintenanceinfo extends StandardParameters {
+    /**
+     * Required. The QueuedResource name.
+     */
+    name?: string;
+  }
+  export interface Params$Resource$Projects$Locations$Queuedresources$List extends StandardParameters {
     /**
      * The maximum number of items to return.
      */
@@ -5206,8 +5372,7 @@ export namespace tpu_v2alpha1 {
      */
     parent?: string;
   }
-  export interface Params$Resource$Projects$Locations$Queuedresources$Performmaintenancequeuedresource
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Queuedresources$Performmaintenancequeuedresource extends StandardParameters {
     /**
      * Required. The name of the QueuedResource which holds the nodes to perform maintenance on.
      */
@@ -5218,8 +5383,7 @@ export namespace tpu_v2alpha1 {
      */
     requestBody?: Schema$PerformMaintenanceQueuedResourceRequest;
   }
-  export interface Params$Resource$Projects$Locations$Queuedresources$Reset
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Queuedresources$Reset extends StandardParameters {
     /**
      * Required. The name of the queued resource.
      */
@@ -5382,8 +5546,7 @@ export namespace tpu_v2alpha1 {
     }
   }
 
-  export interface Params$Resource$Projects$Locations$Reservations$List
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Reservations$List extends StandardParameters {
     /**
      * The maximum number of items to return. Defaults to 0 if not specified, which means no limit.
      */
@@ -5691,15 +5854,13 @@ export namespace tpu_v2alpha1 {
     }
   }
 
-  export interface Params$Resource$Projects$Locations$Runtimeversions$Get
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Runtimeversions$Get extends StandardParameters {
     /**
      * Required. The resource name.
      */
     name?: string;
   }
-  export interface Params$Resource$Projects$Locations$Runtimeversions$List
-    extends StandardParameters {
+  export interface Params$Resource$Projects$Locations$Runtimeversions$List extends StandardParameters {
     /**
      * List filter.
      */