@maxim_mazurok/gapi.client.composer-v1 0.0.20221104 → 0.0.20221130

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 +145 -1
  2. package/package.json +1 -1
  3. package/tests.ts +33 -1
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://composer.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20221104
12
+ // Revision: 20221130
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -132,6 +132,8 @@ declare namespace gapi.client {
132
132
  nodeCount?: number;
133
133
  /** The configuration used for the Private IP Cloud Composer environment. */
134
134
  privateEnvironmentConfig?: PrivateEnvironmentConfig;
135
+ /** Optional. The Recovery settings configuration of an environment. This field is supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer. */
136
+ recoveryConfig?: RecoveryConfig;
135
137
  /** The configuration settings for software inside the environment. */
136
138
  softwareConfig?: SoftwareConfig;
137
139
  /** Optional. The configuration settings for the Airflow web server App Engine instance. */
@@ -208,6 +210,18 @@ declare namespace gapi.client {
208
210
  /** A list of operations that matches the specified filter in the request. */
209
211
  operations?: Operation[];
210
212
  }
213
+ interface LoadSnapshotRequest {
214
+ /** Whether or not to skip setting Airflow overrides when loading the environment's state. */
215
+ skipAirflowOverridesSetting?: boolean;
216
+ /** Whether or not to skip setting environment variables when loading the environment's state. */
217
+ skipEnvironmentVariablesSetting?: boolean;
218
+ /** Whether or not to skip copying Cloud Storage data when loading the environment's state. */
219
+ skipGcsDataCopying?: boolean;
220
+ /** Whether or not to skip installing Pypi packages when loading the environment's state. */
221
+ skipPypiPackagesInstallation?: boolean;
222
+ /** A Cloud Storage path to a snapshot to load, e.g.: "gs://my-bucket/snapshots/project_location_environment_timestamp". */
223
+ snapshotPath?: string;
224
+ }
211
225
  // tslint:disable-next-line:no-empty-interface
212
226
  interface LoadSnapshotResponse {
213
227
  }
@@ -377,6 +391,14 @@ declare namespace gapi.client {
377
391
  /** Output only. The IP range reserved for the tenant project's App Engine VMs. This field is supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. */
378
392
  webServerIpv4ReservedRange?: string;
379
393
  }
394
+ interface RecoveryConfig {
395
+ /** Optional. The configuration for scheduled snapshot creation mechanism. */
396
+ scheduledSnapshotsConfig?: ScheduledSnapshotsConfig;
397
+ }
398
+ interface SaveSnapshotRequest {
399
+ /** Location in a Cloud Storage where the snapshot is going to be stored, e.g.: "gs://my-bucket/snapshots". */
400
+ snapshotLocation?: string;
401
+ }
380
402
  interface SaveSnapshotResponse {
381
403
  /**
382
404
  * The fully-resolved Cloud Storage path of the created snapshot, e.g.: "gs://my-bucket/snapshots/project_location_environment_timestamp". This field is populated only if the snapshot
@@ -384,6 +406,16 @@ declare namespace gapi.client {
384
406
  */
385
407
  snapshotPath?: string;
386
408
  }
409
+ interface ScheduledSnapshotsConfig {
410
+ /** Optional. Whether scheduled snapshots creation is enabled. */
411
+ enabled?: boolean;
412
+ /** Optional. The cron expression representing the time when snapshots creation mechanism runs. This field is subject to additional validation around frequency of execution. */
413
+ snapshotCreationSchedule?: string;
414
+ /** Optional. The Cloud Storage location for storing automatically created snapshots. */
415
+ snapshotLocation?: string;
416
+ /** Optional. Time zone that sets the context to interpret snapshot_creation_schedule. */
417
+ timeZone?: string;
418
+ }
387
419
  interface SchedulerResource {
388
420
  /** Optional. The number of schedulers. */
389
421
  count?: number;
@@ -628,6 +660,62 @@ declare namespace gapi.client {
628
660
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
629
661
  uploadType?: string;
630
662
  }): Request<ListEnvironmentsResponse>;
663
+ /** Loads a snapshot of a Cloud Composer environment. As a result of this operation, a snapshot of environment's specified in LoadSnapshotRequest is loaded into the environment. */
664
+ loadSnapshot(request: {
665
+ /** V1 error format. */
666
+ "$.xgafv"?: string;
667
+ /** OAuth access token. */
668
+ access_token?: string;
669
+ /** Data format for response. */
670
+ alt?: string;
671
+ /** JSONP */
672
+ callback?: string;
673
+ /** The resource name of the target environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
674
+ environment: string;
675
+ /** Selector specifying which fields to include in a partial response. */
676
+ fields?: string;
677
+ /** 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. */
678
+ key?: string;
679
+ /** OAuth 2.0 token for the current user. */
680
+ oauth_token?: string;
681
+ /** Returns response with indentations and line breaks. */
682
+ prettyPrint?: boolean;
683
+ /** 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. */
684
+ quotaUser?: string;
685
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
686
+ upload_protocol?: string;
687
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
688
+ uploadType?: string;
689
+ /** Request body */
690
+ resource: LoadSnapshotRequest;
691
+ }): Request<Operation>;
692
+ loadSnapshot(request: {
693
+ /** V1 error format. */
694
+ "$.xgafv"?: string;
695
+ /** OAuth access token. */
696
+ access_token?: string;
697
+ /** Data format for response. */
698
+ alt?: string;
699
+ /** JSONP */
700
+ callback?: string;
701
+ /** The resource name of the target environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
702
+ environment: string;
703
+ /** Selector specifying which fields to include in a partial response. */
704
+ fields?: string;
705
+ /** 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. */
706
+ key?: string;
707
+ /** OAuth 2.0 token for the current user. */
708
+ oauth_token?: string;
709
+ /** Returns response with indentations and line breaks. */
710
+ prettyPrint?: boolean;
711
+ /** 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. */
712
+ quotaUser?: string;
713
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
714
+ upload_protocol?: string;
715
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
716
+ uploadType?: string;
717
+ },
718
+ body: LoadSnapshotRequest): Request<Operation>;
631
719
  /** Update an environment. */
632
720
  patch(request: {
633
721
  /** V1 error format. */
@@ -752,6 +840,62 @@ declare namespace gapi.client {
752
840
  uploadType?: string;
753
841
  },
754
842
  body: Environment): Request<Operation>;
843
+ /** Creates a snapshots of a Cloud Composer environment. As a result of this operation, snapshot of environment's state is stored in a location specified in the SaveSnapshotRequest. */
844
+ saveSnapshot(request: {
845
+ /** V1 error format. */
846
+ "$.xgafv"?: string;
847
+ /** OAuth access token. */
848
+ access_token?: string;
849
+ /** Data format for response. */
850
+ alt?: string;
851
+ /** JSONP */
852
+ callback?: string;
853
+ /** The resource name of the source environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
854
+ environment: string;
855
+ /** Selector specifying which fields to include in a partial response. */
856
+ fields?: string;
857
+ /** 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. */
858
+ key?: string;
859
+ /** OAuth 2.0 token for the current user. */
860
+ oauth_token?: string;
861
+ /** Returns response with indentations and line breaks. */
862
+ prettyPrint?: boolean;
863
+ /** 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. */
864
+ quotaUser?: string;
865
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
866
+ upload_protocol?: string;
867
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
868
+ uploadType?: string;
869
+ /** Request body */
870
+ resource: SaveSnapshotRequest;
871
+ }): Request<Operation>;
872
+ saveSnapshot(request: {
873
+ /** V1 error format. */
874
+ "$.xgafv"?: string;
875
+ /** OAuth access token. */
876
+ access_token?: string;
877
+ /** Data format for response. */
878
+ alt?: string;
879
+ /** JSONP */
880
+ callback?: string;
881
+ /** The resource name of the source environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
882
+ environment: string;
883
+ /** Selector specifying which fields to include in a partial response. */
884
+ fields?: string;
885
+ /** 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. */
886
+ key?: string;
887
+ /** OAuth 2.0 token for the current user. */
888
+ oauth_token?: string;
889
+ /** Returns response with indentations and line breaks. */
890
+ prettyPrint?: boolean;
891
+ /** 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. */
892
+ quotaUser?: string;
893
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
894
+ upload_protocol?: string;
895
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
896
+ uploadType?: string;
897
+ },
898
+ body: SaveSnapshotRequest): Request<Operation>;
755
899
  }
756
900
  interface ImageVersionsResource {
757
901
  /** List ImageVersions for provided location. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.composer-v1",
3
- "version": "0.0.20221104",
3
+ "version": "0.0.20221130",
4
4
  "description": "TypeScript typings for Cloud Composer API v1",
5
5
  "license": "MIT",
6
6
  "author": {
package/tests.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
4
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
5
 
6
- // Revision: 20221104
6
+ // Revision: 20221130
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -99,6 +99,14 @@ gapi.load('client', async () => {
99
99
  webServerIpv4CidrBlock: "Test string",
100
100
  webServerIpv4ReservedRange: "Test string",
101
101
  },
102
+ recoveryConfig: {
103
+ scheduledSnapshotsConfig: {
104
+ enabled: true,
105
+ snapshotCreationSchedule: "Test string",
106
+ snapshotLocation: "Test string",
107
+ timeZone: "Test string",
108
+ },
109
+ },
102
110
  softwareConfig: {
103
111
  airflowConfigOverrides: {
104
112
  A: "Test string"
@@ -168,6 +176,16 @@ gapi.load('client', async () => {
168
176
  pageToken: "Test string",
169
177
  parent: "Test string",
170
178
  });
179
+ /** Loads a snapshot of a Cloud Composer environment. As a result of this operation, a snapshot of environment's specified in LoadSnapshotRequest is loaded into the environment. */
180
+ await gapi.client.composer.projects.locations.environments.loadSnapshot({
181
+ environment: "Test string",
182
+ }, {
183
+ skipAirflowOverridesSetting: true,
184
+ skipEnvironmentVariablesSetting: true,
185
+ skipGcsDataCopying: true,
186
+ skipPypiPackagesInstallation: true,
187
+ snapshotPath: "Test string",
188
+ });
171
189
  /** Update an environment. */
172
190
  await gapi.client.composer.projects.locations.environments.patch({
173
191
  name: "Test string",
@@ -239,6 +257,14 @@ gapi.load('client', async () => {
239
257
  webServerIpv4CidrBlock: "Test string",
240
258
  webServerIpv4ReservedRange: "Test string",
241
259
  },
260
+ recoveryConfig: {
261
+ scheduledSnapshotsConfig: {
262
+ enabled: true,
263
+ snapshotCreationSchedule: "Test string",
264
+ snapshotLocation: "Test string",
265
+ timeZone: "Test string",
266
+ },
267
+ },
242
268
  softwareConfig: {
243
269
  airflowConfigOverrides: {
244
270
  A: "Test string"
@@ -294,6 +320,12 @@ gapi.load('client', async () => {
294
320
  updateTime: "Test string",
295
321
  uuid: "Test string",
296
322
  });
323
+ /** Creates a snapshots of a Cloud Composer environment. As a result of this operation, snapshot of environment's state is stored in a location specified in the SaveSnapshotRequest. */
324
+ await gapi.client.composer.projects.locations.environments.saveSnapshot({
325
+ environment: "Test string",
326
+ }, {
327
+ snapshotLocation: "Test string",
328
+ });
297
329
  /** List ImageVersions for provided location. */
298
330
  await gapi.client.composer.projects.locations.imageVersions.list({
299
331
  includePastReleases: true,