@googleapis/alloydb 27.1.0 → 27.3.0

package/v1.ts

@@ -170,6 +170,19 @@ export 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
    */
@@ -694,6 +707,15 @@ export 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.
    */
@@ -1072,6 +1094,10 @@ export namespace alloydb_v1 {
      * Configuration for observability.
      */
     observabilityConfig?: Schema$ObservabilityInstanceConfig;
+    /**
+     * Output only. Instance level observability information, contains the effective values of observability settings for this instance, by merging customer's provided `ObservabilityInstanceConfig` with the Observability defaults.
+     */
+    observabilityInstanceInfo?: Schema$ObservabilityInstanceInfo;
     /**
      * Output only. All outbound public IP addresses configured for the instance.
      */
@@ -1085,13 +1111,17 @@ export namespace alloydb_v1 {
      */
     pscInstanceInfo?: Schema$PscInstanceInfo;
     /**
-     * Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.
+     * Output only. The public IP address for the Instance. This is available ONLY when `enable_public_ip` is set or when you have upgraded from an Express Instance that has public DNS enabled. This field is not available for Express Instances. This is the connection endpoint for an end-user application.
      */
     publicIpAddress?: string | null;
     /**
      * Configuration for query insights.
      */
     queryInsightsConfig?: Schema$QueryInsightsInstanceConfig;
+    /**
+     * Output only. Instance level Query Insights information, which is read-only and available in the output only. Contains the effective query insights settings for this instance, by merging customer's provided `QueryInsightsInstanceConfig` with the Query Insights defaults.
+     */
+    queryInsightsInfo?: Schema$QueryInsightsInstanceInfo;
     /**
      * Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
      */
@@ -1414,6 +1444,40 @@ export namespace alloydb_v1 {
      */
     trackWaitEventTypes?: boolean | null;
   }
+  export interface Schema$ObservabilityInstanceInfo {
+    /**
+     * Output only. Observability feature status for an instance.
+     */
+    enabled?: boolean | null;
+    /**
+     * Output only. Query string length. The default value is 10k.
+     */
+    maxQueryStringLength?: number | null;
+    /**
+     * Output only. Preserve comments in query string for an instance.
+     */
+    preserveComments?: boolean | null;
+    /**
+     * Output only. Number of query execution plans captured by Insights per minute for all queries combined.
+     */
+    queryPlansPerMinute?: number | null;
+    /**
+     * Output only. Record application tags for an instance.
+     */
+    recordApplicationTags?: boolean | null;
+    /**
+     * Output only. Track actively running queries on the instance.
+     */
+    trackActiveQueries?: boolean | null;
+    /**
+     * Output only. Track wait events during query execution for an instance.
+     */
+    trackWaitEvents?: boolean | null;
+    /**
+     * Output only. Track wait event types during query execution for an instance.
+     */
+    trackWaitEventTypes?: boolean | null;
+  }
   /**
    * This resource represents a long-running operation that is the result of a network API call.
    */
@@ -1476,6 +1540,27 @@ export 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.
    */
@@ -1658,10 +1743,39 @@ export namespace alloydb_v1 {
      */
     recordClientAddress?: boolean | null;
   }
+  /**
+   * Instance level Query Insights information, which is read-only and available in the output only.
+   */
+  export interface Schema$QueryInsightsInstanceInfo {
+    /**
+     * Output only. Whether Query Insights is enabled.
+     */
+    enabled?: boolean | null;
+    /**
+     * Output only. Number of query execution plans captured per minute.
+     */
+    queryPlansPerMinute?: number | null;
+    /**
+     * Output only. Maximum query string length.
+     */
+    queryStringLength?: number | null;
+    /**
+     * Output only. Whether to record application tags.
+     */
+    recordApplicationTags?: boolean | null;
+    /**
+     * Output only. Whether to record client address.
+     */
+    recordClientAddress?: boolean | null;
+  }
   /**
    * Configuration for a read pool instance.
    */
   export interface Schema$ReadPoolConfig {
+    /**
+     * Optional. 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.
      */
@@ -1744,6 +1858,39 @@ export 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.
    */
@@ -6552,11 +6699,13 @@ export namespace alloydb_v1 {
      *       //   "networkConfig": {},
      *       //   "nodes": [],
      *       //   "observabilityConfig": {},
+     *       //   "observabilityInstanceInfo": {},
      *       //   "outboundPublicIpAddresses": [],
      *       //   "pscInstanceConfig": {},
      *       //   "pscInstanceInfo": {},
      *       //   "publicIpAddress": "my_publicIpAddress",
      *       //   "queryInsightsConfig": {},
+     *       //   "queryInsightsInfo": {},
      *       //   "readPoolConfig": {},
      *       //   "reconciling": false,
      *       //   "satisfiesPzs": false,
@@ -6740,11 +6889,13 @@ export namespace alloydb_v1 {
      *         //   "networkConfig": {},
      *         //   "nodes": [],
      *         //   "observabilityConfig": {},
+     *         //   "observabilityInstanceInfo": {},
      *         //   "outboundPublicIpAddresses": [],
      *         //   "pscInstanceConfig": {},
      *         //   "pscInstanceInfo": {},
      *         //   "publicIpAddress": "my_publicIpAddress",
      *         //   "queryInsightsConfig": {},
+     *         //   "queryInsightsInfo": {},
      *         //   "readPoolConfig": {},
      *         //   "reconciling": false,
      *         //   "satisfiesPzs": false,
@@ -7217,11 +7368,13 @@ export namespace alloydb_v1 {
      *   //   "networkConfig": {},
      *   //   "nodes": [],
      *   //   "observabilityConfig": {},
+     *   //   "observabilityInstanceInfo": {},
      *   //   "outboundPublicIpAddresses": [],
      *   //   "pscInstanceConfig": {},
      *   //   "pscInstanceInfo": {},
      *   //   "publicIpAddress": "my_publicIpAddress",
      *   //   "queryInsightsConfig": {},
+     *   //   "queryInsightsInfo": {},
      *   //   "readPoolConfig": {},
      *   //   "reconciling": false,
      *   //   "satisfiesPzs": false,
@@ -7838,11 +7991,13 @@ export namespace alloydb_v1 {
      *       //   "networkConfig": {},
      *       //   "nodes": [],
      *       //   "observabilityConfig": {},
+     *       //   "observabilityInstanceInfo": {},
      *       //   "outboundPublicIpAddresses": [],
      *       //   "pscInstanceConfig": {},
      *       //   "pscInstanceInfo": {},
      *       //   "publicIpAddress": "my_publicIpAddress",
      *       //   "queryInsightsConfig": {},
+     *       //   "queryInsightsInfo": {},
      *       //   "readPoolConfig": {},
      *       //   "reconciling": false,
      *       //   "satisfiesPzs": false,

package/v1alpha.ts

@@ -228,7 +228,7 @@ export namespace alloydb_v1alpha {
      */
     displayName?: string | null;
     /**
-     * Output only. The edition of the cluster this backup was created from. Any restored cluster created from this backup will have the same edition.
+     * Output only. Deprecated: Use `express_config` instead. Output only. The edition of the cluster this backup was created from. Any restored cluster created from this backup will have the same edition.
      */
     edition?: string | null;
     /**
@@ -251,6 +251,10 @@ export namespace alloydb_v1alpha {
      * Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.
      */
     expiryTime?: string | null;
+    /**
+     * Output only. The Express configuration of the cluster this backup was created from. Any restored cluster created from this backup will have the same Express configuration.
+     */
+    expressConfig?: Schema$ExpressConfig;
     /**
      * Labels as key value pairs
      */
@@ -493,7 +497,7 @@ export namespace alloydb_v1alpha {
      */
     displayName?: string | null;
     /**
-     * Optional. Edition of the cluster. If left unspecified, the cluster behaves as `EDITION_ALLOYDB`.
+     * Optional. Deprecated: Use `express_config` instead. Edition of the cluster. If left unspecified, the cluster behaves as `EDITION_ALLOYDB`.
      */
     edition?: string | null;
     /**
@@ -508,6 +512,10 @@ export namespace alloydb_v1alpha {
      * For Resource freshness validation (https://google.aip.dev/154)
      */
     etag?: string | null;
+    /**
+     * Optional. Configuration that allows the customer to create an AlloyDB Express cluster.
+     */
+    expressConfig?: Schema$ExpressConfig;
     /**
      * Optional. Deprecated and unused. This field will be removed in the near future.
      */
@@ -962,6 +970,15 @@ export namespace alloydb_v1alpha {
      */
     sqlExportOptions?: Schema$SqlExportOptions;
   }
+  /**
+   * Configuration that allows the user to create an AlloyDB Express cluster.
+   */
+  export interface Schema$ExpressConfig {
+    /**
+     * Optional. Whether Express configuration is enabled for the cluster.
+     */
+    enabled?: boolean | null;
+  }
   /**
    * Message for triggering failover on an Instance
    */
@@ -1225,6 +1242,10 @@ export namespace alloydb_v1alpha {
      * Configuration for observability.
      */
     observabilityConfig?: Schema$ObservabilityInstanceConfig;
+    /**
+     * Output only. Instance level observability information, contains the effective values of observability settings for this instance, by merging customer's provided `ObservabilityInstanceConfig` with the Observability defaults.
+     */
+    observabilityInstanceInfo?: Schema$ObservabilityInstanceInfo;
     /**
      * Output only. All outbound public IP addresses configured for the instance.
      */
@@ -1238,13 +1259,17 @@ export namespace alloydb_v1alpha {
      */
     pscInstanceInfo?: Schema$PscInstanceInfo;
     /**
-     * Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.
+     * Output only. The public IP address for the Instance. This is available ONLY when `enable_public_ip` is set or when you have upgraded from an Express Instance that has public DNS enabled. This field is not available for Express Instances. This is the connection endpoint for an end-user application.
      */
     publicIpAddress?: string | null;
     /**
      * Configuration for query insights.
      */
     queryInsightsConfig?: Schema$QueryInsightsInstanceConfig;
+    /**
+     * Output only. Instance level Query Insights information, which is read-only and available in the output only. Contains the effective query insights settings for this instance, by merging customer's provided `QueryInsightsInstanceConfig` with the Query Insights defaults.
+     */
+    queryInsightsInfo?: Schema$QueryInsightsInstanceInfo;
     /**
      * Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
      */
@@ -1588,7 +1613,7 @@ export namespace alloydb_v1alpha {
      */
     trackActiveQueries?: boolean | null;
     /**
-     * Indicates whether to track active query plans for an instance. If not set, the default value is "off". Can only be enabled if track_active_queries is enabled.
+     * Indicates whether to track active query plans for an instance. If not set, the default value is "off". Can only be enabled if track_active_queries is enabled. Deprecated: Use track_active_queries instead.
      */
     trackActiveQueryPlan?: boolean | null;
     /**
@@ -1604,6 +1629,52 @@ export namespace alloydb_v1alpha {
      */
     trackWaitEventTypes?: boolean | null;
   }
+  export interface Schema$ObservabilityInstanceInfo {
+    /**
+     * Output only. Whether assistive experiences are enabled for this AlloyDB instance.
+     */
+    assistiveExperiencesEnabled?: boolean | null;
+    /**
+     * Output only. Observability feature status for an instance.
+     */
+    enabled?: boolean | null;
+    /**
+     * Output only. Query string length. The default value is 10k.
+     */
+    maxQueryStringLength?: number | null;
+    /**
+     * Output only. Preserve comments in query string for an instance.
+     */
+    preserveComments?: boolean | null;
+    /**
+     * Output only. Number of query execution plans captured by Insights per minute for all queries combined.
+     */
+    queryPlansPerMinute?: number | null;
+    /**
+     * Output only. Record application tags for an instance.
+     */
+    recordApplicationTags?: boolean | null;
+    /**
+     * Output only. Track actively running queries on the instance.
+     */
+    trackActiveQueries?: boolean | null;
+    /**
+     * Output only. Indicates whether to track active query plans for an instance. Deprecated: Use track_active_queries instead.
+     */
+    trackActiveQueryPlan?: boolean | null;
+    /**
+     * Output only. Track client address for an instance.
+     */
+    trackClientAddress?: boolean | null;
+    /**
+     * Output only. Track wait events during query execution for an instance.
+     */
+    trackWaitEvents?: boolean | null;
+    /**
+     * Output only. Track wait event types during query execution for an instance.
+     */
+    trackWaitEventTypes?: boolean | null;
+  }
   /**
    * This resource represents a long-running operation that is the result of a network API call.
    */
@@ -1873,12 +1944,37 @@ export namespace alloydb_v1alpha {
      */
     recordClientAddress?: boolean | null;
   }
+  /**
+   * Instance level Query Insights information, which is read-only and available in the output only.
+   */
+  export interface Schema$QueryInsightsInstanceInfo {
+    /**
+     * Output only. Whether Query Insights is enabled.
+     */
+    enabled?: boolean | null;
+    /**
+     * Output only. Number of query execution plans captured per minute.
+     */
+    queryPlansPerMinute?: number | null;
+    /**
+     * Output only. Maximum query string length.
+     */
+    queryStringLength?: number | null;
+    /**
+     * Output only. Whether to record application tags.
+     */
+    recordApplicationTags?: boolean | null;
+    /**
+     * Output only. Whether to record client address.
+     */
+    recordClientAddress?: boolean | null;
+  }
   /**
    * 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.
+     * Optional. Autoscaling configuration for the read pool instance. If not set, the read pool instance will not be autoscaled.
      */
     autoScalingConfig?: Schema$AutoScalingConfig;
     /**
@@ -3587,6 +3683,7 @@ export namespace alloydb_v1alpha {
      *       //   "etag": "my_etag",
      *       //   "expiryQuantity": {},
      *       //   "expiryTime": "my_expiryTime",
+     *       //   "expressConfig": {},
      *       //   "labels": {},
      *       //   "name": "my_name",
      *       //   "reconciling": false,
@@ -3906,6 +4003,7 @@ export namespace alloydb_v1alpha {
      *   //   "etag": "my_etag",
      *   //   "expiryQuantity": {},
      *   //   "expiryTime": "my_expiryTime",
+     *   //   "expressConfig": {},
      *   //   "labels": {},
      *   //   "name": "my_name",
      *   //   "reconciling": false,
@@ -4222,6 +4320,7 @@ export namespace alloydb_v1alpha {
      *       //   "etag": "my_etag",
      *       //   "expiryQuantity": {},
      *       //   "expiryTime": "my_expiryTime",
+     *       //   "expressConfig": {},
      *       //   "labels": {},
      *       //   "name": "my_name",
      *       //   "reconciling": false,
@@ -4519,6 +4618,7 @@ export namespace alloydb_v1alpha {
      *       //   "encryptionConfig": {},
      *       //   "encryptionInfo": {},
      *       //   "etag": "my_etag",
+     *       //   "expressConfig": {},
      *       //   "geminiConfig": {},
      *       //   "initialUser": {},
      *       //   "labels": {},
@@ -4714,6 +4814,7 @@ export namespace alloydb_v1alpha {
      *       //   "encryptionConfig": {},
      *       //   "encryptionInfo": {},
      *       //   "etag": "my_etag",
+     *       //   "expressConfig": {},
      *       //   "geminiConfig": {},
      *       //   "initialUser": {},
      *       //   "labels": {},
@@ -5201,6 +5302,7 @@ export namespace alloydb_v1alpha {
      *   //   "encryptionConfig": {},
      *   //   "encryptionInfo": {},
      *   //   "etag": "my_etag",
+     *   //   "expressConfig": {},
      *   //   "geminiConfig": {},
      *   //   "initialUser": {},
      *   //   "labels": {},
@@ -5683,6 +5785,7 @@ export namespace alloydb_v1alpha {
      *       //   "encryptionConfig": {},
      *       //   "encryptionInfo": {},
      *       //   "etag": "my_etag",
+     *       //   "expressConfig": {},
      *       //   "geminiConfig": {},
      *       //   "initialUser": {},
      *       //   "labels": {},
@@ -6848,11 +6951,13 @@ export namespace alloydb_v1alpha {
      *       //   "networkConfig": {},
      *       //   "nodes": [],
      *       //   "observabilityConfig": {},
+     *       //   "observabilityInstanceInfo": {},
      *       //   "outboundPublicIpAddresses": [],
      *       //   "pscInstanceConfig": {},
      *       //   "pscInstanceInfo": {},
      *       //   "publicIpAddress": "my_publicIpAddress",
      *       //   "queryInsightsConfig": {},
+     *       //   "queryInsightsInfo": {},
      *       //   "readPoolConfig": {},
      *       //   "reconciling": false,
      *       //   "satisfiesPzi": false,
@@ -7040,11 +7145,13 @@ export namespace alloydb_v1alpha {
      *         //   "networkConfig": {},
      *         //   "nodes": [],
      *         //   "observabilityConfig": {},
+     *         //   "observabilityInstanceInfo": {},
      *         //   "outboundPublicIpAddresses": [],
      *         //   "pscInstanceConfig": {},
      *         //   "pscInstanceInfo": {},
      *         //   "publicIpAddress": "my_publicIpAddress",
      *         //   "queryInsightsConfig": {},
+     *         //   "queryInsightsInfo": {},
      *         //   "readPoolConfig": {},
      *         //   "reconciling": false,
      *         //   "satisfiesPzi": false,
@@ -7520,11 +7627,13 @@ export namespace alloydb_v1alpha {
      *   //   "networkConfig": {},
      *   //   "nodes": [],
      *   //   "observabilityConfig": {},
+     *   //   "observabilityInstanceInfo": {},
      *   //   "outboundPublicIpAddresses": [],
      *   //   "pscInstanceConfig": {},
      *   //   "pscInstanceInfo": {},
      *   //   "publicIpAddress": "my_publicIpAddress",
      *   //   "queryInsightsConfig": {},
+     *   //   "queryInsightsInfo": {},
      *   //   "readPoolConfig": {},
      *   //   "reconciling": false,
      *   //   "satisfiesPzi": false,
@@ -8148,11 +8257,13 @@ export namespace alloydb_v1alpha {
      *       //   "networkConfig": {},
      *       //   "nodes": [],
      *       //   "observabilityConfig": {},
+     *       //   "observabilityInstanceInfo": {},
      *       //   "outboundPublicIpAddresses": [],
      *       //   "pscInstanceConfig": {},
      *       //   "pscInstanceInfo": {},
      *       //   "publicIpAddress": "my_publicIpAddress",
      *       //   "queryInsightsConfig": {},
+     *       //   "queryInsightsInfo": {},
      *       //   "readPoolConfig": {},
      *       //   "reconciling": false,
      *       //   "satisfiesPzi": false,