Class v1.CloudRedisClusterClient (0.7.1)

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 v1

Package

@google-cloud/redis-cluster

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of CloudRedisClusterClient.

Parameters
Name Description
opts ClientOptions
gaxInstance typeof gax | typeof fallback

: 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); ```

Properties

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath.

auth

auth: gax.GoogleAuth;

cloudRedisClusterStub

cloudRedisClusterStub?: Promise<{
        [name: string]: Function;
    }>;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

locationsClient

locationsClient: LocationsClient;

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static get servicePath(): string;

The DNS address for this API service.

universeDomain

get universeDomain(): string;

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

backupCluster(request, options)

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
    ]>;

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.

Parameters
Name Description
request IBackupClusterRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.redis.cluster.v1.ICluster, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{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 documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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.
   */
  // const name = 'abc123'
  /**
   *  Optional. TTL for the backup to expire. Value range is 1 day to 100 years.
   *  If not specified, the default value is 100 years.
   */
  // const ttl = {}
  /**
   *  Optional. The id of the backup to be created. If not specified, the
   *  default value (YYYYMMDDHHMMSS _Shortened Cluster UID  is used.
   */
  // const backupId = 'abc123'

  // Imports the Cluster library
  const {CloudRedisClusterClient} = require('@google-cloud/redis-cluster').v1;

  // Instantiates a client
  const clusterClient = new CloudRedisClusterClient();

  async function callBackupCluster() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await clusterClient.backupCluster(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callBackupCluster();

backupCluster(request, options, callback)

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;
Parameters
Name Description
request 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>
Returns
Type Description
void

backupCluster(request, callback)

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;
Parameters
Name Description
request IBackupClusterRequest
callback Callback<LROperation<protos.google.cloud.redis.cluster.v1.ICluster, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

backupCollectionPath(project, location, backupCollection)

backupCollectionPath(project: string, location: string, backupCollection: string): string;

Return a fully-qualified backupCollection resource name string.

Parameters
Name Description
project string
location string
backupCollection string
Returns
Type Description
string

{string} Resource name string.

backupPath(project, location, backupCollection, backup)

backupPath(project: string, location: string, backupCollection: string, backup: string): string;

Return a fully-qualified backup resource name string.

Parameters
Name Description
project string
location string
backupCollection string
backup string
Returns
Type Description
string

{string} Resource name string.

cancelOperation(request, optionsOrCallback, callback)

cancelOperation(request: protos.google.longrunning.CancelOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED.

Parameters
Name Description
request CancelOperationRequest

The request object that will be sent.

optionsOrCallback CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>
callback Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>

The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type Description
Promise<protos.google.protobuf.Empty>
Example

const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});

certificateAuthorityPath(project, location, cluster)

certificateAuthorityPath(project: string, location: string, cluster: string): string;

Return a fully-qualified certificateAuthority resource name string.

Parameters
Name Description
project string
location string
cluster string
Returns
Type Description
string

{string} Resource name string.

checkBackupClusterProgress(name)

checkBackupClusterProgress(name: string): Promise<LROperation<protos.google.cloud.redis.cluster.v1.Cluster, protos.google.protobuf.Any>>;

Check the status of the long running operation returned by backupCluster().

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.redis.cluster.v1.Cluster, protos.google.protobuf.Any>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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.
   */
  // const name = 'abc123'
  /**
   *  Optional. TTL for the backup to expire. Value range is 1 day to 100 years.
   *  If not specified, the default value is 100 years.
   */
  // const ttl = {}
  /**
   *  Optional. The id of the backup to be created. If not specified, the
   *  default value (YYYYMMDDHHMMSS _Shortened Cluster UID  is used.
   */
  // const backupId = 'abc123'

  // Imports the Cluster library
  const {CloudRedisClusterClient} = require('@google-cloud/redis-cluster').v1;

  // Instantiates a client
  const clusterClient = new CloudRedisClusterClient();

  async function callBackupCluster() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await clusterClient.backupCluster(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callBackupCluster();

checkCreateClusterProgress(name)

checkCreateClusterProgress(name: string): Promise<LROperation<protos.google.cloud.redis.cluster.v1.Cluster, protos.google.protobuf.Any>>;

Check the status of the long running operation returned by createCluster().

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.redis.cluster.v1.Cluster, protos.google.protobuf.Any>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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.
   */
  // const parent = 'abc123'
  /**
   *  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
   */
  // const clusterId = 'abc123'
  /**
   *  Required. The cluster that is to be created.
   */
  // const cluster = {}
  /**
   *  Idempotent request UUID.
   */
  // const requestId = 'abc123'

  // Imports the Cluster library
  const {CloudRedisClusterClient} = require('@google-cloud/redis-cluster').v1;

  // Instantiates a client
  const clusterClient = new CloudRedisClusterClient();

  async function callCreateCluster() {
    // Construct request
    const request = {
      parent,
      clusterId,
      cluster,
    };

    // Run request
    const [operation] = await clusterClient.createCluster(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateCluster();

checkDeleteBackupProgress(name)

checkDeleteBackupProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.protobuf.Any>>;

Check the status of the long running operation returned by deleteBackup().

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.protobuf.Any>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Redis backup resource name using the form:
   *  `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}`
   */
  // const name = 'abc123'
  /**
   *  Optional. Idempotent request UUID.
   */
  // const requestId = 'abc123'

  // Imports the Cluster library
  const {CloudRedisClusterClient} = require('@google-cloud/redis-cluster').v1;

  // Instantiates a client
  const clusterClient = new CloudRedisClusterClient();

  async function callDeleteBackup() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await clusterClient.deleteBackup(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteBackup();

checkDeleteClusterProgress(name)

checkDeleteClusterProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.protobuf.Any>>;

Check the status of the long running operation returned by deleteCluster().

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.protobuf.Any>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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.
   */
  // const name = 'abc123'
  /**
   *  Idempotent request UUID.
   */
  // const requestId = 'abc123'

  // Imports the Cluster library
  const {CloudRedisClusterClient} = require('@google-cloud/redis-cluster').v1;

  // Instantiates a client
  const clusterClient = new CloudRedisClusterClient();

  async function callDeleteCluster() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await clusterClient.deleteCluster(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteCluster();

checkExportBackupProgress(name)

checkExportBackupProgress(name: string): Promise<LROperation<protos.google.cloud.redis.cluster.v1.Backup, protos.google.protobuf.Any>>;

Check the status of the long running operation returned by exportBackup().

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.redis.cluster.v1.Backup, protos.google.protobuf.Any>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Google Cloud Storage bucket, like "my-bucket".
   */
  // const gcsBucket = 'abc123'
  /**
   *  Required. Redis backup resource name using the form:
   *  `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}`
   */
  // const name = 'abc123'

  // Imports the Cluster library
  const {CloudRedisClusterClient} = require('@google-cloud/redis-cluster').v1;

  // Instantiates a client
  const clusterClient = new CloudRedisClusterClient();

  async function callExportBackup() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await clusterClient.exportBackup(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callExportBackup();

checkRescheduleClusterMaintenanceProgress(name)

checkRescheduleClusterMaintenanceProgress(name: string): Promise<LROperation<protos.google.cloud.redis.cluster.v1.Cluster, protos.google.protobuf.Any>>;

Check the status of the long running operation returned by rescheduleClusterMaintenance().

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.redis.cluster.v1.Cluster, protos.google.protobuf.Any>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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.
   */
  // const name = 'abc123'
  /**
   *  Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as
   *  well.
   */
  // const rescheduleType = {}
  /**
   *  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`.
   */
  // const scheduleTime = {}

  // Imports the Cluster library
  const {CloudRedisClusterClient} = require('@google-cloud/redis-cluster').v1;

  // Instantiates a client
  const clusterClient = new CloudRedisClusterClient();

  async function callRescheduleClusterMaintenance() {
    // Construct request
    const request = {
      name,
      rescheduleType,
    };

    // Run request
    const [operation] = await clusterClient.rescheduleClusterMaintenance(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callRescheduleClusterMaintenance();

checkUpdateClusterProgress(name)

checkUpdateClusterProgress(name: string): Promise<LROperation<protos.google.cloud.redis.cluster.v1.Cluster, protos.google.protobuf.Any>>;

Check the status of the long running operation returned by updateCluster().

Parameter
Name Description
name string

The operation name that will be passed.

Returns
Type Description
Promise<LROperation<protos.google.cloud.redis.cluster.v1.Cluster, protos.google.protobuf.Any>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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 Cluster google.cloud.redis.cluster.v1.Cluster:
   *   *   `size_gb`
   *   *   `replica_count`
   */
  // const updateMask = {}
  /**
   *  Required. Update description.
   *  Only fields specified in update_mask are updated.
   */
  // const cluster = {}
  /**
   *  Idempotent request UUID.
   */
  // const requestId = 'abc123'

  // Imports the Cluster library
  const {CloudRedisClusterClient} = require('@google-cloud/redis-cluster').v1;

  // Instantiates a client
  const clusterClient = new CloudRedisClusterClient();

  async function callUpdateCluster() {
    // Construct request
    const request = {
      updateMask,
      cluster,
    };

    // Run request
    const [operation] = await clusterClient.updateCluster(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateCluster();

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
Type Description
Promise<void>

{Promise} A promise that resolves when the client is closed.

clusterPath(project, location, cluster)

clusterPath(project: string, location: string, cluster: string): string;

Return a fully-qualified cluster resource name string.

Parameters
Name Description
project string
location string
cluster string
Returns
Type Description
string

{string} Resource name string.

createCluster(request, options)

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
    ]>;

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.

Parameters
Name Description
request ICreateClusterRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.redis.cluster.v1.ICluster, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{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 documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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.
   */
  // const parent = 'abc123'
  /**
   *  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
   */
  // const clusterId = 'abc123'
  /**
   *  Required. The cluster that is to be created.
   */
  // const cluster = {}
  /**
   *  Idempotent request UUID.
   */
  // const requestId = 'abc123'

  // Imports the Cluster library
  const {CloudRedisClusterClient} = require('@google-cloud/redis-cluster').v1;

  // Instantiates a client
  const clusterClient = new CloudRedisClusterClient();

  async function callCreateCluster() {
    // Construct request
    const request = {
      parent,
      clusterId,
      cluster,
    };

    // Run request
    const [operation] = await clusterClient.createCluster(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateCluster();

createCluster(request, options, callback)

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;
Parameters
Name Description
request 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>
Returns
Type Description
void

createCluster(request, callback)

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;
Parameters
Name Description
request ICreateClusterRequest
callback Callback<LROperation<protos.google.cloud.redis.cluster.v1.ICluster, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

cryptoKeyPath(project, location, keyRing, cryptoKey)

cryptoKeyPath(project: string, location: string, keyRing: string, cryptoKey: string): string;

Return a fully-qualified cryptoKey resource name string.

Parameters
Name Description
project string
location string
keyRing string
cryptoKey string
Returns
Type Description
string

{string} Resource name string.

cryptoKeyVersionPath(project, location, keyRing, cryptoKey, cryptoKeyVersion)

cryptoKeyVersionPath(project: string, location: string, keyRing: string, cryptoKey: string, cryptoKeyVersion: string): string;

Return a fully-qualified cryptoKeyVersion resource name string.

Parameters
Name Description
project string
location string
keyRing string
cryptoKey string
cryptoKeyVersion string
Returns
Type Description
string

{string} Resource name string.

deleteBackup(request, options)

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
    ]>;

Deletes a specific backup.

Parameters
Name Description
request IDeleteBackupRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{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 documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Redis backup resource name using the form:
   *  `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}`
   */
  // const name = 'abc123'
  /**
   *  Optional. Idempotent request UUID.
   */
  // const requestId = 'abc123'

  // Imports the Cluster library
  const {CloudRedisClusterClient} = require('@google-cloud/redis-cluster').v1;

  // Instantiates a client
  const clusterClient = new CloudRedisClusterClient();

  async function callDeleteBackup() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await clusterClient.deleteBackup(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteBackup();

deleteBackup(request, options, callback)

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;
Parameters
Name Description
request IDeleteBackupRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteBackup(request, callback)

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;
Parameters
Name Description
request IDeleteBackupRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteCluster(request, options)

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
    ]>;

Deletes a specific Redis cluster. Cluster stops serving and data is deleted.

Parameters
Name Description
request IDeleteClusterRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{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 documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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.
   */
  // const name = 'abc123'
  /**
   *  Idempotent request UUID.
   */
  // const requestId = 'abc123'

  // Imports the Cluster library
  const {CloudRedisClusterClient} = require('@google-cloud/redis-cluster').v1;

  // Instantiates a client
  const clusterClient = new CloudRedisClusterClient();

  async function callDeleteCluster() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await clusterClient.deleteCluster(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteCluster();

deleteCluster(request, options, callback)

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;
Parameters
Name Description
request IDeleteClusterRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteCluster(request, callback)

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;
Parameters
Name Description
request IDeleteClusterRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteOperation(request, optionsOrCallback, callback)

deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
request DeleteOperationRequest

The request object that will be sent.

optionsOrCallback CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>
callback Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>

The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type Description
Promise<protos.google.protobuf.Empty>
Example

const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});

exportBackup(request, options)

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
    ]>;

Exports a specific backup to a customer target Cloud Storage URI.

Parameters
Name Description
request IExportBackupRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.redis.cluster.v1.IBackup, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{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 documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Google Cloud Storage bucket, like "my-bucket".
   */
  // const gcsBucket = 'abc123'
  /**
   *  Required. Redis backup resource name using the form:
   *  `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}`
   */
  // const name = 'abc123'

  // Imports the Cluster library
  const {CloudRedisClusterClient} = require('@google-cloud/redis-cluster').v1;

  // Instantiates a client
  const clusterClient = new CloudRedisClusterClient();

  async function callExportBackup() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await clusterClient.exportBackup(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callExportBackup();

exportBackup(request, options, callback)

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;
Parameters
Name Description
request 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>
Returns
Type Description
void

exportBackup(request, callback)

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;
Parameters
Name Description
request IExportBackupRequest
callback Callback<LROperation<protos.google.cloud.redis.cluster.v1.IBackup, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

forwardingRulePath(project, region, forwardingRule)

forwardingRulePath(project: string, region: string, forwardingRule: string): string;

Return a fully-qualified forwardingRule resource name string.

Parameters
Name Description
project string
region string
forwardingRule string
Returns
Type Description
string

{string} Resource name string.

getBackup(request, options)

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
    ]>;

Gets the details of a specific backup.

Parameters
Name Description
request IGetBackupRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.redis.cluster.v1.IBackup, protos.google.cloud.redis.cluster.v1.IGetBackupRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Redis backup resource name using the form:
   *  `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}`
   */
  // const name = 'abc123'

  // Imports the Cluster library
  const {CloudRedisClusterClient} = require('@google-cloud/redis-cluster').v1;

  // Instantiates a client
  const clusterClient = new CloudRedisClusterClient();

  async function callGetBackup() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await clusterClient.getBackup(request);
    console.log(response);
  }

  callGetBackup();

getBackup(request, options, callback)

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;
Parameters
Name Description
request IGetBackupRequest
options CallOptions
callback Callback<protos.google.cloud.redis.cluster.v1.IBackup, protos.google.cloud.redis.cluster.v1.IGetBackupRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getBackup(request, callback)

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;
Parameters
Name Description
request IGetBackupRequest
callback Callback<protos.google.cloud.redis.cluster.v1.IBackup, protos.google.cloud.redis.cluster.v1.IGetBackupRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getBackupCollection(request, options)

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
    ]>;

Get a backup collection.

Parameters
Name Description
request IGetBackupCollectionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.redis.cluster.v1.IBackupCollection, (protos.google.cloud.redis.cluster.v1.IGetBackupCollectionRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing BackupCollection. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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.
   */
  // const name = 'abc123'

  // Imports the Cluster library
  const {CloudRedisClusterClient} = require('@google-cloud/redis-cluster').v1;

  // Instantiates a client
  const clusterClient = new CloudRedisClusterClient();

  async function callGetBackupCollection() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await clusterClient.getBackupCollection(request);
    console.log(response);
  }

  callGetBackupCollection();

getBackupCollection(request, options, callback)

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;
Parameters
Name Description
request IGetBackupCollectionRequest
options CallOptions
callback Callback<protos.google.cloud.redis.cluster.v1.IBackupCollection, protos.google.cloud.redis.cluster.v1.IGetBackupCollectionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getBackupCollection(request, callback)

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;
Parameters
Name Description
request IGetBackupCollectionRequest
callback Callback<protos.google.cloud.redis.cluster.v1.IBackupCollection, protos.google.cloud.redis.cluster.v1.IGetBackupCollectionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getCluster(request, options)

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
    ]>;

Gets the details of a specific Redis cluster.

Parameters
Name Description
request IGetClusterRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.redis.cluster.v1.ICluster, protos.google.cloud.redis.cluster.v1.IGetClusterRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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.
   */
  // const name = 'abc123'

  // Imports the Cluster library
  const {CloudRedisClusterClient} = require('@google-cloud/redis-cluster').v1;

  // Instantiates a client
  const clusterClient = new CloudRedisClusterClient();

  async function callGetCluster() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await clusterClient.getCluster(request);
    console.log(response);
  }

  callGetCluster();

getCluster(request, options, callback)

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;
Parameters
Name Description
request IGetClusterRequest
options CallOptions
callback Callback<protos.google.cloud.redis.cluster.v1.ICluster, protos.google.cloud.redis.cluster.v1.IGetClusterRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getCluster(request, callback)

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;
Parameters
Name Description
request IGetClusterRequest
callback Callback<protos.google.cloud.redis.cluster.v1.ICluster, protos.google.cloud.redis.cluster.v1.IGetClusterRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getClusterCertificateAuthority(request, options)

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
    ]>;

Gets the details of certificate authority information for Redis cluster.

Parameters
Name Description
request IGetClusterCertificateAuthorityRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.redis.cluster.v1.ICertificateAuthority, (protos.google.cloud.redis.cluster.v1.IGetClusterCertificateAuthorityRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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.
   */
  // const name = 'abc123'

  // Imports the Cluster library
  const {CloudRedisClusterClient} = require('@google-cloud/redis-cluster').v1;

  // Instantiates a client
  const clusterClient = new CloudRedisClusterClient();

  async function callGetClusterCertificateAuthority() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await clusterClient.getClusterCertificateAuthority(request);
    console.log(response);
  }

  callGetClusterCertificateAuthority();

getClusterCertificateAuthority(request, options, callback)

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;
Parameters
Name Description
request IGetClusterCertificateAuthorityRequest
options CallOptions
callback Callback<protos.google.cloud.redis.cluster.v1.ICertificateAuthority, protos.google.cloud.redis.cluster.v1.IGetClusterCertificateAuthorityRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getClusterCertificateAuthority(request, callback)

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;
Parameters
Name Description
request IGetClusterCertificateAuthorityRequest
callback Callback<protos.google.cloud.redis.cluster.v1.ICertificateAuthority, protos.google.cloud.redis.cluster.v1.IGetClusterCertificateAuthorityRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getLocation(request, options, callback)

getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;

Gets information about a location.

Parameters
Name Description
request LocationProtos.google.cloud.location.IGetLocationRequest

The request object that will be sent.

options CallOptions | Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>

Call options. See CallOptions for more details.

callback Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Returns
Type Description
Promise<google.cloud.location.ILocation>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

const [response] = await client.getLocation(request);

getOperation(request, optionsOrCallback, callback)

getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name Description
request GetOperationRequest

The request object that will be sent.

optionsOrCallback CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>
callback Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

Returns
Type Description
Promise<[protos.google.longrunning.Operation]>
Example

const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)

getProjectId()

getProjectId(): Promise<string>;
Returns
Type Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name Description
callback Callback<string, undefined, undefined>
Returns
Type Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

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
Type Description
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

listBackupCollections(request, options)

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
    ]>;

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.

Parameters
Name Description
request IListBackupCollectionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.redis.cluster.v1.IBackupCollection[], protos.google.cloud.redis.cluster.v1.IListBackupCollectionsRequest | null, protos.google.cloud.redis.cluster.v1.IListBackupCollectionsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of 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 documentation for more details and examples.

listBackupCollections(request, options, callback)

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;
Parameters
Name Description
request 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>
Returns
Type Description
void

listBackupCollections(request, callback)

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;
Parameters
Name Description
request 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>
Returns
Type Description
void

listBackupCollectionsAsync(request, options)

listBackupCollectionsAsync(request?: protos.google.cloud.redis.cluster.v1.IListBackupCollectionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.redis.cluster.v1.IBackupCollection>;

Equivalent to listBackupCollections, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request IListBackupCollectionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.redis.cluster.v1.IBackupCollection>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing BackupCollection. 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 documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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.
   */
  // const parent = 'abc123'
  /**
   *  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
   *  `next_page_token` google.cloud.redis.cluster.v1.ListBackupCollectionsResponse.next_page_token 
   *  to determine if there are more clusters left to be queried.
   */
  // const pageSize = 1234
  /**
   *  Optional. The `next_page_token` value returned from a previous
   *  ListBackupCollections  request, if any.
   */
  // const pageToken = 'abc123'

  // Imports the Cluster library
  const {CloudRedisClusterClient} = require('@google-cloud/redis-cluster').v1;

  // Instantiates a client
  const clusterClient = new CloudRedisClusterClient();

  async function callListBackupCollections() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = clusterClient.listBackupCollectionsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListBackupCollections();

listBackupCollectionsStream(request, options)

listBackupCollectionsStream(request?: protos.google.cloud.redis.cluster.v1.IListBackupCollectionsRequest, options?: CallOptions): Transform;

Equivalent to listBackupCollections, but returns a NodeJS Stream object.

Parameters
Name Description
request IListBackupCollectionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

{Stream} An object stream which emits an object representing BackupCollection 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 listBackupCollectionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listBackups(request, options)

listBackups(request?: protos.google.cloud.redis.cluster.v1.IListBackupsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.redis.cluster.v1.IBackup[],
        protos.google.cloud.redis.cluster.v1.IListBackupsRequest | null,
        protos.google.cloud.redis.cluster.v1.IListBackupsResponse
    ]>;

Lists all backups owned by a backup collection.

Parameters
Name Description
request IListBackupsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.redis.cluster.v1.IBackup[], protos.google.cloud.redis.cluster.v1.IListBackupsRequest | null, protos.google.cloud.redis.cluster.v1.IListBackupsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 listBackupsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listBackups(request, options, callback)

listBackups(request: protos.google.cloud.redis.cluster.v1.IListBackupsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.redis.cluster.v1.IListBackupsRequest, protos.google.cloud.redis.cluster.v1.IListBackupsResponse | null | undefined, protos.google.cloud.redis.cluster.v1.IBackup>): void;
Parameters
Name Description
request IListBackupsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.redis.cluster.v1.IListBackupsRequest, protos.google.cloud.redis.cluster.v1.IListBackupsResponse | null | undefined, protos.google.cloud.redis.cluster.v1.IBackup>
Returns
Type Description
void

listBackups(request, callback)

listBackups(request: protos.google.cloud.redis.cluster.v1.IListBackupsRequest, callback: PaginationCallback<protos.google.cloud.redis.cluster.v1.IListBackupsRequest, protos.google.cloud.redis.cluster.v1.IListBackupsResponse | null | undefined, protos.google.cloud.redis.cluster.v1.IBackup>): void;
Parameters
Name Description
request IListBackupsRequest
callback PaginationCallback<protos.google.cloud.redis.cluster.v1.IListBackupsRequest, protos.google.cloud.redis.cluster.v1.IListBackupsResponse | null | undefined, protos.google.cloud.redis.cluster.v1.IBackup>
Returns
Type Description
void

listBackupsAsync(request, options)

listBackupsAsync(request?: protos.google.cloud.redis.cluster.v1.IListBackupsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.redis.cluster.v1.IBackup>;

Equivalent to listBackups, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request IListBackupsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.redis.cluster.v1.IBackup>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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 documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the backupCollection using the form:
   *  `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}`
   */
  // const parent = 'abc123'
  /**
   *  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
   *  `next_page_token` google.cloud.redis.cluster.v1.ListBackupsResponse.next_page_token 
   *  to determine if there are more clusters left to be queried.
   */
  // const pageSize = 1234
  /**
   *  Optional. The `next_page_token` value returned from a previous
   *  ListBackupCollections  request, if any.
   */
  // const pageToken = 'abc123'

  // Imports the Cluster library
  const {CloudRedisClusterClient} = require('@google-cloud/redis-cluster').v1;

  // Instantiates a client
  const clusterClient = new CloudRedisClusterClient();

  async function callListBackups() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = clusterClient.listBackupsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListBackups();

listBackupsStream(request, options)

listBackupsStream(request?: protos.google.cloud.redis.cluster.v1.IListBackupsRequest, options?: CallOptions): Transform;

Equivalent to listBackups, but returns a NodeJS Stream object.

Parameters
Name Description
request IListBackupsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

{Stream} An object stream which emits an object representing 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 listBackupsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listClusters(request, options)

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
    ]>;

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.

Parameters
Name Description
request IListClustersRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ protos.google.cloud.redis.cluster.v1.ICluster[], protos.google.cloud.redis.cluster.v1.IListClustersRequest | null, protos.google.cloud.redis.cluster.v1.IListClustersResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 documentation for more details and examples.

listClusters(request, options, callback)

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;
Parameters
Name Description
request 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>
Returns
Type Description
void

listClusters(request, callback)

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;
Parameters
Name Description
request 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>
Returns
Type Description
void

listClustersAsync(request, options)

listClustersAsync(request?: protos.google.cloud.redis.cluster.v1.IListClustersRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.redis.cluster.v1.ICluster>;

Equivalent to listClusters, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request IListClustersRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<protos.google.cloud.redis.cluster.v1.ICluster>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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 documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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.
   */
  // const parent = 'abc123'
  /**
   *  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
   *  `next_page_token` google.cloud.redis.cluster.v1.ListClustersResponse.next_page_token 
   *  to determine if there are more clusters left to be queried.
   */
  // const pageSize = 1234
  /**
   *  The `next_page_token` value returned from a previous
   *  ListClusters CloudRedis.ListClusters  request, if any.
   */
  // const pageToken = 'abc123'

  // Imports the Cluster library
  const {CloudRedisClusterClient} = require('@google-cloud/redis-cluster').v1;

  // Instantiates a client
  const clusterClient = new CloudRedisClusterClient();

  async function callListClusters() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = clusterClient.listClustersAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListClusters();

listClustersStream(request, options)

listClustersStream(request?: protos.google.cloud.redis.cluster.v1.IListClustersRequest, options?: CallOptions): Transform;

Equivalent to listClusters, but returns a NodeJS Stream object.

Parameters
Name Description
request IListClustersRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Transform

{Stream} An object stream which emits an object representing 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 documentation for more details and examples.

listLocationsAsync(request, options)

listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;

Lists information about the supported locations for this service. Returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request LocationProtos.google.cloud.location.IListLocationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
AsyncIterable<google.cloud.location.ILocation>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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 documentation for more details and examples.

Example

const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
  // process response
}

listOperationsAsync(request, options)

listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.IOperation>;

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.

For-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters
Name Description
request ListOperationsRequest

The request object that will be sent.

options CallOptions

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Returns
Type Description
AsyncIterable<protos.google.longrunning.IOperation>

{Object} An iterable Object that conforms to iteration protocols.

Example

const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)

locationPath(project, location)

locationPath(project: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters
Name Description
project string
location string
Returns
Type Description
string

{string} Resource name string.

matchBackupCollectionFromBackupCollectionName(backupCollectionName)

matchBackupCollectionFromBackupCollectionName(backupCollectionName: string): string | number;

Parse the backup_collection from BackupCollection resource.

Parameter
Name Description
backupCollectionName string

A fully-qualified path representing BackupCollection resource.

Returns
Type Description
string | number

{string} A string representing the backup_collection.

matchBackupCollectionFromBackupName(backupName)

matchBackupCollectionFromBackupName(backupName: string): string | number;

Parse the backup_collection from Backup resource.

Parameter
Name Description
backupName string

A fully-qualified path representing Backup resource.

Returns
Type Description
string | number

{string} A string representing the backup_collection.

matchBackupFromBackupName(backupName)

matchBackupFromBackupName(backupName: string): string | number;

Parse the backup from Backup resource.

Parameter
Name Description
backupName string

A fully-qualified path representing Backup resource.

Returns
Type Description
string | number

{string} A string representing the backup.

matchClusterFromCertificateAuthorityName(certificateAuthorityName)

matchClusterFromCertificateAuthorityName(certificateAuthorityName: string): string | number;

Parse the cluster from CertificateAuthority resource.

Parameter
Name Description
certificateAuthorityName string

A fully-qualified path representing CertificateAuthority resource.

Returns
Type Description
string | number

{string} A string representing the cluster.

matchClusterFromClusterName(clusterName)

matchClusterFromClusterName(clusterName: string): string | number;

Parse the cluster from Cluster resource.

Parameter
Name Description
clusterName string

A fully-qualified path representing Cluster resource.

Returns
Type Description
string | number

{string} A string representing the cluster.

matchCryptoKeyFromCryptoKeyName(cryptoKeyName)

matchCryptoKeyFromCryptoKeyName(cryptoKeyName: string): string | number;

Parse the crypto_key from CryptoKey resource.

Parameter
Name Description
cryptoKeyName string

A fully-qualified path representing CryptoKey resource.

Returns
Type Description
string | number

{string} A string representing the crypto_key.

matchCryptoKeyFromCryptoKeyVersionName(cryptoKeyVersionName)

matchCryptoKeyFromCryptoKeyVersionName(cryptoKeyVersionName: string): string | number;

Parse the crypto_key from CryptoKeyVersion resource.

Parameter
Name Description
cryptoKeyVersionName string

A fully-qualified path representing CryptoKeyVersion resource.

Returns
Type Description
string | number

{string} A string representing the crypto_key.

matchCryptoKeyVersionFromCryptoKeyVersionName(cryptoKeyVersionName)

matchCryptoKeyVersionFromCryptoKeyVersionName(cryptoKeyVersionName: string): string | number;

Parse the crypto_key_version from CryptoKeyVersion resource.

Parameter
Name Description
cryptoKeyVersionName string

A fully-qualified path representing CryptoKeyVersion resource.

Returns
Type Description
string | number

{string} A string representing the crypto_key_version.

matchForwardingRuleFromForwardingRuleName(forwardingRuleName)

matchForwardingRuleFromForwardingRuleName(forwardingRuleName: string): string | number;

Parse the forwarding_rule from ForwardingRule resource.

Parameter
Name Description
forwardingRuleName string

A fully-qualified path representing ForwardingRule resource.

Returns
Type Description
string | number

{string} A string representing the forwarding_rule.

matchKeyRingFromCryptoKeyName(cryptoKeyName)

matchKeyRingFromCryptoKeyName(cryptoKeyName: string): string | number;

Parse the key_ring from CryptoKey resource.

Parameter
Name Description
cryptoKeyName string

A fully-qualified path representing CryptoKey resource.

Returns
Type Description
string | number

{string} A string representing the key_ring.

matchKeyRingFromCryptoKeyVersionName(cryptoKeyVersionName)

matchKeyRingFromCryptoKeyVersionName(cryptoKeyVersionName: string): string | number;

Parse the key_ring from CryptoKeyVersion resource.

Parameter
Name Description
cryptoKeyVersionName string

A fully-qualified path representing CryptoKeyVersion resource.

Returns
Type Description
string | number

{string} A string representing the key_ring.

matchLocationFromBackupCollectionName(backupCollectionName)

matchLocationFromBackupCollectionName(backupCollectionName: string): string | number;

Parse the location from BackupCollection resource.

Parameter
Name Description
backupCollectionName string

A fully-qualified path representing BackupCollection resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromBackupName(backupName)

matchLocationFromBackupName(backupName: string): string | number;

Parse the location from Backup resource.

Parameter
Name Description
backupName string

A fully-qualified path representing Backup resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromCertificateAuthorityName(certificateAuthorityName)

matchLocationFromCertificateAuthorityName(certificateAuthorityName: string): string | number;

Parse the location from CertificateAuthority resource.

Parameter
Name Description
certificateAuthorityName string

A fully-qualified path representing CertificateAuthority resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromClusterName(clusterName)

matchLocationFromClusterName(clusterName: string): string | number;

Parse the location from Cluster resource.

Parameter
Name Description
clusterName string

A fully-qualified path representing Cluster resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromCryptoKeyName(cryptoKeyName)

matchLocationFromCryptoKeyName(cryptoKeyName: string): string | number;

Parse the location from CryptoKey resource.

Parameter
Name Description
cryptoKeyName string

A fully-qualified path representing CryptoKey resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromCryptoKeyVersionName(cryptoKeyVersionName)

matchLocationFromCryptoKeyVersionName(cryptoKeyVersionName: string): string | number;

Parse the location from CryptoKeyVersion resource.

Parameter
Name Description
cryptoKeyVersionName string

A fully-qualified path representing CryptoKeyVersion resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
Name Description
locationName string

A fully-qualified path representing Location resource.

Returns
Type Description
string | number

{string} A string representing the location.

matchNetworkFromNetworkName(networkName)

matchNetworkFromNetworkName(networkName: string): string | number;

Parse the network from Network resource.

Parameter
Name Description
networkName string

A fully-qualified path representing Network resource.

Returns
Type Description
string | number

{string} A string representing the network.

matchProjectFromBackupCollectionName(backupCollectionName)

matchProjectFromBackupCollectionName(backupCollectionName: string): string | number;

Parse the project from BackupCollection resource.

Parameter
Name Description
backupCollectionName string

A fully-qualified path representing BackupCollection resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromBackupName(backupName)

matchProjectFromBackupName(backupName: string): string | number;

Parse the project from Backup resource.

Parameter
Name Description
backupName string

A fully-qualified path representing Backup resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromCertificateAuthorityName(certificateAuthorityName)

matchProjectFromCertificateAuthorityName(certificateAuthorityName: string): string | number;

Parse the project from CertificateAuthority resource.

Parameter
Name Description
certificateAuthorityName string

A fully-qualified path representing CertificateAuthority resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromClusterName(clusterName)

matchProjectFromClusterName(clusterName: string): string | number;

Parse the project from Cluster resource.

Parameter
Name Description
clusterName string

A fully-qualified path representing Cluster resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromCryptoKeyName(cryptoKeyName)

matchProjectFromCryptoKeyName(cryptoKeyName: string): string | number;

Parse the project from CryptoKey resource.

Parameter
Name Description
cryptoKeyName string

A fully-qualified path representing CryptoKey resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromCryptoKeyVersionName(cryptoKeyVersionName)

matchProjectFromCryptoKeyVersionName(cryptoKeyVersionName: string): string | number;

Parse the project from CryptoKeyVersion resource.

Parameter
Name Description
cryptoKeyVersionName string

A fully-qualified path representing CryptoKeyVersion resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromForwardingRuleName(forwardingRuleName)

matchProjectFromForwardingRuleName(forwardingRuleName: string): string | number;

Parse the project from ForwardingRule resource.

Parameter
Name Description
forwardingRuleName string

A fully-qualified path representing ForwardingRule resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
Name Description
locationName string

A fully-qualified path representing Location resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromNetworkName(networkName)

matchProjectFromNetworkName(networkName: string): string | number;

Parse the project from Network resource.

Parameter
Name Description
networkName string

A fully-qualified path representing Network resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
Name Description
projectName string

A fully-qualified path representing Project resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromServiceAttachmentName(serviceAttachmentName)

matchProjectFromServiceAttachmentName(serviceAttachmentName: string): string | number;

Parse the project from ServiceAttachment resource.

Parameter
Name Description
serviceAttachmentName string

A fully-qualified path representing ServiceAttachment resource.

Returns
Type Description
string | number

{string} A string representing the project.

matchRegionFromForwardingRuleName(forwardingRuleName)

matchRegionFromForwardingRuleName(forwardingRuleName: string): string | number;

Parse the region from ForwardingRule resource.

Parameter
Name Description
forwardingRuleName string

A fully-qualified path representing ForwardingRule resource.

Returns
Type Description
string | number

{string} A string representing the region.

matchRegionFromServiceAttachmentName(serviceAttachmentName)

matchRegionFromServiceAttachmentName(serviceAttachmentName: string): string | number;

Parse the region from ServiceAttachment resource.

Parameter
Name Description
serviceAttachmentName string

A fully-qualified path representing ServiceAttachment resource.

Returns
Type Description
string | number

{string} A string representing the region.

matchServiceAttachmentFromServiceAttachmentName(serviceAttachmentName)

matchServiceAttachmentFromServiceAttachmentName(serviceAttachmentName: string): string | number;

Parse the service_attachment from ServiceAttachment resource.

Parameter
Name Description
serviceAttachmentName string

A fully-qualified path representing ServiceAttachment resource.

Returns
Type Description
string | number

{string} A string representing the service_attachment.

networkPath(project, network)

networkPath(project: string, network: string): string;

Return a fully-qualified network resource name string.

Parameters
Name Description
project string
network string
Returns
Type Description
string

{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
Name Description
project string
Returns
Type Description
string

{string} Resource name string.

rescheduleClusterMaintenance(request, options)

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
    ]>;

Reschedules upcoming maintenance event.

Parameters
Name Description
request IRescheduleClusterMaintenanceRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.redis.cluster.v1.ICluster, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{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 documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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.
   */
  // const name = 'abc123'
  /**
   *  Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as
   *  well.
   */
  // const rescheduleType = {}
  /**
   *  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`.
   */
  // const scheduleTime = {}

  // Imports the Cluster library
  const {CloudRedisClusterClient} = require('@google-cloud/redis-cluster').v1;

  // Instantiates a client
  const clusterClient = new CloudRedisClusterClient();

  async function callRescheduleClusterMaintenance() {
    // Construct request
    const request = {
      name,
      rescheduleType,
    };

    // Run request
    const [operation] = await clusterClient.rescheduleClusterMaintenance(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callRescheduleClusterMaintenance();

rescheduleClusterMaintenance(request, options, callback)

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;
Parameters
Name Description
request 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>
Returns
Type Description
void

rescheduleClusterMaintenance(request, callback)

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;
Parameters
Name Description
request IRescheduleClusterMaintenanceRequest
callback Callback<LROperation<protos.google.cloud.redis.cluster.v1.ICluster, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

serviceAttachmentPath(project, region, serviceAttachment)

serviceAttachmentPath(project: string, region: string, serviceAttachment: string): string;

Return a fully-qualified serviceAttachment resource name string.

Parameters
Name Description
project string
region string
serviceAttachment string
Returns
Type Description
string

{string} Resource name string.

updateCluster(request, options)

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
    ]>;

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.

Parameters
Name Description
request IUpdateClusterRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
Type Description
Promise<[ LROperation<protos.google.cloud.redis.cluster.v1.ICluster, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{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 documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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 Cluster google.cloud.redis.cluster.v1.Cluster:
   *   *   `size_gb`
   *   *   `replica_count`
   */
  // const updateMask = {}
  /**
   *  Required. Update description.
   *  Only fields specified in update_mask are updated.
   */
  // const cluster = {}
  /**
   *  Idempotent request UUID.
   */
  // const requestId = 'abc123'

  // Imports the Cluster library
  const {CloudRedisClusterClient} = require('@google-cloud/redis-cluster').v1;

  // Instantiates a client
  const clusterClient = new CloudRedisClusterClient();

  async function callUpdateCluster() {
    // Construct request
    const request = {
      updateMask,
      cluster,
    };

    // Run request
    const [operation] = await clusterClient.updateCluster(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateCluster();

updateCluster(request, options, callback)

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;
Parameters
Name Description
request 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>
Returns
Type Description
void

updateCluster(request, callback)

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;
Parameters
Name Description
request IUpdateClusterRequest
callback Callback<LROperation<protos.google.cloud.redis.cluster.v1.ICluster, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void