@googleapis/alloydb 5.0.0 → 7.0.0

package/build/v1beta.d.ts

@@ -313,6 +313,10 @@ export declare namespace alloydb_v1beta {
          * For Resource freshness validation (https://google.aip.dev/154)
          */
         etag?: string | null;
+        /**
+         * Optional. Configuration parameters related to the Gemini in Databases add-on.
+         */
+        geminiConfig?: Schema$GeminiClusterConfig;
         /**
          * Input only. Initial user to setup during cluster creation. Required. If used in `RestoreCluster` this is ignored.
          */
@@ -323,6 +327,14 @@ export declare namespace alloydb_v1beta {
         labels?: {
             [key: string]: string;
         } | null;
+        /**
+         * Output only. The maintenance schedule for the cluster, generated for a specific rollout if a maintenance window is set.
+         */
+        maintenanceSchedule?: Schema$MaintenanceSchedule;
+        /**
+         * Optional. The maintenance update policy determines when to allow or deny updates.
+         */
+        maintenanceUpdatePolicy?: Schema$MaintenanceUpdatePolicy;
         /**
          * Output only. Cluster created via DMS migration.
          */
@@ -332,7 +344,7 @@ export declare namespace alloydb_v1beta {
          */
         name?: string | null;
         /**
-         * Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project\}/global/networks/{network_id\}". This is required to create a cluster. Deprecated, use network_config.network instead.
+         * Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project\}/global/networks/{network_id\}`. This is required to create a cluster. Deprecated, use network_config.network instead.
          */
         network?: string | null;
         networkConfig?: Schema$NetworkConfig;
@@ -340,6 +352,10 @@ export declare namespace alloydb_v1beta {
          * Output only. Cross Region replication config specific to PRIMARY cluster.
          */
         primaryConfig?: Schema$PrimaryConfig;
+        /**
+         * Optional. The configuration for Private Service Connect (PSC) for the cluster.
+         */
+        pscConfig?: Schema$PscConfig;
         /**
          * Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
          */
@@ -490,46 +506,22 @@ export declare namespace alloydb_v1beta {
         validateOnly?: boolean | null;
     }
     /**
-     * Message for requests to generate a client certificate signed by the Cluster CA.
+     * Cluster level configuration parameters related to the Gemini in Databases add-on.
      */
-    export interface Schema$GenerateClientCertificateRequest {
+    export interface Schema$GeminiClusterConfig {
         /**
-         * Optional. An optional hint to the endpoint to generate the client certificate with the requested duration. The duration can be from 1 hour to 24 hours. The endpoint may or may not honor the hint. If the hint is left unspecified or is not honored, then the endpoint will pick an appropriate default duration.
-         */
-        certDuration?: string | null;
-        /**
-         * Optional. A pem-encoded X.509 certificate signing request (CSR). It is recommended to use public_key instead.
-         */
-        pemCsr?: string | null;
-        /**
-         * Optional. The public key from the client.
-         */
-        publicKey?: string | null;
-        /**
-         * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+         * Output only. Whether the Gemini in Databases add-on is enabled for the cluster. It will be true only if the add-on has been enabled for the billing account corresponding to the cluster. Its status is toggled from the Admin Control Center (ACC) and cannot be toggled using AlloyDB's APIs.
          */
-        requestId?: string | null;
-        /**
-         * Optional. An optional hint to the endpoint to generate a client ceritificate that can be used by AlloyDB connectors to exchange additional metadata with the server after TLS handshake.
-         */
-        useMetadataExchange?: boolean | null;
+        entitled?: boolean | null;
     }
     /**
-     * Message returned by a GenerateClientCertificate operation.
+     * Instance level configuration parameters related to the Gemini in Databases add-on.
      */
-    export interface Schema$GenerateClientCertificateResponse {
-        /**
-         * Optional. The pem-encoded cluster ca X.509 certificate.
-         */
-        caCert?: string | null;
-        /**
-         * Output only. The pem-encoded, signed X.509 certificate.
-         */
-        pemCertificate?: string | null;
+    export interface Schema$GeminiInstanceConfig {
         /**
-         * Output only. The pem-encoded chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246.
+         * Output only. Whether the Gemini in Databases add-on is enabled for the instance. It will be true only if the add-on has been enabled for the billing account corresponding to the instance. Its status is toggled from the Admin Control Center (ACC) and cannot be toggled using AlloyDB's APIs.
          */
-        pemCertificateChain?: string[] | null;
+        entitled?: boolean | null;
     }
     /**
      * The response message for Locations.ListLocations.
@@ -655,6 +647,10 @@ export declare namespace alloydb_v1beta {
          * The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.
          */
         gceZone?: string | null;
+        /**
+         * Optional. Configuration parameters related to the Gemini in Databases add-on.
+         */
+        geminiConfig?: Schema$GeminiInstanceConfig;
         /**
          * Required. The type of the instance. Specified at creation time.
          */
@@ -685,6 +681,10 @@ export declare namespace alloydb_v1beta {
          * Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
          */
         nodes?: Schema$Node[];
+        /**
+         * Configuration for observability.
+         */
+        observabilityConfig?: Schema$ObservabilityInstanceConfig;
         /**
          * Optional. The configuration for Private Service Connect (PSC) for the instance.
          */
@@ -859,6 +859,37 @@ export declare namespace alloydb_v1beta {
          */
         cpuCount?: number | null;
     }
+    /**
+     * MaintenanceSchedule stores the maintenance schedule generated from the MaintenanceUpdatePolicy, once a maintenance rollout is triggered, if MaintenanceWindow is set, and if there is no conflicting DenyPeriod. The schedule is cleared once the update takes place. This field cannot be manually changed; modify the MaintenanceUpdatePolicy instead.
+     */
+    export interface Schema$MaintenanceSchedule {
+        /**
+         * Output only. The scheduled start time for the maintenance.
+         */
+        startTime?: string | null;
+    }
+    /**
+     * MaintenanceUpdatePolicy defines the policy for system updates.
+     */
+    export interface Schema$MaintenanceUpdatePolicy {
+        /**
+         * Preferred windows to perform maintenance. Currently limited to 1.
+         */
+        maintenanceWindows?: Schema$MaintenanceWindow[];
+    }
+    /**
+     * MaintenanceWindow specifies a preferred day and time for maintenance.
+     */
+    export interface Schema$MaintenanceWindow {
+        /**
+         * Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.
+         */
+        day?: string | null;
+        /**
+         * Preferred time to start the maintenance operation on the specified day. Maintenance will start within 1 hour of this time.
+         */
+        startTime?: Schema$GoogleTypeTimeOfDay;
+    }
     /**
      * Subset of the source instance configuration that is available when reading the cluster resource.
      */
@@ -885,7 +916,7 @@ export declare namespace alloydb_v1beta {
          */
         allocatedIpRange?: string | null;
         /**
-         * Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project_number\}/global/networks/{network_id\}". This is required to create a cluster.
+         * Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number\}/global/networks/{network_id\}`. This is required to create a cluster.
          */
         network?: string | null;
     }
@@ -910,6 +941,43 @@ export declare namespace alloydb_v1beta {
          */
         zoneId?: string | null;
     }
+    /**
+     * Observability Instance specific configuration.
+     */
+    export interface Schema$ObservabilityInstanceConfig {
+        /**
+         * Observability feature status for an instance. This is a read-only flag and modifiable only by producer API. This flag is turned "off" by default.
+         */
+        enabled?: boolean | null;
+        /**
+         * Query string length. The default value is 10k.
+         */
+        maxQueryStringLength?: number | null;
+        /**
+         * Preserve comments in query string for an instance. This flag is turned "off" by default.
+         */
+        preserveComments?: boolean | null;
+        /**
+         * Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 to 20 is considered valid.
+         */
+        queryPlansPerMinute?: number | null;
+        /**
+         * Record application tags for an instance. This flag is turned "off" by default.
+         */
+        recordApplicationTags?: boolean | null;
+        /**
+         * Track actively running queries on the instance. If not set, this flag is "off" by default.
+         */
+        trackActiveQueries?: boolean | null;
+        /**
+         * Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on.
+         */
+        trackWaitEvents?: boolean | null;
+        /**
+         * Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by producer API.
+         */
+        trackWaitEventTypes?: boolean | null;
+    }
     /**
      * This resource represents a long-running operation that is the result of a network API call.
      */
@@ -999,47 +1067,31 @@ export declare namespace alloydb_v1beta {
         validateOnly?: boolean | null;
     }
     /**
-     * PscInstanceConfig contains PSC related configuration at an instance level.
+     * PscConfig contains PSC related configuration at a cluster level.
      */
-    export interface Schema$PscInstanceConfig {
+    export interface Schema$PscConfig {
         /**
-         * Optional. List of consumer networks that are allowed to create PSC endpoints to service-attachments to this instance.
+         * Optional. Create an instance that allows connections from Private Service Connect endpoints to the instance.
          */
-        allowedConsumerNetworks?: string[] | null;
+        pscEnabled?: boolean | null;
+    }
+    /**
+     * PscInstanceConfig contains PSC related configuration at an instance level.
+     */
+    export interface Schema$PscInstanceConfig {
         /**
          * Optional. List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance.
          */
         allowedConsumerProjects?: string[] | null;
         /**
-         * Optional. List of service attachments that this instance has created endpoints to connect with. Currently, only a single outgoing service attachment is supported per instance.
-         */
-        outgoingServiceAttachmentLinks?: string[] | null;
-        /**
-         * Optional. Whether PSC connectivity is enabled for this instance. This is populated by referencing the value from the parent cluster.
+         * Output only. The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog
          */
-        pscEnabled?: boolean | null;
-        /**
-         * Optional. Configurations for setting up PSC interfaces attached to the instance which are used for outbound connectivity. Only primary instances can have PSC interface attached. All the VMs created for the primary instance will share the same configurations. Currently we only support 0 or 1 PSC interface.
-         */
-        pscInterfaceConfigs?: Schema$PscInterfaceConfig[];
+        pscDnsName?: string | null;
         /**
-         * Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of projects//regions//serviceAttachments/
+         * Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of `projects//regions//serviceAttachments/`
          */
         serviceAttachmentLink?: string | null;
     }
-    /**
-     * Configuration for setting up a PSC interface. This information needs to be provided by the customer. PSC interfaces will be created and added to VMs via SLM (adding a network interface will require recreating the VM). For HA instances this will be done via LDTM.
-     */
-    export interface Schema$PscInterfaceConfig {
-        /**
-         * A list of endpoints in the consumer VPC the interface might initiate outbound connections to. This list has to be provided when the PSC interface is created.
-         */
-        consumerEndpointIps?: string[] | null;
-        /**
-         * The NetworkAttachment resource created in the consumer VPC to which the PSC interface will be linked, in the form of: "projects/${CONSUMER_PROJECT\}/regions/${REGION\}/networkAttachments/${NETWORK_ATTACHMENT_NAME\}". NetworkAttachment has to be provided when the PSC interface is created.
-         */
-        networkAttachment?: string | null;
-    }
     /**
      * A backup's position in a quantity-based retention queue, of backups with the same source cluster and type, with length, retention, specified by the backup's retention policy. Once the position is greater than the retention, the backup is eligible to be garbage collected. Example: 5 backups from the same source cluster and type with a quantity-based retention of 3 and denoted by backup_id (position, retention). Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3). Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)
      */
@@ -1180,6 +1232,10 @@ export declare namespace alloydb_v1beta {
          * Availability type. Potential values: * `ZONAL`: The instance serves data from only one zone. Outages in that zone affect data accessibility. * `REGIONAL`: The instance can serve data from more than one zone in a region (it is highly available).
          */
         availabilityType?: string | null;
+        /**
+         * Checks for resources that are configured to have redundancy, and ongoing replication across regions
+         */
+        crossRegionReplicaConfigured?: boolean | null;
         externalReplicaConfigured?: boolean | null;
         promotableReplicaConfigured?: boolean | null;
     }
@@ -1408,7 +1464,7 @@ export declare namespace alloydb_v1beta {
          */
         location?: string | null;
         /**
-         * 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
+         * 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.
          */
         primaryResourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId;
         /**
@@ -1433,13 +1489,17 @@ export declare namespace alloydb_v1beta {
         userLabels?: {
             [key: string]: string;
         } | null;
+        /**
+         * User-provided labels associated with the resource
+         */
+        userLabelSet?: Schema$StorageDatabasecenterPartnerapiV1mainUserLabels;
     }
     /**
      * Common model for database resource recommendation signal data.
      */
     export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData {
         /**
-         * Required. Any other additional metadata specific to recommendation
+         * Optional. Any other additional metadata specific to recommendation
          */
         additionalMetadata?: {
             [key: string]: any;
@@ -1494,6 +1554,7 @@ export declare namespace alloydb_v1beta {
          * Identifies the specific error that occurred. REQUIRED
          */
         code?: string | null;
+        errorType?: string | null;
         /**
          * Additional information about the error encountered. REQUIRED
          */
@@ -1507,6 +1568,14 @@ export declare namespace alloydb_v1beta {
         retentionUnit?: string | null;
         timeBasedRetention?: string | null;
     }
+    /**
+     * Message type for storing user labels. User labels are used to tag App Engine resources, allowing users to search for resources matching a set of labels and to aggregate usage data by labels.
+     */
+    export interface Schema$StorageDatabasecenterPartnerapiV1mainUserLabels {
+        labels?: {
+            [key: string]: string;
+        } | null;
+    }
     /**
      * Product specification for Condor resources.
      */
@@ -1912,20 +1981,6 @@ export declare namespace alloydb_v1beta {
         delete(params: Params$Resource$Projects$Locations$Clusters$Delete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
         delete(params: Params$Resource$Projects$Locations$Clusters$Delete, callback: BodyResponseCallback<Schema$Operation>): void;
         delete(callback: BodyResponseCallback<Schema$Operation>): void;
-        /**
-         * Generate a client certificate signed by a Cluster CA. The sole purpose of this endpoint is to support AlloyDB connectors and the Auth Proxy client. The endpoint's behavior is subject to change without notice, so do not rely on its behavior remaining constant. Future changes will not break AlloyDB connectors or the Auth Proxy client.
-         *
-         * @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.
-         */
-        generateClientCertificate(params: Params$Resource$Projects$Locations$Clusters$Generateclientcertificate, options: StreamMethodOptions): GaxiosPromise<Readable>;
-        generateClientCertificate(params?: Params$Resource$Projects$Locations$Clusters$Generateclientcertificate, options?: MethodOptions): GaxiosPromise<Schema$GenerateClientCertificateResponse>;
-        generateClientCertificate(params: Params$Resource$Projects$Locations$Clusters$Generateclientcertificate, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
-        generateClientCertificate(params: Params$Resource$Projects$Locations$Clusters$Generateclientcertificate, options: MethodOptions | BodyResponseCallback<Schema$GenerateClientCertificateResponse>, callback: BodyResponseCallback<Schema$GenerateClientCertificateResponse>): void;
-        generateClientCertificate(params: Params$Resource$Projects$Locations$Clusters$Generateclientcertificate, callback: BodyResponseCallback<Schema$GenerateClientCertificateResponse>): void;
-        generateClientCertificate(callback: BodyResponseCallback<Schema$GenerateClientCertificateResponse>): void;
         /**
          * Gets details of a single Cluster.
          *
@@ -2063,16 +2118,6 @@ export declare namespace alloydb_v1beta {
          */
         validateOnly?: boolean;
     }
-    export interface Params$Resource$Projects$Locations$Clusters$Generateclientcertificate extends StandardParameters {
-        /**
-         * Required. The name of the parent resource. The required format is: * projects/{project\}/locations/{location\}/clusters/{cluster\}
-         */
-        parent?: string;
-        /**
-         * Request body metadata
-         */
-        requestBody?: Schema$GenerateClientCertificateRequest;
-    }
     export interface Params$Resource$Projects$Locations$Clusters$Get extends StandardParameters {
         /**
          * Required. The name of the resource. For the required format, see the comment on the Cluster.name field.