@maxim_mazurok/gapi.client.sqladmin-v1 0.0.20250129 → 0.0.20250205

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://sqladmin.googleapis.com/$discovery/rest?version=v1
-// Revision: 20250129
+// Revision: 20250205
 
 /// <reference types="gapi.client" />
 
@@ -64,6 +64,48 @@ declare namespace gapi.client {
       /** The database version name. For MySQL 8.0, this string provides the database major and minor version. */
       name?: string;
     }
+    interface Backup {
+      /** Output only. This output contains the following values: start_time: All database writes up to this time are available. end_time: Any database writes after this time aren't available. */
+      backupInterval?: Interval;
+      /** Output only. Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT. */
+      backupKind?: string;
+      /** Output only. The mapping to backup run resource used for IAM validations. */
+      backupRun?: string;
+      /** The description of this backup. */
+      description?: string;
+      /** Output only. Information about why the backup operation fails (for example, when the backup state fails). */
+      error?: OperationError;
+      /** Backup expiration time. A UTC timestamp of when this backup expired. */
+      expiryTime?: string;
+      /** The name of the source database instance. */
+      instance?: string;
+      /** Output only. This is always `sql#backup`. */
+      kind?: string;
+      /** Output only. This output contains the encryption configuration for a backup and the resource name of the KMS key for disk encryption. */
+      kmsKey?: string;
+      /** Output only. This output contains the encryption status for a backup and the version of the KMS key that's used to encrypt the Cloud SQL instance. */
+      kmsKeyVersion?: string;
+      /** The storage location of the backups. The location can be multi-regional. */
+      location?: string;
+      /** Output only. The maximum chargeable bytes for the backup. */
+      maxChargeableBytes?: string;
+      /** Output only. The resource name of the backup. Format: projects/{project}/backups/{backup} */
+      name?: string;
+      /** Output only. This status indicates whether the backup satisfies PZI. The status is reserved for future use. */
+      satisfiesPzi?: boolean;
+      /** Output only. This status indicates whether the backup satisfies PZS. The status is reserved for future use. */
+      satisfiesPzs?: boolean;
+      /** Output only. The URI of this resource. */
+      selfLink?: string;
+      /** Output only. The status of this backup. */
+      state?: string;
+      /** Output only. This output contains a backup time zone. If a Cloud SQL for SQL Server instance has a different time zone from the backup's time zone, then restores to the instance won't happen. */
+      timeZone?: string;
+      /** Input only. The time-to-live (TTL) interval for this resource (in days). For example: ttlDays:7 means 7 days. */
+      ttlDays?: string;
+      /** Output only. The type of this backup. The type can be "AUTOMATED", "ON_DEMAND" or “FINAL”. */
+      type?: string;
+    }
     interface BackupConfiguration {
       /** Backup retention settings. */
       backupRetentionSettings?: BackupRetentionSettings;
@@ -91,6 +133,8 @@ declare namespace gapi.client {
       backupId?: string;
       /** This is always `sql#backupContext`. */
       kind?: string;
+      /** The name of the backup. Format: projects/{project}/backups/{backup} */
+      name?: string;
     }
     interface BackupReencryptionConfig {
       /** Backup re-encryption limit */
@@ -259,6 +303,8 @@ declare namespace gapi.client {
       gceZone?: string;
       /** Gemini instance configuration. */
       geminiConfig?: GeminiInstanceConfig;
+      /** Input only. Determines whether an in-place major version upgrade of replicas happens when an in-place major version upgrade of a primary instance is initiated. */
+      includeReplicasForMajorVersionUpgrade?: boolean;
       /** The instance type. */
       instanceType?: string;
       /** The assigned IP addresses for the instance. */
@@ -456,6 +502,17 @@ declare namespace gapi.client {
         /** Optional. The number of threads to use for parallel export. */
         threads?: number;
       };
+      /** Optional. Export parameters specific to SQL Server TDE certificates */
+      tdeExportOptions?: {
+        /** Required. Path to the TDE certificate public key in the form gs://bucketName/fileName. The instance must have write access to the bucket. Applicable only for SQL Server instances. */
+        certificatePath?: string;
+        /** Required. Certificate name. Applicable only for SQL Server instances. */
+        name?: string;
+        /** Required. Password that encrypts the private key. */
+        privateKeyPassword?: string;
+        /** Required. Path to the TDE certificate private key in the form gs://bucketName/fileName. The instance must have write access to the location. Applicable only for SQL Server instances. */
+        privateKeyPath?: string;
+      };
       /** The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form `gs://bucketName/fileName`. If the file already exists, the request succeeds, but the operation fails. If `fileType` is `SQL` and the filename ends with .gz, the contents are compressed. */
       uri?: string;
     }
@@ -533,6 +590,8 @@ declare namespace gapi.client {
         encryptionOptions?: {
           /** Path to the Certificate (.cer) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file. */
           certPath?: string;
+          /** Optional. Whether the imported file remains encrypted. */
+          keepEncrypted?: boolean;
           /** Password that encrypts the private key */
           pvkPassword?: string;
           /** Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file. */
@@ -586,6 +645,17 @@ declare namespace gapi.client {
         /** Optional. The number of threads to use for parallel import. */
         threads?: number;
       };
+      /** Optional. Import parameters specific to SQL Server TDE certificates */
+      tdeImportOptions?: {
+        /** Required. Path to the TDE certificate public key in the form gs://bucketName/fileName. The instance must have read access to the file. Applicable only for SQL Server instances. */
+        certificatePath?: string;
+        /** Required. Certificate name. Applicable only for SQL Server instances. */
+        name?: string;
+        /** Required. Password that encrypts the private key. */
+        privateKeyPassword?: string;
+        /** Required. Path to the TDE certificate private key in the form gs://bucketName/fileName. The instance must have read access to the file. Applicable only for SQL Server instances. */
+        privateKeyPath?: string;
+      };
       /** Path to the import file in Cloud Storage, in the form `gs://bucketName/fileName`. Compressed gzip files (.gz) are supported when `fileType` is `SQL`. The instance must have write permissions to the bucket and read access to the file. */
       uri?: string;
     }
@@ -669,8 +739,12 @@ declare namespace gapi.client {
       backupReencryptionConfig?: BackupReencryptionConfig;
     }
     interface InstancesRestoreBackupRequest {
+      /** The name of the backup that's used to restore a Cloud SQL instance: Format: projects/{project-id}/backups/{backup-uid}. Only one of restore_backup_context, backup, backupdr_backup can be passed to the input. */
+      backup?: string;
       /** Parameters required to perform the restore backup operation. */
       restoreBackupContext?: RestoreBackupContext;
+      /** Optional. By using this parameter, Cloud SQL overrides the instance settings existed at time of backup with the instance settings that you want to restore. You can't change the Instance's major database version and you can only increase the disk size. You can use this field to restore new instances only. */
+      restoreInstanceSettings?: DatabaseInstance;
     }
     interface InstancesRotateServerCaRequest {
       /** Contains details about the rotate server CA operation. */
@@ -684,6 +758,12 @@ declare namespace gapi.client {
       /** Contains details about the truncate log operation. */
       truncateLogContext?: TruncateLogContext;
     }
+    interface Interval {
+      /** Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. */
+      endTime?: string;
+      /** Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. */
+      startTime?: string;
+    }
     interface IpConfiguration {
       /** The name of the allocated ip range for the private ip Cloud SQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with [RFC 1035](https://tools.ietf.org/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?.` */
       allocatedIpRange?: string;
@@ -716,6 +796,14 @@ declare namespace gapi.client {
       /** The type of this IP address. A `PRIMARY` address is a public address that can accept incoming connections. A `PRIVATE` address is a private address that can accept incoming connections. An `OUTGOING` address is the source address of connections originating from the instance, if supported. */
       type?: string;
     }
+    interface ListBackupsResponse {
+      /** A list of backups. */
+      backups?: Backup[];
+      /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, then there aren't subsequent pages. */
+      nextPageToken?: string;
+      /** If a region isn't unavailable or if an unknown error occurs, then a warning message is returned. */
+      warnings?: ApiWarning[];
+    }
     interface LocationPreference {
       /** The App Engine application to follow, it must be in the same region as the Cloud SQL instance. WARNING: Changing this might restart the instance. */
       followGaeApplication?: string;
@@ -1434,6 +1522,215 @@ declare namespace gapi.client {
         uploadType?: string;
       }): Request<BackupRunsListResponse>;
     }
+    interface BackupsResource {
+      /** Creates a backup for a Cloud SQL instance. This API can be used only to create on-demand backups. */
+      CreateBackup(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: 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;
+        /** Required. The parent resource where this backup is created. Format: projects/{project} */
+        parent: 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: Backup;
+      }): Request<Operation>;
+      CreateBackup(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** JSONP */
+          callback?: 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;
+          /** Required. The parent resource where this backup is created. Format: projects/{project} */
+          parent: 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: Backup,
+      ): Request<Operation>;
+      /** Deletes the backup. */
+      DeleteBackup(request?: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: 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;
+        /** Required. The name of the backup to delete. Format: projects/{project}/backups/{backup} */
+        name: 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<Operation>;
+      /** Retrieves a resource containing information about a backup. */
+      GetBackup(request?: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: 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;
+        /** Required. The name of the backup to retrieve. Format: projects/{project}/backups/{backup} */
+        name: 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<Backup>;
+      /** Lists all backups associated with the project. */
+      ListBackups(request?: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** Multiple filter queries are separated by spaces. For example, 'instance:abc type:FINAL. You can filter by type, instance name, creation time or location. */
+        filter?: 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;
+        /** The maximum number of backups to return per response. The service might return fewer backups than this value. If a value for this parameter isn't specified, then, at most, 500 backups are returned. The maximum value is 2,000. Any values that you set, which are greater than 2,000, are changed to 2,000. */
+        pageSize?: number;
+        /** A page token, received from a previous `ListBackups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBackups` must match the call that provided the page token. */
+        pageToken?: string;
+        /** Required. The parent that owns this collection of backups. Format: projects/{project} */
+        parent: 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<ListBackupsResponse>;
+      /** Updates the retention period and description of the backup. You can use this API to update final backups only. */
+      UpdateBackup(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: 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;
+        /** Output only. The resource name of the backup. Format: projects/{project}/backups/{backup} */
+        name: 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;
+        /** The list of fields that you can update. You can update only the description and retention period of the final backup. */
+        updateMask?: 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: Backup;
+      }): Request<Operation>;
+      UpdateBackup(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** JSONP */
+          callback?: 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;
+          /** Output only. The resource name of the backup. Format: projects/{project}/backups/{backup} */
+          name: 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;
+          /** The list of fields that you can update. You can update only the description and retention period of the final backup. */
+          updateMask?: string;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: Backup,
+      ): Request<Operation>;
+    }
     interface ConnectResource {
       /** Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database. */
       generateEphemeralCert(request: {
@@ -2038,8 +2335,16 @@ declare namespace gapi.client {
         alt?: string;
         /** JSONP */
         callback?: string;
+        /** Flag to opt-in for final backup. By default, it is turned off. */
+        enableFinalBackup?: boolean;
         /** Selector specifying which fields to include in a partial response. */
         fields?: string;
+        /** Optional. The description of the final backup. */
+        finalBackupDescription?: string;
+        /** Optional. Final Backup expiration time. Timestamp in UTC of when this resource is considered expired. */
+        finalBackupExpiryTime?: string;
+        /** Optional. Retention period of the final backup. */
+        finalBackupTtlDays?: string;
         /** Cloud SQL instance ID. This does not include the project ID. */
         instance: 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. */
@@ -4129,6 +4434,8 @@ declare namespace gapi.client {
       ): Request<Operation>;
     }
 
+    const Backups: BackupsResource;
+
     const backupRuns: BackupRunsResource;
 
     const connect: ConnectResource;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.sqladmin-v1",
-  "version": "0.0.20250129",
+  "version": "0.0.20250205",
   "description": "TypeScript typings for Cloud SQL Admin API v1",
   "repository": {
     "type": "git",

package/readme.md

@@ -106,6 +106,31 @@ await gapi.client.sql.backupRuns.list({
   project: 'project',
 });
 
+/*
+Creates a backup for a Cloud SQL instance. This API can be used only to create on-demand backups.
+*/
+await gapi.client.sql.Backups.CreateBackup({parent: 'parent'});
+
+/*
+Deletes the backup.
+*/
+await gapi.client.sql.Backups.DeleteBackup({name: 'name'});
+
+/*
+Retrieves a resource containing information about a backup.
+*/
+await gapi.client.sql.Backups.GetBackup({name: 'name'});
+
+/*
+Lists all backups associated with the project.
+*/
+await gapi.client.sql.Backups.ListBackups({parent: 'parent'});
+
+/*
+Updates the retention period and description of the backup. You can use this API to update final backups only.
+*/
+await gapi.client.sql.Backups.UpdateBackup({name: 'name'});
+
 /*
 Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.
 */