@maxim_mazurok/gapi.client.compute-alpha 0.0.20240820 → 0.0.20240827

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/index.d.ts +216 -1
  2. package/package.json +1 -1
  3. package/readme.md +20 -0
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://www.googleapis.com/discovery/v1/apis/compute/alpha/rest
12
- // Revision: 20240820
12
+ // Revision: 20240827
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -315,6 +315,8 @@ declare namespace gapi.client {
315
315
  serviceShareType?: string;
316
316
  }
317
317
  interface AllocationResourceStatus {
318
+ /** Indicates number of blocks for accelerator optimized family (applicable beyond A3 only). */
319
+ reservationBlockCount?: number;
318
320
  /** Allocation Properties of this reservation. */
319
321
  specificSkuAllocation?: AllocationResourceStatusSpecificSKUAllocation;
320
322
  }
@@ -8827,10 +8829,14 @@ declare namespace gapi.client {
8827
8829
  deleteAfterDuration?: Duration;
8828
8830
  /** Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format. */
8829
8831
  deleteAtTime?: string;
8832
+ /** Specifies the deployment strategy for this reservation. */
8833
+ deploymentType?: string;
8830
8834
  /** An optional description of this resource. Provide this property when you create the resource. */
8831
8835
  description?: string;
8832
8836
  /** [Output Only] The unique identifier for the resource. This identifier is defined by the server. */
8833
8837
  id?: string;
8838
+ /** Instance termination action that will be invoked when the reservation is deleted. */
8839
+ instanceTerminationAction?: string;
8834
8840
  /** [Output Only] Type of the resource. Always compute#reservations for reservations. */
8835
8841
  kind?: string;
8836
8842
  /** The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */
@@ -8894,6 +8900,59 @@ declare namespace gapi.client {
8894
8900
  message?: string;
8895
8901
  };
8896
8902
  }
8903
+ interface ReservationBlock {
8904
+ /** [Output Only] Specifies the number of resources that are allocated in this block. It indicates the maximum number of VMs that a user can run on this particular block. */
8905
+ count?: number;
8906
+ /** [Output Only] Creation timestamp in RFC3339 text format. */
8907
+ creationTimestamp?: string;
8908
+ /** [Output Only] The unique identifier for the resource. This identifier is defined by the server. */
8909
+ id?: string;
8910
+ /** [Output Only] Indicates how many instances are in use on this block. */
8911
+ inUseCount?: number;
8912
+ /** [Output Only] Type of the resource. Always compute#reservationBlock for reservation blocks. */
8913
+ kind?: string;
8914
+ /** [Output Only] Obfuscated location where this reservation block physically resides in format /CCCC/GGGG. This matches the tripod specified in the VM topology information. Example: /USEAB1/0101/ is the location prefix in /USEAB1/0101/031/003 */
8915
+ locationPrefix?: string;
8916
+ /** [Output Only] The name of this reservation block generated by Google Compute Engine. The name must be 1-63 characters long, and comply with RFC1035 @pattern [a-z](?:[-a-z0-9]{0,61}[a-z0-9])? */
8917
+ name?: string;
8918
+ /** [Output Only] Server-defined fully-qualified URL for this resource. */
8919
+ selfLink?: string;
8920
+ /** [Output Only] Server-defined URL for this resource with the resource id. */
8921
+ selfLinkWithId?: string;
8922
+ /** [Output Only] Status of the reservation block. */
8923
+ status?: string;
8924
+ /** [Output Only] Zone in which the reservation block resides. */
8925
+ zone?: string;
8926
+ }
8927
+ interface ReservationBlocksGetResponse {
8928
+ resource?: ReservationBlock;
8929
+ }
8930
+ interface ReservationBlocksListResponse {
8931
+ /** Unique identifier for the resource; defined by the server. */
8932
+ id?: string;
8933
+ /** A list of reservation block resources. */
8934
+ items?: ReservationBlock[];
8935
+ /** Type of the resource. Always compute#reservationBlock for a list of reservation blocks. */
8936
+ kind?: string;
8937
+ /** This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. */
8938
+ nextPageToken?: string;
8939
+ /** Server-defined URL for this resource. */
8940
+ selfLink?: string;
8941
+ /** Informational warning message. */
8942
+ warning?: {
8943
+ /** [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. */
8944
+ code?: string;
8945
+ /** [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } */
8946
+ data?: Array<{
8947
+ /** [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). */
8948
+ key?: string;
8949
+ /** [Output Only] A warning data value corresponding to the key. */
8950
+ value?: string;
8951
+ }>;
8952
+ /** [Output Only] A human-readable description of the warning code. */
8953
+ message?: string;
8954
+ };
8955
+ }
8897
8956
  interface ReservationList {
8898
8957
  /** [Output Only] The unique identifier for the resource. This identifier is defined by the server. */
8899
8958
  id?: string;
@@ -40922,6 +40981,80 @@ declare namespace gapi.client {
40922
40981
  ): Request<TestPermissionsResponse>;
40923
40982
  }
40924
40983
  interface RegionInstanceGroupManagerResizeRequestsResource {
40984
+ /** Cancels the specified resize request. Cancelled resize request no longer waits for the resources to be provisioned. Cancel is only possible for requests that are in accepted state. */
40985
+ cancel(request?: {
40986
+ /** V1 error format. */
40987
+ '$.xgafv'?: string;
40988
+ /** OAuth access token. */
40989
+ access_token?: string;
40990
+ /** Data format for response. */
40991
+ alt?: string;
40992
+ /** JSONP */
40993
+ callback?: string;
40994
+ /** Selector specifying which fields to include in a partial response. */
40995
+ fields?: string;
40996
+ /** The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. */
40997
+ instanceGroupManager: string;
40998
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
40999
+ key?: string;
41000
+ /** OAuth 2.0 token for the current user. */
41001
+ oauth_token?: string;
41002
+ /** Returns response with indentations and line breaks. */
41003
+ prettyPrint?: boolean;
41004
+ /** Project ID for this request. */
41005
+ project: string;
41006
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
41007
+ quotaUser?: string;
41008
+ /** The name of the region scoping this request. Name should conform to RFC1035. */
41009
+ region: string;
41010
+ /** An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */
41011
+ requestId?: string;
41012
+ /** The name of the resize request to cancel. Name should conform to RFC1035 or be a resource ID. */
41013
+ resizeRequest: string;
41014
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
41015
+ upload_protocol?: string;
41016
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
41017
+ uploadType?: string;
41018
+ /** Legacy name for parameter that has been superseded by `quotaUser`. */
41019
+ userIp?: string;
41020
+ }): Request<Operation>;
41021
+ /** Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously. */
41022
+ delete(request?: {
41023
+ /** V1 error format. */
41024
+ '$.xgafv'?: string;
41025
+ /** OAuth access token. */
41026
+ access_token?: string;
41027
+ /** Data format for response. */
41028
+ alt?: string;
41029
+ /** JSONP */
41030
+ callback?: string;
41031
+ /** Selector specifying which fields to include in a partial response. */
41032
+ fields?: string;
41033
+ /** The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. */
41034
+ instanceGroupManager: string;
41035
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
41036
+ key?: string;
41037
+ /** OAuth 2.0 token for the current user. */
41038
+ oauth_token?: string;
41039
+ /** Returns response with indentations and line breaks. */
41040
+ prettyPrint?: boolean;
41041
+ /** Project ID for this request. */
41042
+ project: string;
41043
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
41044
+ quotaUser?: string;
41045
+ /** The name of the region scoping this request. Name should conform to RFC1035. */
41046
+ region: string;
41047
+ /** An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). */
41048
+ requestId?: string;
41049
+ /** The name of the resize request to delete. Name should conform to RFC1035 or be a resource ID. */
41050
+ resizeRequest: string;
41051
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
41052
+ upload_protocol?: string;
41053
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
41054
+ uploadType?: string;
41055
+ /** Legacy name for parameter that has been superseded by `quotaUser`. */
41056
+ userIp?: string;
41057
+ }): Request<Operation>;
40925
41058
  /** Returns all of the details about the specified resize request. */
40926
41059
  get(request?: {
40927
41060
  /** V1 error format. */
@@ -48536,6 +48669,86 @@ declare namespace gapi.client {
48536
48669
  userIp?: string;
48537
48670
  }): Request<ZoneList>;
48538
48671
  }
48672
+ interface ReservationBlocksResource {
48673
+ /** Retrieves information about the specified reservation block. */
48674
+ get(request?: {
48675
+ /** V1 error format. */
48676
+ '$.xgafv'?: string;
48677
+ /** OAuth access token. */
48678
+ access_token?: string;
48679
+ /** Data format for response. */
48680
+ alt?: string;
48681
+ /** JSONP */
48682
+ callback?: string;
48683
+ /** Selector specifying which fields to include in a partial response. */
48684
+ fields?: string;
48685
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
48686
+ key?: string;
48687
+ /** OAuth 2.0 token for the current user. */
48688
+ oauth_token?: string;
48689
+ /** Returns response with indentations and line breaks. */
48690
+ prettyPrint?: boolean;
48691
+ /** Project ID for this request. */
48692
+ project: string;
48693
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
48694
+ quotaUser?: string;
48695
+ /** The name of the reservation. Name should conform to RFC1035 or be a resource ID. */
48696
+ reservation: string;
48697
+ /** The name of the reservation block. Name should conform to RFC1035 or be a resource ID. */
48698
+ reservationBlock: string;
48699
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
48700
+ upload_protocol?: string;
48701
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
48702
+ uploadType?: string;
48703
+ /** Legacy name for parameter that has been superseded by `quotaUser`. */
48704
+ userIp?: string;
48705
+ /** Name of the zone for this request. Zone name should conform to RFC1035. */
48706
+ zone: string;
48707
+ }): Request<ReservationBlocksGetResponse>;
48708
+ /** Retrieves a list of reservation blocks under a single reservation. */
48709
+ list(request?: {
48710
+ /** V1 error format. */
48711
+ '$.xgafv'?: string;
48712
+ /** OAuth access token. */
48713
+ access_token?: string;
48714
+ /** Data format for response. */
48715
+ alt?: string;
48716
+ /** JSONP */
48717
+ callback?: string;
48718
+ /** Selector specifying which fields to include in a partial response. */
48719
+ fields?: string;
48720
+ /** A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */
48721
+ filter?: string;
48722
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
48723
+ key?: string;
48724
+ /** The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) */
48725
+ maxResults?: number;
48726
+ /** OAuth 2.0 token for the current user. */
48727
+ oauth_token?: string;
48728
+ /** Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. */
48729
+ orderBy?: string;
48730
+ /** Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. */
48731
+ pageToken?: string;
48732
+ /** Returns response with indentations and line breaks. */
48733
+ prettyPrint?: boolean;
48734
+ /** Project ID for this request. */
48735
+ project: string;
48736
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
48737
+ quotaUser?: string;
48738
+ /** The name of the reservation. Name should conform to RFC1035 or be a resource ID. */
48739
+ reservation: string;
48740
+ /** Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. */
48741
+ returnPartialSuccess?: boolean;
48742
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
48743
+ upload_protocol?: string;
48744
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
48745
+ uploadType?: string;
48746
+ /** Legacy name for parameter that has been superseded by `quotaUser`. */
48747
+ userIp?: string;
48748
+ /** Name of the zone for this request. Zone name should conform to RFC1035. */
48749
+ zone: string;
48750
+ }): Request<ReservationBlocksListResponse>;
48751
+ }
48539
48752
  interface ReservationsResource {
48540
48753
  /** Retrieves an aggregated list of reservations. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. */
48541
48754
  aggregatedList(request?: {
@@ -59568,6 +59781,8 @@ declare namespace gapi.client {
59568
59781
 
59569
59782
  const regions: RegionsResource;
59570
59783
 
59784
+ const reservationBlocks: ReservationBlocksResource;
59785
+
59571
59786
  const reservations: ReservationsResource;
59572
59787
 
59573
59788
  const resourcePolicies: ResourcePoliciesResource;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.compute-alpha",
3
- "version": "0.0.20240820",
3
+ "version": "0.0.20240827",
4
4
  "description": "TypeScript typings for Compute Engine API alpha",
5
5
  "repository": {
6
6
  "type": "git",
package/readme.md CHANGED
@@ -2900,6 +2900,16 @@ Returns permissions that a caller has on the specified resource.
2900
2900
  */
2901
2901
  await gapi.client.compute.regionHealthCheckServices.testIamPermissions({ project: "project", region: "region", resource: "resource", });
2902
2902
 
2903
+ /*
2904
+ Cancels the specified resize request. Cancelled resize request no longer waits for the resources to be provisioned. Cancel is only possible for requests that are in accepted state.
2905
+ */
2906
+ await gapi.client.compute.regionInstanceGroupManagerResizeRequests.cancel({ instanceGroupManager: "instanceGroupManager", project: "project", region: "region", resizeRequest: "resizeRequest", });
2907
+
2908
+ /*
2909
+ Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously.
2910
+ */
2911
+ await gapi.client.compute.regionInstanceGroupManagerResizeRequests.delete({ instanceGroupManager: "instanceGroupManager", project: "project", region: "region", resizeRequest: "resizeRequest", });
2912
+
2903
2913
  /*
2904
2914
  Returns all of the details about the specified resize request.
2905
2915
  */
@@ -3645,6 +3655,16 @@ Retrieves the list of Zone resources under the specific region available to the
3645
3655
  */
3646
3656
  await gapi.client.compute.regionZones.list({ project: "project", region: "region", });
3647
3657
 
3658
+ /*
3659
+ Retrieves information about the specified reservation block.
3660
+ */
3661
+ await gapi.client.compute.reservationBlocks.get({ project: "project", reservation: "reservation", reservationBlock: "reservationBlock", zone: "zone", });
3662
+
3663
+ /*
3664
+ Retrieves a list of reservation blocks under a single reservation.
3665
+ */
3666
+ await gapi.client.compute.reservationBlocks.list({ project: "project", reservation: "reservation", zone: "zone", });
3667
+
3648
3668
  /*
3649
3669
  Retrieves an aggregated list of reservations. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
3650
3670
  */