@maxim_mazurok/gapi.client.composer-v1 0.0.20230510 → 0.0.20230516

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://composer.googleapis.com/$discovery/rest?version=v1
-// Revision: 20230510
+// Revision: 20230516
 
 /// <reference types="gapi.client" />
 
@@ -67,6 +67,12 @@ declare namespace gapi.client {
             machineType?:
                 string;
         }
+        // tslint:disable-next-line:no-empty-interface
+        interface DatabaseFailoverRequest {
+        }
+        // tslint:disable-next-line:no-empty-interface
+        interface DatabaseFailoverResponse {
+        }
         interface Date {
             /** Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. */
             day?:
@@ -173,6 +179,9 @@ declare namespace gapi.client {
             /** Optional. The Recovery settings configuration of an environment. This field is supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer. */
             recoveryConfig?:
                 RecoveryConfig;
+            /** Optional. Resilience mode of the Cloud Composer Environment. This field is supported for Cloud Composer environments in versions composer-2.2.0-airflow-*.*.* and newer. */
+            resilienceMode?:
+                string;
             /** The configuration settings for software inside the environment. */
             softwareConfig?:
                 SoftwareConfig;
@@ -189,6 +198,56 @@ declare namespace gapi.client {
             workloadsConfig?:
                 WorkloadsConfig;
         }
+        interface ExecuteAirflowCommandRequest {
+            /** Airflow command. */
+            command?:
+                string;
+            /**
+             * Parameters for the Airflow command/subcommand as an array of arguments. It may contain positional arguments like `["my-dag-id"]`, key-value parameters like `["--foo=bar"]` or
+             * `["--foo","bar"]`, or other flags like `["-f"]`.
+             */
+            parameters?:
+                string[];
+            /** Airflow subcommand. */
+            subcommand?:
+                string;
+        }
+        interface ExecuteAirflowCommandResponse {
+            /** Error message. Empty if there was no error. */
+            error?:
+                string;
+            /** The unique ID of the command execution for polling. */
+            executionId?:
+                string;
+            /** The name of the pod where the command is executed. */
+            pod?:
+                string;
+            /** The namespace of the pod where the command is executed. */
+            podNamespace?:
+                string;
+        }
+        interface ExitInfo {
+            /** Error message. Empty if there was no error. */
+            error?:
+                string;
+            /** The exit code from the command execution. */
+            exitCode?:
+                number;
+        }
+        interface FetchDatabasePropertiesResponse {
+            /**
+             * The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only fail over to the failover replica
+             * when the status is true.
+             */
+            isFailoverReplicaAvailable?:
+                boolean;
+            /** The Compute Engine zone that the instance is currently serving from. */
+            primaryGceZone?:
+                string;
+            /** The Compute Engine zone that the failover instance is currently serving from for a regional Cloud SQL instance. */
+            secondaryGceZone?:
+                string;
+        }
         interface ImageVersion {
             /** Whether it is impossible to create an environment with the image version. */
             creationDisabled?:
@@ -246,6 +305,14 @@ declare namespace gapi.client {
             useIpAliases?:
                 boolean;
         }
+        interface Line {
+            /** Text content of the log line. */
+            content?:
+                string;
+            /** Number of the line. */
+            lineNumber?:
+                number;
+        }
         interface ListEnvironmentsResponse {
             /** The list of environments returned by a ListEnvironmentsRequest. */
             environments?:
@@ -435,6 +502,31 @@ declare namespace gapi.client {
             state?:
                 string;
         }
+        interface PollAirflowCommandRequest {
+            /** The unique ID of the command execution. */
+            executionId?:
+                string;
+            /** Line number from which new logs should be fetched. */
+            nextLineNumber?:
+                number;
+            /** The name of the pod where the command is executed. */
+            pod?:
+                string;
+            /** The namespace of the pod where the command is executed. */
+            podNamespace?:
+                string;
+        }
+        interface PollAirflowCommandResponse {
+            /** The result exit status of the command. */
+            exitInfo?:
+                ExitInfo;
+            /** Output from the command execution. It may not contain the full output and the caller may need to poll for more lines. */
+            output?:
+                Line[];
+            /** Whether the command execution has finished and there is no more output. */
+            outputEnd?:
+                boolean;
+        }
         interface PrivateClusterConfig {
             /** Optional. If `true`, access to the public endpoint of the GKE cluster is denied. */
             enablePrivateEndpoint?:
@@ -604,6 +696,28 @@ declare namespace gapi.client {
             message?:
                 string;
         }
+        interface StopAirflowCommandRequest {
+            /** The unique ID of the command execution. */
+            executionId?:
+                string;
+            /** If true, the execution is terminated forcefully (SIGKILL). If false, the execution is stopped gracefully, giving it time for cleanup. */
+            force?:
+                boolean;
+            /** The name of the pod where the command is executed. */
+            pod?:
+                string;
+            /** The namespace of the pod where the command is executed. */
+            podNamespace?:
+                string;
+        }
+        interface StopAirflowCommandResponse {
+            /** Whether the execution is still running. */
+            isDone?:
+                boolean;
+            /** Output message from stopping execution request. */
+            output?:
+                string[];
+        }
         interface WebServerConfig {
             /**
              * Optional. Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. If not specified,
@@ -738,6 +852,87 @@ declare namespace gapi.client {
                     string;
             },
             body: Environment): Request<Operation>;
+            /** Triggers database failover (only for highly resilient environments). */
+            databaseFailover(request: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** Target environment: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
+                environment:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** 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. */
+                key?:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** 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. */
+                quotaUser?:
+                    string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+                /** Request body */
+                resource:
+                    DatabaseFailoverRequest;
+            }): Request<Operation>;
+            databaseFailover(request: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** Target environment: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
+                environment:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** 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. */
+                key?:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** 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. */
+                quotaUser?:
+                    string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+            },
+            body: DatabaseFailoverRequest): Request<Operation>;
             /** Delete an environment. */
             delete(request?: {
                 /** V1 error format. */
@@ -777,6 +972,126 @@ declare namespace gapi.client {
                 uploadType?:
                     string;
             }): Request<Operation>;
+            /** Executes Airflow CLI command. */
+            executeAirflowCommand(request: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}". */
+                environment:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** 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. */
+                key?:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** 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. */
+                quotaUser?:
+                    string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+                /** Request body */
+                resource:
+                    ExecuteAirflowCommandRequest;
+            }): Request<ExecuteAirflowCommandResponse>;
+            executeAirflowCommand(request: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}". */
+                environment:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** 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. */
+                key?:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** 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. */
+                quotaUser?:
+                    string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+            },
+            body: ExecuteAirflowCommandRequest): Request<ExecuteAirflowCommandResponse>;
+            /** Fetches database properties. */
+            fetchDatabaseProperties(request?: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** Required. The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
+                environment:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** 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. */
+                key?:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** 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. */
+                quotaUser?:
+                    string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+            }): Request<FetchDatabasePropertiesResponse>;
             /** Get an existing environment. */
             get(request?: {
                 /** V1 error format. */
@@ -1093,6 +1408,87 @@ declare namespace gapi.client {
                     string;
             },
             body: Environment): Request<Operation>;
+            /** Polls Airflow CLI command execution and fetches logs. */
+            pollAirflowCommand(request: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
+                environment:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** 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. */
+                key?:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** 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. */
+                quotaUser?:
+                    string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+                /** Request body */
+                resource:
+                    PollAirflowCommandRequest;
+            }): Request<PollAirflowCommandResponse>;
+            pollAirflowCommand(request: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" */
+                environment:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** 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. */
+                key?:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** 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. */
+                quotaUser?:
+                    string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+            },
+            body: PollAirflowCommandRequest): Request<PollAirflowCommandResponse>;
             /** 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. */
             saveSnapshot(request: {
                 /** V1 error format. */
@@ -1174,6 +1570,87 @@ declare namespace gapi.client {
                     string;
             },
             body: SaveSnapshotRequest): Request<Operation>;
+            /** Stops Airflow CLI command execution. */
+            stopAirflowCommand(request: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}". */
+                environment:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** 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. */
+                key?:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** 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. */
+                quotaUser?:
+                    string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+                /** Request body */
+                resource:
+                    StopAirflowCommandRequest;
+            }): Request<StopAirflowCommandResponse>;
+            stopAirflowCommand(request: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}". */
+                environment:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** 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. */
+                key?:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** 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. */
+                quotaUser?:
+                    string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+            },
+            body: StopAirflowCommandRequest): Request<StopAirflowCommandResponse>;
         }
         interface ImageVersionsResource {
             /** List ImageVersions for provided location. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.composer-v1",
-  "version": "0.0.20230510",
+  "version": "0.0.20230516",
   "description": "TypeScript typings for Cloud Composer API v1",
   "license": "MIT",
   "author": {

package/tests.ts

@@ -3,7 +3,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 
-// Revision: 20230510
+// Revision: 20230516
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -108,6 +108,7 @@ gapi.load('client', async () => {
                         timeZone: "Test string",
                     },
                 },
+                resilienceMode: "Test string",
                 softwareConfig: {
                     airflowConfigOverrides: {
                         A: "Test string"
@@ -163,10 +164,29 @@ gapi.load('client', async () => {
             updateTime: "Test string",
             uuid: "Test string",
         });
+        /** Triggers database failover (only for highly resilient environments). */
+        await gapi.client.composer.projects.locations.environments.databaseFailover({
+            environment: "Test string",
+        }, {
+        });
         /** Delete an environment. */
         await gapi.client.composer.projects.locations.environments.delete({
             name: "Test string",
         });
+        /** Executes Airflow CLI command. */
+        await gapi.client.composer.projects.locations.environments.executeAirflowCommand({
+            environment: "Test string",
+        }, {
+            command: "Test string",
+            parameters: [
+                "Test string"
+            ],
+            subcommand: "Test string",
+        });
+        /** Fetches database properties. */
+        await gapi.client.composer.projects.locations.environments.fetchDatabaseProperties({
+            environment: "Test string",
+        });
         /** Get an existing environment. */
         await gapi.client.composer.projects.locations.environments.get({
             name: "Test string",
@@ -267,6 +287,7 @@ gapi.load('client', async () => {
                         timeZone: "Test string",
                     },
                 },
+                resilienceMode: "Test string",
                 softwareConfig: {
                     airflowConfigOverrides: {
                         A: "Test string"
@@ -322,12 +343,30 @@ gapi.load('client', async () => {
             updateTime: "Test string",
             uuid: "Test string",
         });
+        /** Polls Airflow CLI command execution and fetches logs. */
+        await gapi.client.composer.projects.locations.environments.pollAirflowCommand({
+            environment: "Test string",
+        }, {
+            executionId: "Test string",
+            nextLineNumber: 42,
+            pod: "Test string",
+            podNamespace: "Test string",
+        });
         /** 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. */
         await gapi.client.composer.projects.locations.environments.saveSnapshot({
             environment: "Test string",
         }, {
             snapshotLocation: "Test string",
         });
+        /** Stops Airflow CLI command execution. */
+        await gapi.client.composer.projects.locations.environments.stopAirflowCommand({
+            environment: "Test string",
+        }, {
+            executionId: "Test string",
+            force: true,
+            pod: "Test string",
+            podNamespace: "Test string",
+        });
         /** List ImageVersions for provided location. */
         await gapi.client.composer.projects.locations.imageVersions.list({
             includePastReleases: true,