@googleapis/sqladmin 10.2.0 → 12.0.0

package/v1.ts

@@ -598,7 +598,7 @@ export namespace sqladmin_v1 {
      */
     outOfDiskReport?: Schema$SqlOutOfDiskReport;
     /**
-     * Output only. The dns name of the primary instance in a replication group.
+     * Output only. DEPRECATED: please use write_endpoint instead.
      */
     primaryDnsName?: string | null;
     /**
@@ -653,6 +653,7 @@ export namespace sqladmin_v1 {
      * The user settings.
      */
     settings?: Schema$Settings;
+    sqlNetworkArchitecture?: string | null;
     /**
      * The current serving state of the Cloud SQL instance.
      */
@@ -661,6 +662,10 @@ export namespace sqladmin_v1 {
      * If the instance state is SUSPENDED, the reason for the suspension.
      */
     suspensionReason?: string[] | null;
+    /**
+     * Output only. The dns name of the primary instance in a replication group.
+     */
+    writeEndpoint?: string | null;
   }
   /**
    * Database list response.
@@ -684,6 +689,19 @@ export namespace sqladmin_v1 {
      */
     dataCacheEnabled?: boolean | null;
   }
+  /**
+   * This context is used to demote an existing standalone instance to be a Cloud SQL read replica for an external database server.
+   */
+  export interface Schema$DemoteContext {
+    /**
+     * This is always `sql#demoteContext`.
+     */
+    kind?: string | null;
+    /**
+     * Required. The name of the instance which acts as the on-premises primary instance in the replication setup.
+     */
+    sourceRepresentativeInstanceName?: string | null;
+  }
   /**
    * Read-replica configuration for connecting to the on-premises primary instance.
    */
@@ -1064,6 +1082,15 @@ export namespace sqladmin_v1 {
      */
     demoteMasterContext?: Schema$DemoteMasterContext;
   }
+  /**
+   * This request is used to demote an existing standalone instance to be a Cloud SQL read replica for an external database server.
+   */
+  export interface Schema$InstancesDemoteRequest {
+    /**
+     * Required. Contains details about the demote operation.
+     */
+    demoteContext?: Schema$DemoteContext;
+  }
   /**
    * Database instance export request.
    */
@@ -1191,12 +1218,16 @@ export namespace sqladmin_v1 {
      */
     pscConfig?: Schema$PscConfig;
     /**
-     * Whether SSL connections over IP are enforced or not.
+     * Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the legacy `require_ssl` flag.
      */
     requireSsl?: boolean | null;
+    /**
+     * Specify how SSL/TLS is enforced in database connections. This flag is supported only for PostgreSQL. Use the legacy `require_ssl` flag for enforcing SSL/TLS in MySQL and SQL Server. But, for PostgreSQL, use the `ssl_mode` flag instead of the legacy `require_ssl` flag. To avoid the conflict between those flags in PostgreSQL, only the following value pairs are valid: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` Note that the value of `ssl_mode` gets priority over the value of the legacy `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY, require_ssl=false`, the `ssl_mode=ENCRYPTED_ONLY` means "only accepts SSL connection", while the `require_ssl=false` means "both non-SSL and SSL connections are allowed". The database respects `ssl_mode` in this case and only accepts SSL connections.
+     */
+    sslMode?: string | null;
   }
   /**
-   * Database instance IP Mapping.
+   * Database instance IP mapping
    */
   export interface Schema$IpMapping {
     /**
@@ -1357,6 +1388,10 @@ export namespace sqladmin_v1 {
    * An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
    */
   export interface Schema$Operation {
+    /**
+     * An Admin API warning message.
+     */
+    apiWarning?: Schema$ApiWarning;
     /**
      * The context for backup operation, if applicable.
      */
@@ -1520,6 +1555,10 @@ export namespace sqladmin_v1 {
      * The complexity of the password.
      */
     complexity?: string | null;
+    /**
+     * Disallow credentials that have been previously compromised by a public data breach.
+     */
+    disallowCompromisedCredentials?: boolean | null;
     /**
      * Disallow username as a part of the password.
      */
@@ -1555,7 +1594,7 @@ export namespace sqladmin_v1 {
    */
   export interface Schema$PscConfig {
     /**
-     * List of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric).
+     * Optional. The list of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric).
      */
     allowedConsumerProjects?: string[] | null;
     /**
@@ -1567,6 +1606,10 @@ export namespace sqladmin_v1 {
    * Read-replica configuration for connecting to the primary instance.
    */
   export interface Schema$ReplicaConfiguration {
+    /**
+     * Optional. Specifies if a SQL Server replica is a cascadable replica. A cascadable replica is a SQL Server cross region replica that supports replica(s) under it.
+     */
+    cascadableReplica?: boolean | null;
     /**
      * Specifies if the replica is the failover target. If the field is set to `true`, the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance.
      */
@@ -3851,6 +3894,91 @@ export namespace sqladmin_v1 {
       }
     }
 
+    /**
+     * Demotes an existing standalone instance to be a Cloud SQL read replica for an external database server.
+     *
+     * @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.
+     */
+    demote(
+      params: Params$Resource$Instances$Demote,
+      options: StreamMethodOptions
+    ): GaxiosPromise<Readable>;
+    demote(
+      params?: Params$Resource$Instances$Demote,
+      options?: MethodOptions
+    ): GaxiosPromise<Schema$Operation>;
+    demote(
+      params: Params$Resource$Instances$Demote,
+      options: StreamMethodOptions | BodyResponseCallback<Readable>,
+      callback: BodyResponseCallback<Readable>
+    ): void;
+    demote(
+      params: Params$Resource$Instances$Demote,
+      options: MethodOptions | BodyResponseCallback<Schema$Operation>,
+      callback: BodyResponseCallback<Schema$Operation>
+    ): void;
+    demote(
+      params: Params$Resource$Instances$Demote,
+      callback: BodyResponseCallback<Schema$Operation>
+    ): void;
+    demote(callback: BodyResponseCallback<Schema$Operation>): void;
+    demote(
+      paramsOrCallback?:
+        | Params$Resource$Instances$Demote
+        | BodyResponseCallback<Schema$Operation>
+        | BodyResponseCallback<Readable>,
+      optionsOrCallback?:
+        | MethodOptions
+        | StreamMethodOptions
+        | BodyResponseCallback<Schema$Operation>
+        | BodyResponseCallback<Readable>,
+      callback?:
+        | BodyResponseCallback<Schema$Operation>
+        | BodyResponseCallback<Readable>
+    ): void | GaxiosPromise<Schema$Operation> | GaxiosPromise<Readable> {
+      let params = (paramsOrCallback || {}) as Params$Resource$Instances$Demote;
+      let options = (optionsOrCallback || {}) as MethodOptions;
+
+      if (typeof paramsOrCallback === 'function') {
+        callback = paramsOrCallback;
+        params = {} as Params$Resource$Instances$Demote;
+        options = {};
+      }
+
+      if (typeof optionsOrCallback === 'function') {
+        callback = optionsOrCallback;
+        options = {};
+      }
+
+      const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/';
+      const parameters = {
+        options: Object.assign(
+          {
+            url: (
+              rootUrl + '/v1/projects/{project}/instances/{instance}/demote'
+            ).replace(/([^:]\/)\/+/g, '$1'),
+            method: 'POST',
+          },
+          options
+        ),
+        params,
+        requiredParams: ['project', 'instance'],
+        pathParams: ['instance', 'project'],
+        context: this.context,
+      };
+      if (callback) {
+        createAPIRequest<Schema$Operation>(
+          parameters,
+          callback as BodyResponseCallback<unknown>
+        );
+      } else {
+        return createAPIRequest<Schema$Operation>(parameters);
+      }
+    }
+
     /**
      * Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server.
      *
@@ -5331,6 +5459,92 @@ export namespace sqladmin_v1 {
       }
     }
 
+    /**
+     * Switches over from the primary instance to the replica instance.
+     *
+     * @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.
+     */
+    switchover(
+      params: Params$Resource$Instances$Switchover,
+      options: StreamMethodOptions
+    ): GaxiosPromise<Readable>;
+    switchover(
+      params?: Params$Resource$Instances$Switchover,
+      options?: MethodOptions
+    ): GaxiosPromise<Schema$Operation>;
+    switchover(
+      params: Params$Resource$Instances$Switchover,
+      options: StreamMethodOptions | BodyResponseCallback<Readable>,
+      callback: BodyResponseCallback<Readable>
+    ): void;
+    switchover(
+      params: Params$Resource$Instances$Switchover,
+      options: MethodOptions | BodyResponseCallback<Schema$Operation>,
+      callback: BodyResponseCallback<Schema$Operation>
+    ): void;
+    switchover(
+      params: Params$Resource$Instances$Switchover,
+      callback: BodyResponseCallback<Schema$Operation>
+    ): void;
+    switchover(callback: BodyResponseCallback<Schema$Operation>): void;
+    switchover(
+      paramsOrCallback?:
+        | Params$Resource$Instances$Switchover
+        | BodyResponseCallback<Schema$Operation>
+        | BodyResponseCallback<Readable>,
+      optionsOrCallback?:
+        | MethodOptions
+        | StreamMethodOptions
+        | BodyResponseCallback<Schema$Operation>
+        | BodyResponseCallback<Readable>,
+      callback?:
+        | BodyResponseCallback<Schema$Operation>
+        | BodyResponseCallback<Readable>
+    ): void | GaxiosPromise<Schema$Operation> | GaxiosPromise<Readable> {
+      let params = (paramsOrCallback ||
+        {}) as Params$Resource$Instances$Switchover;
+      let options = (optionsOrCallback || {}) as MethodOptions;
+
+      if (typeof paramsOrCallback === 'function') {
+        callback = paramsOrCallback;
+        params = {} as Params$Resource$Instances$Switchover;
+        options = {};
+      }
+
+      if (typeof optionsOrCallback === 'function') {
+        callback = optionsOrCallback;
+        options = {};
+      }
+
+      const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/';
+      const parameters = {
+        options: Object.assign(
+          {
+            url: (
+              rootUrl + '/v1/projects/{project}/instances/{instance}/switchover'
+            ).replace(/([^:]\/)\/+/g, '$1'),
+            method: 'POST',
+          },
+          options
+        ),
+        params,
+        requiredParams: ['project', 'instance'],
+        pathParams: ['instance', 'project'],
+        context: this.context,
+      };
+      if (callback) {
+        createAPIRequest<Schema$Operation>(
+          parameters,
+          callback as BodyResponseCallback<unknown>
+        );
+      } else {
+        return createAPIRequest<Schema$Operation>(parameters);
+      }
+    }
+
     /**
      * Truncate MySQL general and slow query log tables MySQL only.
      *
@@ -5540,6 +5754,21 @@ export namespace sqladmin_v1 {
      */
     project?: string;
   }
+  export interface Params$Resource$Instances$Demote extends StandardParameters {
+    /**
+     * Required. Cloud SQL instance name.
+     */
+    instance?: string;
+    /**
+     * Required. ID of the project that contains the instance.
+     */
+    project?: string;
+
+    /**
+     * Request body metadata
+     */
+    requestBody?: Schema$InstancesDemoteRequest;
+  }
   export interface Params$Resource$Instances$Demotemaster
     extends StandardParameters {
     /**
@@ -5669,6 +5898,10 @@ export namespace sqladmin_v1 {
   }
   export interface Params$Resource$Instances$Promotereplica
     extends StandardParameters {
+    /**
+     * Set to true if the promote operation should attempt to re-add the original primary as a replica when it comes back online. Otherwise, if this value is false or not set, the original primary will be a standalone instance.
+     */
+    failover?: boolean;
     /**
      * Cloud SQL read replica instance name.
      */
@@ -5770,6 +6003,21 @@ export namespace sqladmin_v1 {
      */
     project?: string;
   }
+  export interface Params$Resource$Instances$Switchover
+    extends StandardParameters {
+    /**
+     * Optional. (MySQL only) Cloud SQL instance operations timeout, which is a sum of all database operations. Default value is 10 minutes and can be modified to a maximum value of 24 hours.
+     */
+    dbTimeout?: string;
+    /**
+     * Cloud SQL read replica instance name.
+     */
+    instance?: string;
+    /**
+     * ID of the project that contains the replica.
+     */
+    project?: string;
+  }
   export interface Params$Resource$Instances$Truncatelog
     extends StandardParameters {
     /**