@googleapis/sqladmin 4.0.1 → 6.0.0

package/v1beta4.ts

@@ -308,7 +308,11 @@ export namespace sqladmin_v1beta4 {
      */
     status?: string | null;
     /**
-     * The type of this run; can be either "AUTOMATED" or "ON_DEMAND". This field defaults to "ON_DEMAND" and is ignored, when specified for insert requests.
+     * Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server.
+     */
+    timeZone?: string | null;
+    /**
+     * The type of this run; can be either "AUTOMATED" or "ON_DEMAND" or "FINAL". This field defaults to "ON_DEMAND" and is ignored, when specified for insert requests.
      */
     type?: string | null;
     /**
@@ -355,13 +359,17 @@ export namespace sqladmin_v1beta4 {
    */
   export interface Schema$CloneContext {
     /**
-     * The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the cloned 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])?. Reserved for future use.
+     * The name of the allocated ip range for the private ip Cloud SQL instance. For example: "google-managed-services-default". If set, the cloned 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])?. Reserved for future use.
      */
     allocatedIpRange?: string | null;
     /**
      * Binary log coordinates, if specified, identify the position up to which the source instance is cloned. If not specified, the source instance is cloned up to the most recent binary log coordinates.
      */
     binLogCoordinates?: Schema$BinLogCoordinates;
+    /**
+     * (SQL Server only) Clone only the specified databases from the source instance. Clone all databases if empty.
+     */
+    databaseNames?: string[] | null;
     /**
      * Name of the Cloud SQL instance to be created as a clone.
      */
@@ -568,7 +576,7 @@ export namespace sqladmin_v1beta4 {
      */
     replicaNames?: string[] | null;
     /**
-     * Initial root password. Use only on creation.
+     * Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.
      */
     rootPassword?: string | null;
     /**
@@ -735,6 +743,7 @@ export namespace sqladmin_v1beta4 {
    * Database instance export context.
    */
   export interface Schema$ExportContext {
+    bakExportOptions?: {stripeCount?: number; striped?: boolean} | null;
     /**
      * Options for exporting data as CSV. `MySQL` and `PostgreSQL` instances only.
      */
@@ -888,6 +897,7 @@ export namespace sqladmin_v1beta4 {
         pvkPassword?: string;
         pvkPath?: string;
       };
+      striped?: boolean;
     } | null;
     /**
      * Options for importing data as CSV.
@@ -1075,13 +1085,17 @@ export namespace sqladmin_v1beta4 {
    */
   export interface Schema$IpConfiguration {
     /**
-     * The name of the allocated ip range for the private ip CloudSQL 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])?.`
+     * 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 | null;
     /**
      * The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: `157.197.200.0/24`).
      */
     authorizedNetworks?: Schema$AclEntry[];
+    /**
+     * Controls connectivity to private IP instances from Google services, such as BigQuery.
+     */
+    enablePrivatePathForGoogleCloudServices?: boolean | null;
     /**
      * Whether the instance is assigned a public IP address or not.
      */
@@ -1497,6 +1511,10 @@ export namespace sqladmin_v1beta4 {
      * The name of server Instance collation.
      */
     collation?: string | null;
+    /**
+     * Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors) Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance.
+     */
+    connectorEnforcement?: string | null;
     /**
      * Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
      */
@@ -1517,6 +1535,10 @@ export namespace sqladmin_v1beta4 {
      * The type of data disk: `PD_SSD` (default) or `PD_HDD`. Not used for First Generation instances.
      */
     dataDiskType?: string | null;
+    /**
+     * Configuration to protect against accidental instance deletion.
+     */
+    deletionProtectionEnabled?: boolean | null;
     /**
      * Deny maintenance periods
      */
@@ -1573,6 +1595,10 @@ export namespace sqladmin_v1beta4 {
      * The tier (or machine type) for this instance, for example `db-custom-1-3840`. WARNING: Changing this restarts the instance.
      */
     tier?: string | null;
+    /**
+     * Server timezone, relevant only for Cloud SQL for SQL Server.
+     */
+    timeZone?: string | null;
     /**
      * User-provided labels, represented as a dictionary where each label is a single key value pair.
      */
@@ -1922,6 +1948,10 @@ export namespace sqladmin_v1beta4 {
    * A Cloud SQL user resource.
    */
   export interface Schema$User {
+    /**
+     * Dual password status for the user.
+     */
+    dualPasswordType?: string | null;
     /**
      * This field is deprecated and will be removed from a future version of the API.
      */
@@ -1972,6 +2002,10 @@ export namespace sqladmin_v1beta4 {
      * If true, failed login attempts check will be enabled.
      */
     enableFailedAttemptsCheck?: boolean | null;
+    /**
+     * If true, the user must specify the current password before changing the password. This flag is supported only for MySQL.
+     */
+    enablePasswordVerification?: boolean | null;
     /**
      * Expiration duration after password is updated.
      */
@@ -2211,6 +2245,7 @@ export namespace sqladmin_v1beta4 {
      *   //   "selfLink": "my_selfLink",
      *   //   "startTime": "my_startTime",
      *   //   "status": "my_status",
+     *   //   "timeZone": "my_timeZone",
      *   //   "type": "my_type",
      *   //   "windowStartTime": "my_windowStartTime"
      *   // }
@@ -2359,6 +2394,7 @@ export namespace sqladmin_v1beta4 {
      *       //   "selfLink": "my_selfLink",
      *       //   "startTime": "my_startTime",
      *       //   "status": "my_status",
+     *       //   "timeZone": "my_timeZone",
      *       //   "type": "my_type",
      *       //   "windowStartTime": "my_windowStartTime"
      *       // }
@@ -5915,7 +5951,7 @@ export namespace sqladmin_v1beta4 {
     }
 
     /**
-     * Updates settings of a Cloud SQL instance. This method supports patch semantics.
+     * Partially updates settings of a Cloud SQL instance by merging the request with the current configuration. This method supports patch semantics.
      * @example
      * ```js
      * // Before running the sample:
@@ -9775,6 +9811,153 @@ export namespace sqladmin_v1beta4 {
       }
     }
 
+    /**
+     * Retrieves a resource containing information about a user.
+     * @example
+     * ```js
+     * // Before running the sample:
+     * // - Enable the API at:
+     * //   https://console.developers.google.com/apis/api/sqladmin.googleapis.com
+     * // - Login into gcloud by running:
+     * //   `$ gcloud auth application-default login`
+     * // - Install the npm module by running:
+     * //   `$ npm install googleapis`
+     *
+     * const {google} = require('googleapis');
+     * const sqladmin = google.sqladmin('v1beta4');
+     *
+     * async function main() {
+     *   const auth = new google.auth.GoogleAuth({
+     *     // Scopes can be specified either as an array or as a single, space-delimited string.
+     *     scopes: [
+     *       'https://www.googleapis.com/auth/cloud-platform',
+     *       'https://www.googleapis.com/auth/sqlservice.admin',
+     *     ],
+     *   });
+     *
+     *   // Acquire an auth client, and bind it to all future calls
+     *   const authClient = await auth.getClient();
+     *   google.options({auth: authClient});
+     *
+     *   // Do the magic
+     *   const res = await sql.users.get({
+     *     // Host of a user of the instance.
+     *     host: 'placeholder-value',
+     *     // Database instance ID. This does not include the project ID.
+     *     instance: 'placeholder-value',
+     *     // User of the instance.
+     *     name: 'placeholder-value',
+     *     // Project ID of the project that contains the instance.
+     *     project: 'placeholder-value',
+     *   });
+     *   console.log(res.data);
+     *
+     *   // Example response
+     *   // {
+     *   //   "dualPasswordType": "my_dualPasswordType",
+     *   //   "etag": "my_etag",
+     *   //   "host": "my_host",
+     *   //   "instance": "my_instance",
+     *   //   "kind": "my_kind",
+     *   //   "name": "my_name",
+     *   //   "password": "my_password",
+     *   //   "passwordPolicy": {},
+     *   //   "project": "my_project",
+     *   //   "sqlserverUserDetails": {},
+     *   //   "type": "my_type"
+     *   // }
+     * }
+     *
+     * main().catch(e => {
+     *   console.error(e);
+     *   throw e;
+     * });
+     *
+     * ```
+     *
+     * @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.
+     */
+    get(
+      params: Params$Resource$Users$Get,
+      options: StreamMethodOptions
+    ): GaxiosPromise<Readable>;
+    get(
+      params?: Params$Resource$Users$Get,
+      options?: MethodOptions
+    ): GaxiosPromise<Schema$User>;
+    get(
+      params: Params$Resource$Users$Get,
+      options: StreamMethodOptions | BodyResponseCallback<Readable>,
+      callback: BodyResponseCallback<Readable>
+    ): void;
+    get(
+      params: Params$Resource$Users$Get,
+      options: MethodOptions | BodyResponseCallback<Schema$User>,
+      callback: BodyResponseCallback<Schema$User>
+    ): void;
+    get(
+      params: Params$Resource$Users$Get,
+      callback: BodyResponseCallback<Schema$User>
+    ): void;
+    get(callback: BodyResponseCallback<Schema$User>): void;
+    get(
+      paramsOrCallback?:
+        | Params$Resource$Users$Get
+        | BodyResponseCallback<Schema$User>
+        | BodyResponseCallback<Readable>,
+      optionsOrCallback?:
+        | MethodOptions
+        | StreamMethodOptions
+        | BodyResponseCallback<Schema$User>
+        | BodyResponseCallback<Readable>,
+      callback?:
+        | BodyResponseCallback<Schema$User>
+        | BodyResponseCallback<Readable>
+    ): void | GaxiosPromise<Schema$User> | GaxiosPromise<Readable> {
+      let params = (paramsOrCallback || {}) as Params$Resource$Users$Get;
+      let options = (optionsOrCallback || {}) as MethodOptions;
+
+      if (typeof paramsOrCallback === 'function') {
+        callback = paramsOrCallback;
+        params = {} as Params$Resource$Users$Get;
+        options = {};
+      }
+
+      if (typeof optionsOrCallback === 'function') {
+        callback = optionsOrCallback;
+        options = {};
+      }
+
+      const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/';
+      const parameters = {
+        options: Object.assign(
+          {
+            url: (
+              rootUrl +
+              '/sql/v1beta4/projects/{project}/instances/{instance}/users/{name}'
+            ).replace(/([^:]\/)\/+/g, '$1'),
+            method: 'GET',
+          },
+          options
+        ),
+        params,
+        requiredParams: ['project', 'instance', 'name'],
+        pathParams: ['instance', 'name', 'project'],
+        context: this.context,
+      };
+      if (callback) {
+        createAPIRequest<Schema$User>(
+          parameters,
+          callback as BodyResponseCallback<unknown>
+        );
+      } else {
+        return createAPIRequest<Schema$User>(parameters);
+      }
+    }
+
     /**
      * Creates a new user in a Cloud SQL instance.
      * @example
@@ -9814,6 +9997,7 @@ export namespace sqladmin_v1beta4 {
      *     requestBody: {
      *       // request body parameters
      *       // {
+     *       //   "dualPasswordType": "my_dualPasswordType",
      *       //   "etag": "my_etag",
      *       //   "host": "my_host",
      *       //   "instance": "my_instance",
@@ -10121,6 +10305,7 @@ export namespace sqladmin_v1beta4 {
      *     requestBody: {
      *       // request body parameters
      *       // {
+     *       //   "dualPasswordType": "my_dualPasswordType",
      *       //   "etag": "my_etag",
      *       //   "host": "my_host",
      *       //   "instance": "my_instance",
@@ -10266,6 +10451,24 @@ export namespace sqladmin_v1beta4 {
      */
     project?: string;
   }
+  export interface Params$Resource$Users$Get extends StandardParameters {
+    /**
+     * Host of a user of the instance.
+     */
+    host?: string;
+    /**
+     * Database instance ID. This does not include the project ID.
+     */
+    instance?: string;
+    /**
+     * User of the instance.
+     */
+    name?: string;
+    /**
+     * Project ID of the project that contains the instance.
+     */
+    project?: string;
+  }
   export interface Params$Resource$Users$Insert extends StandardParameters {
     /**
      * Database instance ID. This does not include the project ID.