@google-cloud/redis-cluster/build/src/v1/cloud_redis_cluster_client.d.ts

Google Cloud Memorystore for Redis API client for Node.js

import type * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax';
import { Transform } from 'stream';
import * as protos from '../../protos/protos';
/**
 *  Configures and manages Cloud Memorystore for Redis clusters
 *
 *  Google Cloud Memorystore for Redis Cluster
 *
 *  The `redis.googleapis.com` service implements the Google Cloud Memorystore
 *  for Redis API and defines the following resource model for managing Redis
 *  clusters:
 *  * The service works with a collection of cloud projects, named: `/projects/*`
 *  * Each project has a collection of available locations, named: `/locations/*`
 *  * Each location has a collection of Redis clusters, named: `/clusters/*`
 *  * As such, Redis clusters are resources of the form:
 *    `/projects/{project_id}/locations/{location_id}/clusters/{instance_id}`
 *
 *  Note that location_id must be a GCP `region`; for example:
 *  * `projects/redpepper-1290/locations/us-central1/clusters/my-redis`
 * @class
 * @memberof v1
 */
export declare class CloudRedisClusterClient {
    private _terminated;
    private _opts;
    private _providedCustomServicePath;
    private _gaxModule;
    private _gaxGrpc;
    private _protos;
    private _defaults;
    private _universeDomain;
    private _servicePath;
    private _log;
    auth: gax.GoogleAuth;
    descriptors: Descriptors;
    warn: (code: string, message: string, warnType?: string) => void;
    innerApiCalls: {
        [name: string]: Function;
    };
    locationsClient: LocationsClient;
    pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
    operationsClient: gax.OperationsClient;
    cloudRedisClusterStub?: Promise<{
        [name: string]: Function;
    }>;
    /**
     * Construct an instance of CloudRedisClusterClient.
     *
     * @param {object} [options] - The configuration object.
     * The options accepted by the constructor are described in detail
     * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
     * The common options are:
     * @param {object} [options.credentials] - Credentials object.
     * @param {string} [options.credentials.client_email]
     * @param {string} [options.credentials.private_key]
     * @param {string} [options.email] - Account email address. Required when
     *     using a .pem or .p12 keyFilename.
     * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
     *     .p12 key downloaded from the Google Developers Console. If you provide
     *     a path to a JSON file, the projectId option below is not necessary.
     *     NOTE: .pem and .p12 require you to specify options.email as well.
     * @param {number} [options.port] - The port on which to connect to
     *     the remote host.
     * @param {string} [options.projectId] - The project ID from the Google
     *     Developer's Console, e.g. 'grape-spaceship-123'. We will also check
     *     the environment variable GCLOUD_PROJECT for your project ID. If your
     *     app is running in an environment which supports
     *     {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
     *     your project ID will be detected automatically.
     * @param {string} [options.apiEndpoint] - The domain name of the
     *     API remote host.
     * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
     *     Follows the structure of {@link gapicConfig}.
     * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
     *     For more information, please check the
     *     {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
     * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
     *     need to avoid loading the default gRPC version and want to use the fallback
     *     HTTP implementation. Load only fallback version and pass it to the constructor:
     *     ```
     *     const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
     *     const client = new CloudRedisClusterClient({fallback: true}, gax);
     *     ```
     */
    constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
    /**
     * Initialize the client.
     * Performs asynchronous operations (such as authentication) and prepares the client.
     * This function will be called automatically when any class method is called for the
     * first time, but if you need to initialize it before calling an actual method,
     * feel free to call initialize() directly.
     *
     * You can await on this method if you want to make sure the client is initialized.
     *
     * @returns {Promise} A promise that resolves to an authenticated service stub.
     */
    initialize(): Promise<{
        [name: string]: Function;
    }>;
    /**
     * The DNS address for this API service.
     * @deprecated Use the apiEndpoint method of the client instance.
     * @returns {string} The DNS address for this service.
     */
    static get servicePath(): string;
    /**
     * The DNS address for this API service - same as servicePath.
     * @deprecated Use the apiEndpoint method of the client instance.
     * @returns {string} The DNS address for this service.
     */
    static get apiEndpoint(): string;
    /**
     * The DNS address for this API service.
     * @returns {string} The DNS address for this service.
     */
    get apiEndpoint(): string;
    get universeDomain(): string;
    /**
     * The port for this API service.
     * @returns {number} The default port for this service.
     */
    static get port(): number;
    /**
     * The scopes needed to make gRPC calls for every method defined
     * in this service.
     * @returns {string[]} List of default scopes.
     */
    static get scopes(): string[];
    getProjectId(): Promise<string>;
    getProjectId(callback: Callback<string, undefined, undefined>): void;
    /**
     * Gets the details of a specific Redis cluster.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Redis cluster resource name using the form:
     *       `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`
     *   where `location_id` refers to a GCP region.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link protos.google.cloud.redis.cluster.v1.Cluster|Cluster}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/cloud_redis_cluster.get_cluster.js</caption>
     * region_tag:redis_v1_generated_CloudRedisCluster_GetCluster_async
     */
    getCluster(request?: protos.google.cloud.redis.cluster.v1.IGetClusterRequest, options?: CallOptions): Promise<[
        protos.google.cloud.redis.cluster.v1.ICluster,
        protos.google.cloud.redis.cluster.v1.IGetClusterRequest | undefined,
        {} | undefined
    ]>;
    getCluster(request: protos.google.cloud.redis.cluster.v1.IGetClusterRequest, options: CallOptions, callback: Callback<protos.google.cloud.redis.cluster.v1.ICluster, protos.google.cloud.redis.cluster.v1.IGetClusterRequest | null | undefined, {} | null | undefined>): void;
    getCluster(request: protos.google.cloud.redis.cluster.v1.IGetClusterRequest, callback: Callback<protos.google.cloud.redis.cluster.v1.ICluster, protos.google.cloud.redis.cluster.v1.IGetClusterRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Gets the details of certificate authority information for Redis cluster.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Redis cluster certificate authority resource name using the form:
     *       `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}/certificateAuthority`
     *   where `location_id` refers to a GCP region.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link protos.google.cloud.redis.cluster.v1.CertificateAuthority|CertificateAuthority}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/cloud_redis_cluster.get_cluster_certificate_authority.js</caption>
     * region_tag:redis_v1_generated_CloudRedisCluster_GetClusterCertificateAuthority_async
     */
    getClusterCertificateAuthority(request?: protos.google.cloud.redis.cluster.v1.IGetClusterCertificateAuthorityRequest, options?: CallOptions): Promise<[
        protos.google.cloud.redis.cluster.v1.ICertificateAuthority,
        (protos.google.cloud.redis.cluster.v1.IGetClusterCertificateAuthorityRequest | undefined),
        {} | undefined
    ]>;
    getClusterCertificateAuthority(request: protos.google.cloud.redis.cluster.v1.IGetClusterCertificateAuthorityRequest, options: CallOptions, callback: Callback<protos.google.cloud.redis.cluster.v1.ICertificateAuthority, protos.google.cloud.redis.cluster.v1.IGetClusterCertificateAuthorityRequest | null | undefined, {} | null | undefined>): void;
    getClusterCertificateAuthority(request: protos.google.cloud.redis.cluster.v1.IGetClusterCertificateAuthorityRequest, callback: Callback<protos.google.cloud.redis.cluster.v1.ICertificateAuthority, protos.google.cloud.redis.cluster.v1.IGetClusterCertificateAuthorityRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Get a backup collection.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Redis backupCollection resource name using the form:
     *       `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}`
     *   where `location_id` refers to a GCP region.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link protos.google.cloud.redis.cluster.v1.BackupCollection|BackupCollection}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/cloud_redis_cluster.get_backup_collection.js</caption>
     * region_tag:redis_v1_generated_CloudRedisCluster_GetBackupCollection_async
     */
    getBackupCollection(request?: protos.google.cloud.redis.cluster.v1.IGetBackupCollectionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.redis.cluster.v1.IBackupCollection,
        (protos.google.cloud.redis.cluster.v1.IGetBackupCollectionRequest | undefined),
        {} | undefined
    ]>;
    getBackupCollection(request: protos.google.cloud.redis.cluster.v1.IGetBackupCollectionRequest, options: CallOptions, callback: Callback<protos.google.cloud.redis.cluster.v1.IBackupCollection, protos.google.cloud.redis.cluster.v1.IGetBackupCollectionRequest | null | undefined, {} | null | undefined>): void;
    getBackupCollection(request: protos.google.cloud.redis.cluster.v1.IGetBackupCollectionRequest, callback: Callback<protos.google.cloud.redis.cluster.v1.IBackupCollection, protos.google.cloud.redis.cluster.v1.IGetBackupCollectionRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Gets the details of a specific backup.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Redis backup resource name using the form:
     *   `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}`
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing {@link protos.google.cloud.redis.cluster.v1.Backup|Backup}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/cloud_redis_cluster.get_backup.js</caption>
     * region_tag:redis_v1_generated_CloudRedisCluster_GetBackup_async
     */
    getBackup(request?: protos.google.cloud.redis.cluster.v1.IGetBackupRequest, options?: CallOptions): Promise<[
        protos.google.cloud.redis.cluster.v1.IBackup,
        protos.google.cloud.redis.cluster.v1.IGetBackupRequest | undefined,
        {} | undefined
    ]>;
    getBackup(request: protos.google.cloud.redis.cluster.v1.IGetBackupRequest, options: CallOptions, callback: Callback<protos.google.cloud.redis.cluster.v1.IBackup, protos.google.cloud.redis.cluster.v1.IGetBackupRequest | null | undefined, {} | null | undefined>): void;
    getBackup(request: protos.google.cloud.redis.cluster.v1.IGetBackupRequest, callback: Callback<protos.google.cloud.redis.cluster.v1.IBackup, protos.google.cloud.redis.cluster.v1.IGetBackupRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Updates the metadata and configuration of a specific Redis cluster.
     *
     * Completed longrunning.Operation will contain the new cluster object
     * in the response field. The returned operation is automatically deleted
     * after a few hours, so there is no need to call DeleteOperation.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {google.protobuf.FieldMask} request.updateMask
     *   Required. Mask of fields to update. At least one path must be supplied in
     *   this field. The elements of the repeated paths field may only include these
     *   fields from {@link protos.google.cloud.redis.cluster.v1.Cluster|Cluster}:
     *
     *    *   `size_gb`
     *    *   `replica_count`
     * @param {google.cloud.redis.cluster.v1.Cluster} request.cluster
     *   Required. Update description.
     *   Only fields specified in update_mask are updated.
     * @param {string} request.requestId
     *   Idempotent request UUID.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/cloud_redis_cluster.update_cluster.js</caption>
     * region_tag:redis_v1_generated_CloudRedisCluster_UpdateCluster_async
     */
    updateCluster(request?: protos.google.cloud.redis.cluster.v1.IUpdateClusterRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.redis.cluster.v1.ICluster, protos.google.protobuf.IAny>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    updateCluster(request: protos.google.cloud.redis.cluster.v1.IUpdateClusterRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.redis.cluster.v1.ICluster, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    updateCluster(request: protos.google.cloud.redis.cluster.v1.IUpdateClusterRequest, callback: Callback<LROperation<protos.google.cloud.redis.cluster.v1.ICluster, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `updateCluster()`.
     * @param {String} name
     *   The operation name that will be passed.
     * @returns {Promise} - The promise which resolves to an object.
     *   The decoded operation object has result and metadata field to get information from.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/cloud_redis_cluster.update_cluster.js</caption>
     * region_tag:redis_v1_generated_CloudRedisCluster_UpdateCluster_async
     */
    checkUpdateClusterProgress(name: string): Promise<LROperation<protos.google.cloud.redis.cluster.v1.Cluster, protos.google.protobuf.Any>>;
    /**
     * Deletes a specific Redis cluster. Cluster stops serving and data is
     * deleted.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Redis cluster resource name using the form:
     *       `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`
     *   where `location_id` refers to a GCP region.
     * @param {string} request.requestId
     *   Idempotent request UUID.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/cloud_redis_cluster.delete_cluster.js</caption>
     * region_tag:redis_v1_generated_CloudRedisCluster_DeleteCluster_async
     */
    deleteCluster(request?: protos.google.cloud.redis.cluster.v1.IDeleteClusterRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IAny>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    deleteCluster(request: protos.google.cloud.redis.cluster.v1.IDeleteClusterRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    deleteCluster(request: protos.google.cloud.redis.cluster.v1.IDeleteClusterRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `deleteCluster()`.
     * @param {String} name
     *   The operation name that will be passed.
     * @returns {Promise} - The promise which resolves to an object.
     *   The decoded operation object has result and metadata field to get information from.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/cloud_redis_cluster.delete_cluster.js</caption>
     * region_tag:redis_v1_generated_CloudRedisCluster_DeleteCluster_async
     */
    checkDeleteClusterProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.protobuf.Any>>;
    /**
     * Creates a Redis cluster based on the specified properties.
     * The creation is executed asynchronously and callers may check the returned
     * operation to track its progress. Once the operation is completed the Redis
     * cluster will be fully functional. The completed longrunning.Operation will
     * contain the new cluster object in the response field.
     *
     * The returned operation is automatically deleted after a few hours, so there
     * is no need to call DeleteOperation.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The resource name of the cluster location using the form:
     *       `projects/{project_id}/locations/{location_id}`
     *   where `location_id` refers to a GCP region.
     * @param {string} request.clusterId
     *   Required. The logical name of the Redis cluster in the customer project
     *   with the following restrictions:
     *
     *   * Must contain only lowercase letters, numbers, and hyphens.
     *   * Must start with a letter.
     *   * Must be between 1-63 characters.
     *   * Must end with a number or a letter.
     *   * Must be unique within the customer project / location
     * @param {google.cloud.redis.cluster.v1.Cluster} request.cluster
     *   Required. The cluster that is to be created.
     * @param {string} request.requestId
     *   Idempotent request UUID.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/cloud_redis_cluster.create_cluster.js</caption>
     * region_tag:redis_v1_generated_CloudRedisCluster_CreateCluster_async
     */
    createCluster(request?: protos.google.cloud.redis.cluster.v1.ICreateClusterRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.redis.cluster.v1.ICluster, protos.google.protobuf.IAny>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    createCluster(request: protos.google.cloud.redis.cluster.v1.ICreateClusterRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.redis.cluster.v1.ICluster, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    createCluster(request: protos.google.cloud.redis.cluster.v1.ICreateClusterRequest, callback: Callback<LROperation<protos.google.cloud.redis.cluster.v1.ICluster, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `createCluster()`.
     * @param {String} name
     *   The operation name that will be passed.
     * @returns {Promise} - The promise which resolves to an object.
     *   The decoded operation object has result and metadata field to get information from.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/cloud_redis_cluster.create_cluster.js</caption>
     * region_tag:redis_v1_generated_CloudRedisCluster_CreateCluster_async
     */
    checkCreateClusterProgress(name: string): Promise<LROperation<protos.google.cloud.redis.cluster.v1.Cluster, protos.google.protobuf.Any>>;
    /**
     * Reschedules upcoming maintenance event.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Redis Cluster instance resource name using the form:
     *       `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`
     *   where `location_id` refers to a GCP region.
     * @param {google.cloud.redis.cluster.v1.RescheduleClusterMaintenanceRequest.RescheduleType} request.rescheduleType
     *   Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as
     *   well.
     * @param {google.protobuf.Timestamp} [request.scheduleTime]
     *   Optional. Timestamp when the maintenance shall be rescheduled to if
     *   reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for
     *   example `2012-11-15T16:19:00.094Z`.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/cloud_redis_cluster.reschedule_cluster_maintenance.js</caption>
     * region_tag:redis_v1_generated_CloudRedisCluster_RescheduleClusterMaintenance_async
     */
    rescheduleClusterMaintenance(request?: protos.google.cloud.redis.cluster.v1.IRescheduleClusterMaintenanceRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.redis.cluster.v1.ICluster, protos.google.protobuf.IAny>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    rescheduleClusterMaintenance(request: protos.google.cloud.redis.cluster.v1.IRescheduleClusterMaintenanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.redis.cluster.v1.ICluster, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    rescheduleClusterMaintenance(request: protos.google.cloud.redis.cluster.v1.IRescheduleClusterMaintenanceRequest, callback: Callback<LROperation<protos.google.cloud.redis.cluster.v1.ICluster, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `rescheduleClusterMaintenance()`.
     * @param {String} name
     *   The operation name that will be passed.
     * @returns {Promise} - The promise which resolves to an object.
     *   The decoded operation object has result and metadata field to get information from.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/cloud_redis_cluster.reschedule_cluster_maintenance.js</caption>
     * region_tag:redis_v1_generated_CloudRedisCluster_RescheduleClusterMaintenance_async
     */
    checkRescheduleClusterMaintenanceProgress(name: string): Promise<LROperation<protos.google.cloud.redis.cluster.v1.Cluster, protos.google.protobuf.Any>>;
    /**
     * Deletes a specific backup.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Redis backup resource name using the form:
     *   `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}`
     * @param {string} [request.requestId]
     *   Optional. Idempotent request UUID.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/cloud_redis_cluster.delete_backup.js</caption>
     * region_tag:redis_v1_generated_CloudRedisCluster_DeleteBackup_async
     */
    deleteBackup(request?: protos.google.cloud.redis.cluster.v1.IDeleteBackupRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IAny>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    deleteBackup(request: protos.google.cloud.redis.cluster.v1.IDeleteBackupRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    deleteBackup(request: protos.google.cloud.redis.cluster.v1.IDeleteBackupRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `deleteBackup()`.
     * @param {String} name
     *   The operation name that will be passed.
     * @returns {Promise} - The promise which resolves to an object.
     *   The decoded operation object has result and metadata field to get information from.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/cloud_redis_cluster.delete_backup.js</caption>
     * region_tag:redis_v1_generated_CloudRedisCluster_DeleteBackup_async
     */
    checkDeleteBackupProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.protobuf.Any>>;
    /**
     * Exports a specific backup to a customer target Cloud Storage URI.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.gcsBucket
     *   Google Cloud Storage bucket, like "my-bucket".
     * @param {string} request.name
     *   Required. Redis backup resource name using the form:
     *   `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}`
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/cloud_redis_cluster.export_backup.js</caption>
     * region_tag:redis_v1_generated_CloudRedisCluster_ExportBackup_async
     */
    exportBackup(request?: protos.google.cloud.redis.cluster.v1.IExportBackupRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.redis.cluster.v1.IBackup, protos.google.protobuf.IAny>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    exportBackup(request: protos.google.cloud.redis.cluster.v1.IExportBackupRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.redis.cluster.v1.IBackup, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    exportBackup(request: protos.google.cloud.redis.cluster.v1.IExportBackupRequest, callback: Callback<LROperation<protos.google.cloud.redis.cluster.v1.IBackup, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `exportBackup()`.
     * @param {String} name
     *   The operation name that will be passed.
     * @returns {Promise} - The promise which resolves to an object.
     *   The decoded operation object has result and metadata field to get information from.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/cloud_redis_cluster.export_backup.js</caption>
     * region_tag:redis_v1_generated_CloudRedisCluster_ExportBackup_async
     */
    checkExportBackupProgress(name: string): Promise<LROperation<protos.google.cloud.redis.cluster.v1.Backup, protos.google.protobuf.Any>>;
    /**
     * Backup Redis Cluster.
     * If this is the first time a backup is being created, a backup collection
     * will be created at the backend, and this backup belongs to this collection.
     * Both collection and backup will have a resource name. Backup will be
     * executed for each shard. A replica (primary if nonHA) will be selected to
     * perform the execution. Backup call will be rejected if there is an ongoing
     * backup or update operation. Be aware that during preview, if the cluster's
     * internal software version is too old, critical update will be performed
     * before actual backup. Once the internal software version is updated to the
     * minimum version required by the backup feature, subsequent backups will not
     * require critical update. After preview, there will be no critical update
     * needed for backup.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Redis cluster resource name using the form:
     *    `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`
     *   where `location_id` refers to a GCP region.
     * @param {google.protobuf.Duration} [request.ttl]
     *   Optional. TTL for the backup to expire. Value range is 1 day to 100 years.
     *   If not specified, the default value is 100 years.
     * @param {string} [request.backupId]
     *   Optional. The id of the backup to be created. If not specified, the
     *   default value ([YYYYMMDDHHMMSS]_[Shortened Cluster UID] is used.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is an object representing
     *   a long running operation. Its `promise()` method returns a promise
     *   you can `await` for.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/cloud_redis_cluster.backup_cluster.js</caption>
     * region_tag:redis_v1_generated_CloudRedisCluster_BackupCluster_async
     */
    backupCluster(request?: protos.google.cloud.redis.cluster.v1.IBackupClusterRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.redis.cluster.v1.ICluster, protos.google.protobuf.IAny>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    backupCluster(request: protos.google.cloud.redis.cluster.v1.IBackupClusterRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.redis.cluster.v1.ICluster, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    backupCluster(request: protos.google.cloud.redis.cluster.v1.IBackupClusterRequest, callback: Callback<LROperation<protos.google.cloud.redis.cluster.v1.ICluster, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    /**
     * Check the status of the long running operation returned by `backupCluster()`.
     * @param {String} name
     *   The operation name that will be passed.
     * @returns {Promise} - The promise which resolves to an object.
     *   The decoded operation object has result and metadata field to get information from.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/cloud_redis_cluster.backup_cluster.js</caption>
     * region_tag:redis_v1_generated_CloudRedisCluster_BackupCluster_async
     */
    checkBackupClusterProgress(name: string): Promise<LROperation<protos.google.cloud.redis.cluster.v1.Cluster, protos.google.protobuf.Any>>;
    /**
     * Lists all Redis clusters owned by a project in either the specified
     * location (region) or all locations.
     *
     * The location should have the following format:
     *
     * * `projects/{project_id}/locations/{location_id}`
     *
     * If `location_id` is specified as `-` (wildcard), then all regions
     * available to the project are queried, and the results are aggregated.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The resource name of the cluster location using the form:
     *       `projects/{project_id}/locations/{location_id}`
     *   where `location_id` refers to a GCP region.
     * @param {number} request.pageSize
     *   The maximum number of items to return.
     *
     *   If not specified, a default value of 1000 will be used by the service.
     *   Regardless of the page_size value, the response may include a partial list
     *   and a caller should only rely on response's
     *   {@link protos.google.cloud.redis.cluster.v1.ListClustersResponse.next_page_token|`next_page_token`}
     *   to determine if there are more clusters left to be queried.
     * @param {string} request.pageToken
     *   The `next_page_token` value returned from a previous
     *   {@link protos.CloudRedis.ListClusters|ListClusters} request, if any.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is Array of {@link protos.google.cloud.redis.cluster.v1.Cluster|Cluster}.
     *   The client library will perform auto-pagination by default: it will call the API as many
     *   times as needed and will merge results from all the pages into this array.
     *   Note that it can affect your quota.
     *   We recommend using `listClustersAsync()`
     *   method described below for async iteration which you can stop as needed.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
     *   for more details and examples.
     */
    listClusters(request?: protos.google.cloud.redis.cluster.v1.IListClustersRequest, options?: CallOptions): Promise<[
        protos.google.cloud.redis.cluster.v1.ICluster[],
        protos.google.cloud.redis.cluster.v1.IListClustersRequest | null,
        protos.google.cloud.redis.cluster.v1.IListClustersResponse
    ]>;
    listClusters(request: protos.google.cloud.redis.cluster.v1.IListClustersRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.redis.cluster.v1.IListClustersRequest, protos.google.cloud.redis.cluster.v1.IListClustersResponse | null | undefined, protos.google.cloud.redis.cluster.v1.ICluster>): void;
    listClusters(request: protos.google.cloud.redis.cluster.v1.IListClustersRequest, callback: PaginationCallback<protos.google.cloud.redis.cluster.v1.IListClustersRequest, protos.google.cloud.redis.cluster.v1.IListClustersResponse | null | undefined, protos.google.cloud.redis.cluster.v1.ICluster>): void;
    /**
     * Equivalent to `listClusters`, but returns a NodeJS Stream object.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The resource name of the cluster location using the form:
     *       `projects/{project_id}/locations/{location_id}`
     *   where `location_id` refers to a GCP region.
     * @param {number} request.pageSize
     *   The maximum number of items to return.
     *
     *   If not specified, a default value of 1000 will be used by the service.
     *   Regardless of the page_size value, the response may include a partial list
     *   and a caller should only rely on response's
     *   {@link protos.google.cloud.redis.cluster.v1.ListClustersResponse.next_page_token|`next_page_token`}
     *   to determine if there are more clusters left to be queried.
     * @param {string} request.pageToken
     *   The `next_page_token` value returned from a previous
     *   {@link protos.CloudRedis.ListClusters|ListClusters} request, if any.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Stream}
     *   An object stream which emits an object representing {@link protos.google.cloud.redis.cluster.v1.Cluster|Cluster} on 'data' event.
     *   The client library will perform auto-pagination by default: it will call the API as many
     *   times as needed. Note that it can affect your quota.
     *   We recommend using `listClustersAsync()`
     *   method described below for async iteration which you can stop as needed.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
     *   for more details and examples.
     */
    listClustersStream(request?: protos.google.cloud.redis.cluster.v1.IListClustersRequest, options?: CallOptions): Transform;
    /**
     * Equivalent to `listClusters`, but returns an iterable object.
     *
     * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The resource name of the cluster location using the form:
     *       `projects/{project_id}/locations/{location_id}`
     *   where `location_id` refers to a GCP region.
     * @param {number} request.pageSize
     *   The maximum number of items to return.
     *
     *   If not specified, a default value of 1000 will be used by the service.
     *   Regardless of the page_size value, the response may include a partial list
     *   and a caller should only rely on response's
     *   {@link protos.google.cloud.redis.cluster.v1.ListClustersResponse.next_page_token|`next_page_token`}
     *   to determine if there are more clusters left to be queried.
     * @param {string} request.pageToken
     *   The `next_page_token` value returned from a previous
     *   {@link protos.CloudRedis.ListClusters|ListClusters} request, if any.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Object}
     *   An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
     *   When you iterate the returned iterable, each element will be an object representing
     *   {@link protos.google.cloud.redis.cluster.v1.Cluster|Cluster}. The API will be called under the hood as needed, once per the page,
     *   so you can stop the iteration when you don't need more results.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v1/cloud_redis_cluster.list_clusters.js</caption>
     * region_tag:redis_v1_generated_CloudRedisCluster_ListClusters_async
     */
    listClustersAsync(request?: protos.google.cloud.redis.cluster.v1.IListClustersRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.redis.cluster.v1.ICluster>;
    /**
     * Lists all backup collections owned by a consumer project in either the
     * specified location (region) or all locations.
     *
     * If `location_id` is specified as `-` (wildcard), then all regions
     * available to the project are queried, and the results are aggregated.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The resource name of the backupCollection location using the
     *   form:
     *       `projects/{project_id}/locations/{location_id}`
     *   where `location_id` refers to a GCP region.
     * @param {number} [request.pageSize]
     *   Optional. The maximum number of items to return.
     *
     *   If not specified, a default value of 1000 will be used by the service.
     *   Regardless of the page_size value, the response may include a partial list
     *   and a caller should only rely on response's
     *   {@link protos.google.cloud.redis.cluster.v1.ListBackupCollectionsResponse.next_page_token|`next_page_token`}
     *   to determine if there are more clusters left to be queried.
     * @param {string} [request.pageToken]
     *   Optional. The `next_page_token` value returned from a previous
     *   [ListBackupCollections] request, if any.
     * @param {object} [options]
     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
     * @returns {Promise} - The promise which resolves to an array.
     *   The first element of the array is Array of {@link protos.google.cloud.redis.cluster.v1.BackupCollection|BackupCollection}.
     *   The client library will perform auto-pagination by default: it will call the API as many
     *   times as needed and will merge results from all the pages into this array.
     *   Note that it can affect your quota.
     *   We recommend using `listBackupCollectionsAsync()`
     *   method described below for async iteration which you can stop as needed.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
     *   for more details and examples.
     */
    listBackupCollections(request?: protos.google.cloud.redis.cluster.v1.IListBackupCollectionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.redis.cluster.v1.IBackupCollection[],
        protos.google.cloud.redis.cluster.v1.IListBackupCollectionsRequest | null,
        protos.google.cloud.redis.cluster.v1.IListBackupCollectionsResponse
    ]>;
    listBackupCollections(request: protos.google.cloud.redis.cluster.v1.IListBackupCollectionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.redis.cluster.v1.IListBackupCollectionsRequest, protos.google.cloud.redis.cluster.v1.IListBackupCollectionsResponse | null | undefined, protos.google.cloud.redis.cluster.v1.IBackupCollection>): void;
    listBackupCollections(request: protos.google.cloud.redis.cluster.v1.IListBackupCollectionsRequest, callback: PaginationCallback<protos.google.cloud.redis.cluster.v1.IListBackupCollectionsRequest, protos.google.cloud.redis.cluster.v1.IListBackupCollectionsResponse | null | undefined, protos.google.cloud.redis.cluster.v1.IBackupCollection>): void;
    /**
     * Equivalent to `listBackupCollections`, but returns a NodeJS Stream object.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The resource name of the backupCollection location using the
     *   form:
     *       `projects/{project_id}/locations/{location_id}`
     *   where `location_id` refers to a GCP region.
     * @param {number} [request.pageSize]
     *   Optional. The maximum number of items to return.
     *
     *   If not specified, a default value of 1000 will be used by the service.
     *   Regardless of the page_size value, the response may include a partial list
     *   and a caller should only r