@googleapis/alloydb 5.0.0 → 6.0.0

package/v1alpha.ts

@@ -366,6 +366,10 @@ export namespace alloydb_v1alpha {
      * For Resource freshness validation (https://google.aip.dev/154)
      */
     etag?: string | null;
+    /**
+     * Optional. Configuration parameters related to the Gemini in Databases add-on. See go/prd-enable-duet-ai-databases for more details.
+     */
+    geminiConfig?: Schema$GeminiClusterConfig;
     /**
      * Input only. Initial user to setup during cluster creation. Required. If used in `RestoreCluster` this is ignored.
      */
@@ -374,6 +378,10 @@ export namespace alloydb_v1alpha {
      * Labels as key value pairs
      */
     labels?: {[key: string]: string} | null;
+    /**
+     * Optional. The maintenance update policy determines when to allow or deny updates.
+     */
+    maintenanceUpdatePolicy?: Schema$MaintenanceUpdatePolicy;
     /**
      * Output only. Cluster created via DMS migration.
      */
@@ -383,7 +391,7 @@ export namespace alloydb_v1alpha {
      */
     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;
@@ -508,6 +516,23 @@ export namespace alloydb_v1alpha {
      */
     pointInTime?: string | null;
   }
+  /**
+   * DenyMaintenancePeriod definition. Excepting emergencies, maintenance will not be scheduled to start within this deny period. The start_date must be less than the end_date.
+   */
+  export interface Schema$DenyMaintenancePeriod {
+    /**
+     * Deny period end date. This can be: * A full date, with non-zero year, month and day values. * A month and day value, with a zero year for recurring. Date matching this period will have to be before the end.
+     */
+    endDate?: Schema$GoogleTypeDate;
+    /**
+     * Deny period start date. This can be: * A full date, with non-zero year, month and day values. * A month and day value, with a zero year for recurring. Date matching this period will have to be the same or after the start.
+     */
+    startDate?: Schema$GoogleTypeDate;
+    /**
+     * Time in UTC when the deny period starts on start_date and ends on end_date. This can be: * Full time. * All zeros for 00:00:00 UTC
+     */
+    time?: Schema$GoogleTypeTimeOfDay;
+  }
   /**
    * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \}
    */
@@ -548,46 +573,22 @@ export namespace alloydb_v1alpha {
     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. See go/prd-enable-duet-ai-databases for more details.
    */
-  export interface Schema$GenerateClientCertificateRequest {
-    /**
-     * 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;
+  export interface Schema$GeminiClusterConfig {
     /**
-     * Optional. The public key from the client.
+     * 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.
      */
-    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).
-     */
-    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. See go/prd-enable-duet-ai-databases for more details.
    */
-  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.
@@ -627,6 +628,23 @@ export namespace alloydb_v1alpha {
      */
     name?: string | null;
   }
+  /**
+   * Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
+   */
+  export interface Schema$GoogleTypeDate {
+    /**
+     * Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+     */
+    day?: number | null;
+    /**
+     * Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+     */
+    month?: number | null;
+    /**
+     * Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+     */
+    year?: number | null;
+  }
   /**
    * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.
    */
@@ -705,6 +723,10 @@ export namespace alloydb_v1alpha {
      * 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. See go/prd-enable-duet-ai-databases for more details.
+     */
+    geminiConfig?: Schema$GeminiInstanceConfig;
     /**
      * Required. The type of the instance. Specified at creation time.
      */
@@ -733,6 +755,10 @@ export namespace alloydb_v1alpha {
      * 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.
      */
@@ -911,6 +937,32 @@ export namespace alloydb_v1alpha {
      */
     cpuCount?: number | null;
   }
+  /**
+   * MaintenanceUpdatePolicy defines the policy for system updates.
+   */
+  export interface Schema$MaintenanceUpdatePolicy {
+    /**
+     * Periods to deny maintenance. Currently limited to 1.
+     */
+    denyMaintenancePeriods?: Schema$DenyMaintenancePeriod[];
+    /**
+     * 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.
    */
@@ -937,7 +989,7 @@ export namespace alloydb_v1alpha {
      */
     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;
   }
@@ -962,6 +1014,43 @@ export namespace alloydb_v1alpha {
      */
     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.
    */
@@ -1071,6 +1160,10 @@ export namespace alloydb_v1alpha {
      * 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;
+    /**
+     * Output only. The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog
+     */
+    pscDnsName?: string | null;
     /**
      * Optional. Whether PSC connectivity is enabled for this instance. This is populated by referencing the value from the parent cluster.
      */
@@ -1080,7 +1173,7 @@ export namespace alloydb_v1alpha {
      */
     pscInterfaceConfigs?: Schema$PscInterfaceConfig[];
     /**
-     * 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;
   }
@@ -1093,7 +1186,7 @@ export namespace alloydb_v1alpha {
      */
     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.
+     * 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;
   }
@@ -1461,7 +1554,7 @@ export namespace alloydb_v1alpha {
      */
     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;
     /**
@@ -1484,13 +1577,17 @@ export namespace alloydb_v1alpha {
      * User-provided labels, represented as a dictionary where each label is a single key value pair.
      */
     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} | null;
     /**
@@ -1543,6 +1640,7 @@ export namespace alloydb_v1alpha {
      * Identifies the specific error that occurred. REQUIRED
      */
     code?: string | null;
+    errorType?: string | null;
     /**
      * Additional information about the error encountered. REQUIRED
      */
@@ -1556,6 +1654,12 @@ export namespace alloydb_v1alpha {
     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.
    */
@@ -2731,102 +2835,6 @@ export namespace alloydb_v1alpha {
       }
     }
 
-    /**
-     * 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;
-    generateClientCertificate(
-      paramsOrCallback?:
-        | Params$Resource$Projects$Locations$Clusters$Generateclientcertificate
-        | BodyResponseCallback<Schema$GenerateClientCertificateResponse>
-        | BodyResponseCallback<Readable>,
-      optionsOrCallback?:
-        | MethodOptions
-        | StreamMethodOptions
-        | BodyResponseCallback<Schema$GenerateClientCertificateResponse>
-        | BodyResponseCallback<Readable>,
-      callback?:
-        | BodyResponseCallback<Schema$GenerateClientCertificateResponse>
-        | BodyResponseCallback<Readable>
-    ):
-      | void
-      | GaxiosPromise<Schema$GenerateClientCertificateResponse>
-      | GaxiosPromise<Readable> {
-      let params = (paramsOrCallback ||
-        {}) as Params$Resource$Projects$Locations$Clusters$Generateclientcertificate;
-      let options = (optionsOrCallback || {}) as MethodOptions;
-
-      if (typeof paramsOrCallback === 'function') {
-        callback = paramsOrCallback;
-        params =
-          {} as Params$Resource$Projects$Locations$Clusters$Generateclientcertificate;
-        options = {};
-      }
-
-      if (typeof optionsOrCallback === 'function') {
-        callback = optionsOrCallback;
-        options = {};
-      }
-
-      const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/';
-      const parameters = {
-        options: Object.assign(
-          {
-            url: (
-              rootUrl + '/v1alpha/{+parent}:generateClientCertificate'
-            ).replace(/([^:]\/)\/+/g, '$1'),
-            method: 'POST',
-          },
-          options
-        ),
-        params,
-        requiredParams: ['parent'],
-        pathParams: ['parent'],
-        context: this.context,
-      };
-      if (callback) {
-        createAPIRequest<Schema$GenerateClientCertificateResponse>(
-          parameters,
-          callback as BodyResponseCallback<unknown>
-        );
-      } else {
-        return createAPIRequest<Schema$GenerateClientCertificateResponse>(
-          parameters
-        );
-      }
-    }
-
     /**
      * Gets details of a single Cluster.
      *
@@ -3333,18 +3341,6 @@ export namespace alloydb_v1alpha {
      */
     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 {
     /**