@googleapis/alloydb 15.0.0 → 17.0.0

package/build/v1.d.ts

@@ -118,6 +118,19 @@ export declare namespace alloydb_v1 {
          */
         weeklySchedule?: Schema$WeeklySchedule;
     }
+    /**
+     * Configuration for autoscaling.
+     */
+    export interface Schema$AutoScalingConfig {
+        /**
+         * Policy for the MIG autoscaler.
+         */
+        policy?: Schema$Policy;
+        /**
+         * Optional list of schedules for the MIG autoscaler. If not set, no schedules are created.
+         */
+        schedules?: Schema$Schedule[];
+    }
     /**
      * Message describing Backup object
      */
@@ -225,6 +238,82 @@ export declare namespace alloydb_v1 {
          */
         updateTime?: string | null;
     }
+    /**
+     * Message describing a BackupDrBackupSource.
+     */
+    export interface Schema$BackupDrBackupSource {
+        /**
+         * Required. The name of the backup resource with the format: * projects/{project\}/locations/{location\}/backupVaults/{backupvault_id\}/dataSources/{datasource_id\}/backups/{backup_id\}
+         */
+        backup?: string | null;
+    }
+    /**
+     * Information about a single window when BackupDR was enabled for this cluster.
+     */
+    export interface Schema$BackupDrEnabledWindow {
+        /**
+         * Whether automated backup was previously enabled prior to enabling BackupDR protection for this cluster.
+         */
+        automatedBackupPreviouslyEnabled?: boolean | null;
+        /**
+         * The BackupPlanAssociation resource that was used to enable BackupDR protection for this cluster.
+         */
+        backupPlanAssociation?: string | null;
+        /**
+         * Whether continuous backup was previously enabled prior to enabling BackupDR protection for this cluster.
+         */
+        continuousBackupPreviouslyEnabled?: boolean | null;
+        /**
+         * The time when continuous backup was previously enabled prior to enabling BackupDR protection for this cluster.
+         */
+        continuousBackupPreviouslyEnabledTime?: string | null;
+        /**
+         * The retention set for the continuous backup that was previously enabled prior to enabling BackupDR protection for this cluster.
+         */
+        continuousBackupPreviousRecoveryWindowDays?: number | null;
+        /**
+         * The DataSource resource that represents the cluster in BackupDR.
+         */
+        dataSource?: string | null;
+        /**
+         * Time when the BackupDR protection for this cluster was disabled. This field will be empty if this BackupDR window is the `current_window`.
+         */
+        disabledTime?: string | null;
+        /**
+         * Time when the BackupDR protection for this cluster was enabled.
+         */
+        enabledTime?: string | null;
+        /**
+         * The retention period for logs generated by BackupDR for this cluster.
+         */
+        logRetentionPeriod?: string | null;
+    }
+    /**
+     * Information about BackupDR protection for this cluster.
+     */
+    export interface Schema$BackupDrInfo {
+        /**
+         * The current BackupDR configuration for this cluster. If BackupDR protection is not enabled for this cluster, this field will be empty.
+         */
+        currentWindow?: Schema$BackupDrEnabledWindow;
+        /**
+         * Windows during which BackupDR was enabled for this cluster, along with associated configuration for that window. These are used to determine points-in-time for which restores can be performed. The windows are ordered with the most recent window last. Windows are mutally exclusive. Windows which closed more than 1 year ago will be removed from this list.
+         */
+        previousWindows?: Schema$BackupDrEnabledWindow[];
+    }
+    /**
+     * Message describing a BackupDrPitrSource.
+     */
+    export interface Schema$BackupDrPitrSource {
+        /**
+         * Required. The name of the backup resource with the format: * projects/{project\}/locations/{location\}/backupVaults/{backupvault_id\}/dataSources/{datasource_id\}
+         */
+        dataSource?: string | null;
+        /**
+         * Required. The point in time to restore to.
+         */
+        pointInTime?: string | null;
+    }
     /**
      * Message describing a BackupSource.
      */
@@ -300,6 +389,14 @@ export declare namespace alloydb_v1 {
          * The automated backup policy for this cluster. If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type.
          */
         automatedBackupPolicy?: Schema$AutomatedBackupPolicy;
+        /**
+         * Output only. Cluster created from a BackupDR backup.
+         */
+        backupdrBackupSource?: Schema$BackupDrBackupSource;
+        /**
+         * Output only. Output only information about BackupDR protection for this cluster.
+         */
+        backupdrInfo?: Schema$BackupDrInfo;
         /**
          * Output only. Cluster created from backup.
          */
@@ -480,6 +577,25 @@ export declare namespace alloydb_v1 {
          */
         publicIpAddress?: string | null;
     }
+    /**
+     * Configuration for Managed Connection Pool (MCP).
+     */
+    export interface Schema$ConnectionPoolConfig {
+        /**
+         * Optional. Whether to enable Managed Connection Pool (MCP).
+         */
+        enabled?: boolean | null;
+        /**
+         * Optional. Connection Pool flags, as a list of "key": "value" pairs.
+         */
+        flags?: {
+            [key: string]: string;
+        } | null;
+        /**
+         * Output only. The number of running poolers per instance.
+         */
+        poolerCount?: number | null;
+    }
     /**
      * ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster.
      */
@@ -531,6 +647,15 @@ export declare namespace alloydb_v1 {
          */
         pointInTime?: string | null;
     }
+    /**
+     * CPU utilization policy for the autoscaler.
+     */
+    export interface Schema$CpuUtilization {
+        /**
+         * Target CPU utilization as a float between 0 and 1.
+         */
+        utilizationTarget?: number | null;
+    }
     /**
      * Options for exporting data in CSV format.
      */
@@ -826,6 +951,10 @@ export declare namespace alloydb_v1 {
          * Optional. Client connection specific configurations
          */
         clientConnectionConfig?: Schema$ClientConnectionConfig;
+        /**
+         * Optional. The configuration for Managed Connection Pool (MCP).
+         */
+        connectionPoolConfig?: Schema$ConnectionPoolConfig;
         /**
          * Output only. Create time stamp
          */
@@ -1049,6 +1178,10 @@ export declare namespace alloydb_v1 {
          * A list of operations that matches the specified filter in the request.
          */
         operations?: Schema$Operation[];
+        /**
+         * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+         */
+        unreachable?: string[] | null;
     }
     /**
      * Message for response to listing SupportedDatabaseFlags.
@@ -1282,6 +1415,27 @@ export declare namespace alloydb_v1 {
          */
         verb?: string | null;
     }
+    /**
+     * Policy for the autoscaler.
+     */
+    export interface Schema$Policy {
+        /**
+         * The period of time in seconds after a new node is created before the autoscaler will incorporate its resource usage (e.g. CPU utilization) into the autoscaling recommendation algorithm.
+         */
+        coolDownPeriodSec?: string | null;
+        /**
+         * CPU utilization policy for the autoscaler.
+         */
+        cpuUtilization?: Schema$CpuUtilization;
+        /**
+         * If true, autoscaling is enabled for the instance. If not set, the default value is false.
+         */
+        enabled?: boolean | null;
+        /**
+         * Maximum number of nodes for the autoscaler.
+         */
+        maxNodeCount?: string | null;
+    }
     /**
      * Configuration for the primary cluster. It has the list of clusters that are replicating from this cluster. This should be set if and only if the cluster is of type PRIMARY.
      */
@@ -1427,6 +1581,10 @@ export declare namespace alloydb_v1 {
      * Configuration for a read pool instance.
      */
     export interface Schema$ReadPoolConfig {
+        /**
+         * Autoscaling configuration for the read pool instance. If not set, the read pool instance will not be autoscaled.
+         */
+        autoScalingConfig?: Schema$AutoScalingConfig;
         /**
          * Read capacity, i.e. number of nodes in a read pool instance.
          */
@@ -1459,6 +1617,14 @@ export declare namespace alloydb_v1 {
      * Message for restoring a Cluster from a backup or another cluster at a given point in time. NEXT_ID: 11
      */
     export interface Schema$RestoreClusterRequest {
+        /**
+         * BackupDR backup source.
+         */
+        backupdrBackupSource?: Schema$BackupDrBackupSource;
+        /**
+         * BackupDR source used for point in time recovery.
+         */
+        backupdrPitrSource?: Schema$BackupDrPitrSource;
         /**
          * Backup source.
          */
@@ -1501,6 +1667,39 @@ export declare namespace alloydb_v1 {
          */
         clusterId?: string | null;
     }
+    /**
+     * A schedule for the autoscaler.
+     */
+    export interface Schema$Schedule {
+        /**
+         * Cron expression for the triggering the schedule. See https://cloud.google.com/compute/docs/autoscaler/scaling-schedules#cron_expressions for the syntax.
+         */
+        cronExpression?: string | null;
+        /**
+         * Description of the schedule.
+         */
+        description?: string | null;
+        /**
+         * If true, the schedule is disabled.
+         */
+        disabled?: boolean | null;
+        /**
+         * Duration of the schedule.
+         */
+        durationSec?: string | null;
+        /**
+         * Minimum number of nodes in while the schedule is active.
+         */
+        minNodeCount?: string | null;
+        /**
+         * Name of the schedule.
+         */
+        name?: string | null;
+        /**
+         * The location-based IANA time zone for interpreting the schedule's start time. If no time zone is provided, UTC is used by default.
+         */
+        timeZone?: string | null;
+    }
     /**
      * Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY.
      */
@@ -1566,27 +1765,6 @@ export declare namespace alloydb_v1 {
          */
         status?: string | null;
     }
-    /**
-     * Timing information for the stage execution.
-     */
-    export interface Schema$StageSchedule {
-        /**
-         * Actual end time of the stage. Set only if the stage has completed.
-         */
-        actualEndTime?: string | null;
-        /**
-         * Actual start time of the stage. Set only if the stage has started.
-         */
-        actualStartTime?: string | null;
-        /**
-         * When the stage is expected to end. Set only if the stage has not completed yet.
-         */
-        estimatedEndTime?: string | null;
-        /**
-         * When the stage is expected to start. Set only if the stage has not started yet.
-         */
-        estimatedStartTime?: string | null;
-    }
     /**
      * Status of an upgrade stage.
      */
@@ -1595,10 +1773,6 @@ export declare namespace alloydb_v1 {
          * Read pool instances upgrade metadata.
          */
         readPoolInstancesUpgrade?: Schema$ReadPoolInstancesUpgradeStageStatus;
-        /**
-         * Output only. Timing information for the stage execution.
-         */
-        schedule?: Schema$StageSchedule;
         /**
          * Upgrade stage.
          */
@@ -1791,7 +1965,7 @@ export declare namespace alloydb_v1 {
         internalResourceMetadata?: Schema$StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata[];
     }
     /**
-     * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 11
+     * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 13
      */
     export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed {
         /**
@@ -1802,6 +1976,10 @@ export declare namespace alloydb_v1 {
          * Config based signal data is used to ingest signals that are generated based on the configuration of the database resource.
          */
         configBasedSignalData?: Schema$StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData;
+        /**
+         * Database resource signal data is used to ingest signals from database resource signal feeds.
+         */
+        databaseResourceSignalData?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData;
         /**
          * Required. Timestamp when feed is generated.
          */
@@ -1909,7 +2087,7 @@ export declare namespace alloydb_v1 {
         uniqueId?: string | null;
     }
     /**
-     * Common model for database resource instance metadata. Next ID: 26
+     * Common model for database resource instance metadata. Next ID: 29
      */
     export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata {
         /**
@@ -1972,6 +2150,10 @@ export declare namespace alloydb_v1 {
          * Machine configuration for this resource.
          */
         machineConfiguration?: Schema$StorageDatabasecenterPartnerapiV1mainMachineConfiguration;
+        /**
+         * Optional. Maintenance info for the resource.
+         */
+        maintenanceInfo?: Schema$StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo;
         /**
          * Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional.
          */
@@ -2008,6 +2190,10 @@ export declare namespace alloydb_v1 {
          * User-provided labels associated with the resource
          */
         userLabelSet?: Schema$StorageDatabasecenterPartnerapiV1mainUserLabels;
+        /**
+         * The resource zone. This is only applicable for zonal resources and will be empty for regional and multi-regional resources.
+         */
+        zone?: string | null;
     }
     /**
      * Common model for database resource recommendation signal data.
@@ -2048,6 +2234,35 @@ export declare namespace alloydb_v1 {
          */
         signalType?: string | null;
     }
+    /**
+     * Database resource signal data. This is used to send signals to Condor which are based on the DB/Instance/Fleet level configurations. These will be used to send signals for all inventory types. Next ID: 7
+     */
+    export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData {
+        /**
+         * Required. Full Resource name of the source resource.
+         */
+        fullResourceName?: string | null;
+        /**
+         * Required. Last time signal was refreshed
+         */
+        lastRefreshTime?: string | null;
+        /**
+         * Database resource id.
+         */
+        resourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId;
+        /**
+         * Signal data for boolean signals.
+         */
+        signalBoolValue?: boolean | null;
+        /**
+         * Required. Output only. Signal state of the signal
+         */
+        signalState?: string | null;
+        /**
+         * Required. Signal type of the signal
+         */
+        signalType?: string | null;
+    }
     /**
      * Proto representing the access that a user has to a specific feature/service. NextId: 3.
      */
@@ -2150,6 +2365,57 @@ export declare namespace alloydb_v1 {
          */
         message?: string | null;
     }
+    /**
+     * Deny maintenance period for the database resource. It specifies the time range during which the maintenance cannot start. This is configured by the customer.
+     */
+    export interface Schema$StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule {
+        /**
+         * Optional. Deny period end date.
+         */
+        endDate?: Schema$GoogleTypeDate;
+        /**
+         * Optional. The start date of the deny maintenance period.
+         */
+        startDate?: Schema$GoogleTypeDate;
+        /**
+         * Optional. Time in UTC when the deny period starts on start_date and ends on end_date.
+         */
+        time?: Schema$GoogleTypeTimeOfDay;
+    }
+    /**
+     * MaintenanceInfo to capture the maintenance details of database resource.
+     */
+    export interface Schema$StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo {
+        /**
+         * Optional. List of Deny maintenance period for the database resource.
+         */
+        denyMaintenanceSchedules?: Schema$StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule[];
+        /**
+         * Optional. Maintenance window for the database resource.
+         */
+        maintenanceSchedule?: Schema$StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule;
+        /**
+         * Optional. Current Maintenance version of the database resource. Example: "MYSQL_8_0_41.R20250531.01_15"
+         */
+        maintenanceVersion?: string | null;
+    }
+    /**
+     * Maintenance window for the database resource. It specifies preferred time and day of the week and phase in some cases, when the maintenance can start. This is configured by the customer.
+     */
+    export interface Schema$StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule {
+        /**
+         * Optional. Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.
+         */
+        day?: string | null;
+        /**
+         * Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance
+         */
+        phase?: string | null;
+        /**
+         * Optional. Preferred time to start the maintenance operation on the specified day.
+         */
+        time?: Schema$GoogleTypeTimeOfDay;
+    }
     export interface Schema$StorageDatabasecenterPartnerapiV1mainRetentionSettings {
         /**
          * Duration based retention period i.e. 172800 seconds (2 days)
@@ -2546,7 +2812,7 @@ export declare namespace alloydb_v1 {
          *
          *   // Do the magic
          *   const res = await alloydb.projects.locations.list({
-         *     // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.
+         *     // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.
          *     extraLocationTypes: 'placeholder-value',
          *     // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
          *     filter: 'placeholder-value',
@@ -2593,7 +2859,7 @@ export declare namespace alloydb_v1 {
     }
     export interface Params$Resource$Projects$Locations$List extends StandardParameters {
         /**
-         * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.
+         * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.
          */
         extraLocationTypes?: string[];
         /**
@@ -3190,6 +3456,8 @@ export declare namespace alloydb_v1 {
          *       //   "annotations": {},
          *       //   "automatedBackupPolicy": {},
          *       //   "backupSource": {},
+         *       //   "backupdrBackupSource": {},
+         *       //   "backupdrInfo": {},
          *       //   "cloudsqlBackupRunSource": {},
          *       //   "clusterType": "my_clusterType",
          *       //   "continuousBackupConfig": {},
@@ -3301,6 +3569,8 @@ export declare namespace alloydb_v1 {
          *       //   "annotations": {},
          *       //   "automatedBackupPolicy": {},
          *       //   "backupSource": {},
+         *       //   "backupdrBackupSource": {},
+         *       //   "backupdrInfo": {},
          *       //   "cloudsqlBackupRunSource": {},
          *       //   "clusterType": "my_clusterType",
          *       //   "continuousBackupConfig": {},
@@ -3555,6 +3825,8 @@ export declare namespace alloydb_v1 {
          *   //   "annotations": {},
          *   //   "automatedBackupPolicy": {},
          *   //   "backupSource": {},
+         *   //   "backupdrBackupSource": {},
+         *   //   "backupdrInfo": {},
          *   //   "cloudsqlBackupRunSource": {},
          *   //   "clusterType": "my_clusterType",
          *   //   "continuousBackupConfig": {},
@@ -3802,6 +4074,8 @@ export declare namespace alloydb_v1 {
          *       //   "annotations": {},
          *       //   "automatedBackupPolicy": {},
          *       //   "backupSource": {},
+         *       //   "backupdrBackupSource": {},
+         *       //   "backupdrInfo": {},
          *       //   "cloudsqlBackupRunSource": {},
          *       //   "clusterType": "my_clusterType",
          *       //   "continuousBackupConfig": {},
@@ -3979,6 +4253,8 @@ export declare namespace alloydb_v1 {
          *       // request body parameters
          *       // {
          *       //   "backupSource": {},
+         *       //   "backupdrBackupSource": {},
+         *       //   "backupdrPitrSource": {},
          *       //   "cluster": {},
          *       //   "clusterId": "my_clusterId",
          *       //   "continuousBackupSource": {},
@@ -4485,6 +4761,7 @@ export declare namespace alloydb_v1 {
          *       //   "annotations": {},
          *       //   "availabilityType": "my_availabilityType",
          *       //   "clientConnectionConfig": {},
+         *       //   "connectionPoolConfig": {},
          *       //   "createTime": "my_createTime",
          *       //   "databaseFlags": {},
          *       //   "deleteTime": "my_deleteTime",
@@ -4592,6 +4869,7 @@ export declare namespace alloydb_v1 {
          *         //   "annotations": {},
          *         //   "availabilityType": "my_availabilityType",
          *         //   "clientConnectionConfig": {},
+         *         //   "connectionPoolConfig": {},
          *         //   "createTime": "my_createTime",
          *         //   "databaseFlags": {},
          *         //   "deleteTime": "my_deleteTime",
@@ -4837,6 +5115,7 @@ export declare namespace alloydb_v1 {
          *   //   "annotations": {},
          *   //   "availabilityType": "my_availabilityType",
          *   //   "clientConnectionConfig": {},
+         *   //   "connectionPoolConfig": {},
          *   //   "createTime": "my_createTime",
          *   //   "databaseFlags": {},
          *   //   "deleteTime": "my_deleteTime",
@@ -5144,6 +5423,7 @@ export declare namespace alloydb_v1 {
          *       //   "annotations": {},
          *       //   "availabilityType": "my_availabilityType",
          *       //   "clientConnectionConfig": {},
+         *       //   "connectionPoolConfig": {},
          *       //   "createTime": "my_createTime",
          *       //   "databaseFlags": {},
          *       //   "deleteTime": "my_deleteTime",
@@ -6121,13 +6401,16 @@ export declare namespace alloydb_v1 {
          *     pageSize: 'placeholder-value',
          *     // The standard list page token.
          *     pageToken: 'placeholder-value',
+         *     // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+         *     returnPartialSuccess: 'placeholder-value',
          *   });
          *   console.log(res.data);
          *
          *   // Example response
          *   // {
          *   //   "nextPageToken": "my_nextPageToken",
-         *   //   "operations": []
+         *   //   "operations": [],
+         *   //   "unreachable": []
          *   // }
          * }
          *
@@ -6189,6 +6472,10 @@ export declare namespace alloydb_v1 {
          * The standard list page token.
          */
         pageToken?: string;
+        /**
+         * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+         */
+        returnPartialSuccess?: boolean;
     }
     export class Resource$Projects$Locations$Supporteddatabaseflags {
         context: APIRequestContext;