@googleapis/alloydb 8.0.0 → 10.0.0

package/build/v1alpha.d.ts

@@ -264,6 +264,23 @@ export declare namespace alloydb_v1alpha {
          */
         exclusiveAction?: string | null;
     }
+    /**
+     * The source CloudSQL backup resource.
+     */
+    export interface Schema$CloudSQLBackupRunSource {
+        /**
+         * Required. The CloudSQL backup run ID.
+         */
+        backupRunId?: string | null;
+        /**
+         * Required. The CloudSQL instance ID.
+         */
+        instanceId?: string | null;
+        /**
+         * The project ID of the source CloudSQL instance. This should be the same as the AlloyDB cluster's project.
+         */
+        project?: string | null;
+    }
     /**
      * A cluster is a collection of regional AlloyDB resources. It can include a primary instance and one or more read pool instances. All cluster resources share a storage layer, which scales as needed.
      */
@@ -282,6 +299,10 @@ export declare namespace alloydb_v1alpha {
          * Output only. Cluster created from backup.
          */
         backupSource?: Schema$BackupSource;
+        /**
+         * Output only. Cluster created from CloudSQL snapshot.
+         */
+        cloudsqlBackupRunSource?: Schema$CloudSQLBackupRunSource;
         /**
          * Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster`
          */
@@ -389,6 +410,14 @@ export declare namespace alloydb_v1alpha {
          * Output only. The current serving state of the cluster.
          */
         state?: string | null;
+        /**
+         * Optional. Subscription type of the cluster.
+         */
+        subscriptionType?: string | null;
+        /**
+         * Output only. Metadata for free trial clusters
+         */
+        trialMetadata?: Schema$TrialMetadata;
         /**
          * Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
          */
@@ -398,6 +427,35 @@ export declare namespace alloydb_v1alpha {
          */
         updateTime?: string | null;
     }
+    /**
+     * Upgrade details of a cluster. This cluster can be primary or secondary.
+     */
+    export interface Schema$ClusterUpgradeDetails {
+        /**
+         * Cluster type which can either be primary or secondary.
+         */
+        clusterType?: string | null;
+        /**
+         * Database version of the cluster after the upgrade operation. This will be the target version if the upgrade was successful otherwise it remains the same as that before the upgrade operation.
+         */
+        databaseVersion?: string | null;
+        /**
+         * Upgrade details of the instances directly associated with this cluster.
+         */
+        instanceUpgradeDetails?: Schema$InstanceUpgradeDetails[];
+        /**
+         * Normalized name of the cluster
+         */
+        name?: string | null;
+        /**
+         * Array containing stage info associated with this cluster.
+         */
+        stageInfo?: Schema$StageInfo[];
+        /**
+         * Upgrade status of the cluster.
+         */
+        upgradeStatus?: string | null;
+    }
     /**
      * ConnectionInfo singleton resource. https://google.aip.dev/156
      */
@@ -768,6 +826,23 @@ export declare namespace alloydb_v1alpha {
          */
         enablePublicIp?: boolean | null;
     }
+    /**
+     * Details regarding the upgrade of instaces associated with a cluster.
+     */
+    export interface Schema$InstanceUpgradeDetails {
+        /**
+         * Instance type.
+         */
+        instanceType?: string | null;
+        /**
+         * Normalized name of the instance.
+         */
+        name?: string | null;
+        /**
+         * Upgrade status of the instance.
+         */
+        upgradeStatus?: string | null;
+    }
     /**
      * Restrictions on INTEGER type values.
      */
@@ -971,7 +1046,7 @@ export declare namespace alloydb_v1alpha {
      */
     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.
+         * Observability feature status for an instance. This flag is turned "off" by default.
          */
         enabled?: boolean | null;
         /**
@@ -983,7 +1058,7 @@ export declare namespace alloydb_v1alpha {
          */
         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.
+         * Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid.
          */
         queryPlansPerMinute?: number | null;
         /**
@@ -994,6 +1069,10 @@ export declare namespace alloydb_v1alpha {
          * Track actively running queries on the instance. If not set, this flag is "off" by default.
          */
         trackActiveQueries?: boolean | null;
+        /**
+         * Track client address for an instance. If not set, default value is "off".
+         */
+        trackClientAddress?: 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.
          */
@@ -1170,6 +1249,10 @@ export declare namespace alloydb_v1alpha {
         nodeCount?: number | null;
     }
     export interface Schema$RestartInstanceRequest {
+        /**
+         * Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Only applicable for read instances.
+         */
+        nodeIds?: 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).
          */
@@ -1230,6 +1313,23 @@ export declare namespace alloydb_v1alpha {
          */
         sslMode?: string | null;
     }
+    /**
+     * Stage information for different stages in the upgrade process.
+     */
+    export interface Schema$StageInfo {
+        /**
+         * logs_url is the URL for the logs associated with a stage if that stage has logs. Right now, only three stages have logs: ALLOYDB_PRECHECK, PG_UPGRADE_CHECK, PRIMARY_INSTANCE_UPGRADE.
+         */
+        logsUrl?: string | null;
+        /**
+         * The stage.
+         */
+        stage?: string | null;
+        /**
+         * Status of the stage.
+         */
+        status?: string | null;
+    }
     /**
      * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
      */
@@ -1316,29 +1416,13 @@ export declare namespace alloydb_v1alpha {
         version?: string | null;
     }
     /**
-     * Any custom metadata associated with the resource. i.e. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data
+     * Any custom metadata associated with the resource. e.g. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data
      */
     export interface Schema$StorageDatabasecenterPartnerapiV1mainCustomMetadataData {
-        databaseMetadata?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseMetadata[];
-    }
-    /**
-     * Metadata for individual databases created in an instance. i.e. spanner instance can have multiple databases with unique configuration settings.
-     */
-    export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseMetadata {
-        /**
-         * Backup configuration for this database
-         */
-        backupConfiguration?: Schema$StorageDatabasecenterPartnerapiV1mainBackupConfiguration;
-        /**
-         * Information about the last backup attempt for this database
-         */
-        backupRun?: Schema$StorageDatabasecenterPartnerapiV1mainBackupRun;
-        product?: Schema$StorageDatabasecenterProtoCommonProduct;
-        resourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId;
         /**
-         * Required. Database name. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel
+         * Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration.
          */
-        resourceName?: string | null;
+        internalResourceMetadata?: Schema$StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata[];
     }
     /**
      * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform.
@@ -1352,9 +1436,6 @@ export declare namespace alloydb_v1alpha {
          * Required. Type feed to be ingested into condor
          */
         feedType?: string | null;
-        /**
-         * More feed data would be added in subsequent CLs
-         */
         observabilityMetricData?: Schema$StorageDatabasecenterPartnerapiV1mainObservabilityMetricData;
         recommendationSignalData?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData;
         resourceHealthSignalData?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData;
@@ -1414,6 +1495,10 @@ export declare namespace alloydb_v1alpha {
          * Required. Unique identifier for the signal. This is an unique id which would be mainatined by partner to identify a signal.
          */
         signalId?: string | null;
+        /**
+         * The severity of the signal, such as if it's a HIGH or LOW severity.
+         */
+        signalSeverity?: string | null;
         /**
          * Required. Type of signal, for example, `AVAILABLE_IN_MULTIPLE_ZONES`, `LOGGING_MOST_ERRORS`, etc.
          */
@@ -1433,7 +1518,7 @@ export declare namespace alloydb_v1alpha {
          */
         providerDescription?: string | null;
         /**
-         * Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel
+         * Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance, spanner.googleapis.com/Database, firestore.googleapis.com/Database, sqladmin.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel
          */
         resourceType?: string | null;
         /**
@@ -1513,12 +1598,6 @@ export declare namespace alloydb_v1alpha {
          * The time at which the resource was updated and recorded at partner service.
          */
         updationTime?: string | null;
-        /**
-         * 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
          */
@@ -1576,28 +1655,51 @@ export declare namespace alloydb_v1alpha {
          */
         type?: string | null;
     }
+    /**
+     * Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration settings. Similarly bigtable can have multiple clusters within same bigtable instance.
+     */
+    export interface Schema$StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata {
+        /**
+         * Backup configuration for this database
+         */
+        backupConfiguration?: Schema$StorageDatabasecenterPartnerapiV1mainBackupConfiguration;
+        /**
+         * Information about the last backup attempt for this database
+         */
+        backupRun?: Schema$StorageDatabasecenterPartnerapiV1mainBackupRun;
+        product?: Schema$StorageDatabasecenterProtoCommonProduct;
+        resourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId;
+        /**
+         * Required. internal resource name for spanner this will be database name e.g."spanner.googleapis.com/projects/123/abc/instances/inst1/databases/db1"
+         */
+        resourceName?: string | null;
+    }
     /**
      * MachineConfiguration describes the configuration of a machine specific to Database Resource.
      */
     export interface Schema$StorageDatabasecenterPartnerapiV1mainMachineConfiguration {
         /**
-         * The number of CPUs.
+         * The number of CPUs. TODO(b/342344482, b/342346271) add proto validations again after bug fix.
          */
         cpuCount?: number | null;
         /**
-         * Memory size in bytes.
+         * Memory size in bytes. TODO(b/342344482, b/342346271) add proto validations again after bug fix.
          */
         memorySizeInBytes?: string | null;
     }
     export interface Schema$StorageDatabasecenterPartnerapiV1mainObservabilityMetricData {
         /**
-         * Required. The timestamp of the metric value.
+         * Required. Type of aggregation performed on the metric.
          */
-        metricTimestamp?: string | null;
+        aggregationType?: string | null;
         /**
          * Required. Type of metric like CPU, Memory, etc.
          */
         metricType?: string | null;
+        /**
+         * Required. The time the metric value was observed.
+         */
+        observationTime?: string | null;
         /**
          * Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel
          */
@@ -1605,7 +1707,7 @@ export declare namespace alloydb_v1alpha {
         /**
          * Required. Value of the metric type.
          */
-        value?: number | null;
+        value?: Schema$StorageDatabasecenterProtoCommonTypedValue;
     }
     /**
      * An error that occurred during a backup creation operation.
@@ -1654,6 +1756,27 @@ export declare namespace alloydb_v1alpha {
          */
         version?: string | null;
     }
+    /**
+     * TypedValue represents the value of a metric type. It can either be a double, an int64, a string or a bool.
+     */
+    export interface Schema$StorageDatabasecenterProtoCommonTypedValue {
+        /**
+         * For boolean value
+         */
+        boolValue?: boolean | null;
+        /**
+         * For double value
+         */
+        doubleValue?: number | null;
+        /**
+         * For integer value
+         */
+        int64Value?: string | null;
+        /**
+         * For string value
+         */
+        stringValue?: string | null;
+    }
     /**
      * Restrictions on STRING type values
      */
@@ -1697,6 +1820,19 @@ export declare namespace alloydb_v1alpha {
         supportedDbVersions?: string[] | null;
         valueType?: string | null;
     }
+    /**
+     * Message for switching over to a cluster
+     */
+    export interface Schema$SwitchoverClusterRequest {
+        /**
+         * 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. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.
+         */
+        validateOnly?: boolean | null;
+    }
     /**
      * A time based retention policy specifies that all backups within a certain time period should be retained.
      */
@@ -1706,6 +1842,27 @@ export declare namespace alloydb_v1alpha {
          */
         retentionPeriod?: string | null;
     }
+    /**
+     * Contains information and all metadata related to TRIAL clusters.
+     */
+    export interface Schema$TrialMetadata {
+        /**
+         * End time of the trial cluster.
+         */
+        endTime?: string | null;
+        /**
+         * grace end time of the cluster.
+         */
+        graceEndTime?: string | null;
+        /**
+         * start time of the trial cluster.
+         */
+        startTime?: string | null;
+        /**
+         * Upgrade time of trial cluster to Standard cluster.
+         */
+        upgradeTime?: string | null;
+    }
     /**
      * Policy to be used while updating the instance.
      */
@@ -1715,6 +1872,44 @@ export declare namespace alloydb_v1alpha {
          */
         mode?: string | null;
     }
+    /**
+     * Upgrades a cluster.
+     */
+    export interface Schema$UpgradeClusterRequest {
+        /**
+         * Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, upgrade will be blocked and an ABORTED error will be returned.
+         */
+        etag?: 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. If set, performs request validation (e.g. permission checks and any other type of validation), but does not actually execute the upgrade.
+         */
+        validateOnly?: boolean | null;
+        /**
+         * Required. The version the cluster is going to be upgraded to.
+         */
+        version?: string | null;
+    }
+    /**
+     * UpgradeClusterResponse contains the response for upgrade cluster operation.
+     */
+    export interface Schema$UpgradeClusterResponse {
+        /**
+         * Array of upgrade details for the current cluster and all the secondary clusters associated with this cluster.
+         */
+        clusterUpgradeDetails?: Schema$ClusterUpgradeDetails[];
+        /**
+         * A user friendly message summarising the upgrade operation details and the next steps for the user if there is any.
+         */
+        message?: string | null;
+        /**
+         * Status of upgrade operation.
+         */
+        status?: string | null;
+    }
     /**
      * Message describing User object.
      */
@@ -2112,6 +2307,34 @@ export declare namespace alloydb_v1alpha {
         restore(params: Params$Resource$Projects$Locations$Clusters$Restore, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
         restore(params: Params$Resource$Projects$Locations$Clusters$Restore, callback: BodyResponseCallback<Schema$Operation>): void;
         restore(callback: BodyResponseCallback<Schema$Operation>): void;
+        /**
+         * Switches the role of PRIMARY and SECONDARY cluster without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up original PRIMARY cluster to replicate from this newly promoted cluster.
+         *
+         * @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.
+         */
+        switchover(params: Params$Resource$Projects$Locations$Clusters$Switchover, options: StreamMethodOptions): GaxiosPromise<Readable>;
+        switchover(params?: Params$Resource$Projects$Locations$Clusters$Switchover, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
+        switchover(params: Params$Resource$Projects$Locations$Clusters$Switchover, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
+        switchover(params: Params$Resource$Projects$Locations$Clusters$Switchover, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
+        switchover(params: Params$Resource$Projects$Locations$Clusters$Switchover, callback: BodyResponseCallback<Schema$Operation>): void;
+        switchover(callback: BodyResponseCallback<Schema$Operation>): void;
+        /**
+         * Upgrades a single Cluster. Imperative only.
+         *
+         * @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.
+         */
+        upgrade(params: Params$Resource$Projects$Locations$Clusters$Upgrade, options: StreamMethodOptions): GaxiosPromise<Readable>;
+        upgrade(params?: Params$Resource$Projects$Locations$Clusters$Upgrade, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
+        upgrade(params: Params$Resource$Projects$Locations$Clusters$Upgrade, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
+        upgrade(params: Params$Resource$Projects$Locations$Clusters$Upgrade, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
+        upgrade(params: Params$Resource$Projects$Locations$Clusters$Upgrade, callback: BodyResponseCallback<Schema$Operation>): void;
+        upgrade(callback: BodyResponseCallback<Schema$Operation>): void;
     }
     export interface Params$Resource$Projects$Locations$Clusters$Create extends StandardParameters {
         /**
@@ -2257,6 +2480,26 @@ export declare namespace alloydb_v1alpha {
          */
         requestBody?: Schema$RestoreClusterRequest;
     }
+    export interface Params$Resource$Projects$Locations$Clusters$Switchover extends StandardParameters {
+        /**
+         * Required. The name of the resource. For the required format, see the comment on the Cluster.name field
+         */
+        name?: string;
+        /**
+         * Request body metadata
+         */
+        requestBody?: Schema$SwitchoverClusterRequest;
+    }
+    export interface Params$Resource$Projects$Locations$Clusters$Upgrade extends StandardParameters {
+        /**
+         * Required. The resource name of the cluster.
+         */
+        name?: string;
+        /**
+         * Request body metadata
+         */
+        requestBody?: Schema$UpgradeClusterRequest;
+    }
     export class Resource$Projects$Locations$Clusters$Instances {
         context: APIRequestContext;
         constructor(context: APIRequestContext);

package/build/v1alpha.js

@@ -553,6 +553,70 @@ var alloydb_v1alpha;
                 return (0, googleapis_common_1.createAPIRequest)(parameters);
             }
         }
+        switchover(paramsOrCallback, optionsOrCallback, callback) {
+            let params = (paramsOrCallback ||
+                {});
+            let options = (optionsOrCallback || {});
+            if (typeof paramsOrCallback === 'function') {
+                callback = paramsOrCallback;
+                params = {};
+                options = {};
+            }
+            if (typeof optionsOrCallback === 'function') {
+                callback = optionsOrCallback;
+                options = {};
+            }
+            const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/';
+            const parameters = {
+                options: Object.assign({
+                    url: (rootUrl + '/v1alpha/{+name}:switchover').replace(/([^:]\/)\/+/g, '$1'),
+                    method: 'POST',
+                    apiVersion: '',
+                }, options),
+                params,
+                requiredParams: ['name'],
+                pathParams: ['name'],
+                context: this.context,
+            };
+            if (callback) {
+                (0, googleapis_common_1.createAPIRequest)(parameters, callback);
+            }
+            else {
+                return (0, googleapis_common_1.createAPIRequest)(parameters);
+            }
+        }
+        upgrade(paramsOrCallback, optionsOrCallback, callback) {
+            let params = (paramsOrCallback ||
+                {});
+            let options = (optionsOrCallback || {});
+            if (typeof paramsOrCallback === 'function') {
+                callback = paramsOrCallback;
+                params = {};
+                options = {};
+            }
+            if (typeof optionsOrCallback === 'function') {
+                callback = optionsOrCallback;
+                options = {};
+            }
+            const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/';
+            const parameters = {
+                options: Object.assign({
+                    url: (rootUrl + '/v1alpha/{+name}:upgrade').replace(/([^:]\/)\/+/g, '$1'),
+                    method: 'PATCH',
+                    apiVersion: '',
+                }, options),
+                params,
+                requiredParams: ['name'],
+                pathParams: ['name'],
+                context: this.context,
+            };
+            if (callback) {
+                (0, googleapis_common_1.createAPIRequest)(parameters, callback);
+            }
+            else {
+                return (0, googleapis_common_1.createAPIRequest)(parameters);
+            }
+        }
     }
     alloydb_v1alpha.Resource$Projects$Locations$Clusters = Resource$Projects$Locations$Clusters;
     class Resource$Projects$Locations$Clusters$Instances {