Class v1beta1.CloudRedisClusterClient (0.1.0)

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

We use API version selector for Flex APIs * The versioning strategy is release-based versioning * Our backend CLH only deals with the superset version (called v1main) * Existing backend for Redis Gen1 and MRR is not touched. * More details in go/redis-flex-api-versioning v1beta1

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

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

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.

warn

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

Methods

cancelOperation(request, options, callback)

cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | 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.
`options`	`CallOptions \| Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} \| undefined \| null>` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
`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: ''});

checkCreateClusterProgress(name)

checkCreateClusterProgress(name: string): Promise<LROperation<protos.google.cloud.redis.cluster.v1beta1.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.v1beta1.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').v1beta1;

  // 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();

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').v1beta1;

  // 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();

checkUpdateClusterProgress(name)

checkUpdateClusterProgress(name: string): Promise<LROperation<protos.google.cloud.redis.cluster.v1beta1.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.v1beta1.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.v1beta1.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').v1beta1;

  // 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.v1beta1.ICreateClusterRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.redis.cluster.v1beta1.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.v1beta1.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').v1beta1;

  // 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.v1beta1.ICreateClusterRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.redis.cluster.v1beta1.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.v1beta1.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.v1beta1.ICreateClusterRequest, callback: Callback<LROperation<protos.google.cloud.redis.cluster.v1beta1.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.v1beta1.ICluster, 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.v1beta1.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').v1beta1;

  // 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.v1beta1.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.v1beta1.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, options, callback)

deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: 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.
`options`	`CallOptions \| Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} \| null \| undefined>` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
`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: ''});

getCluster(request, options)

getCluster(request?: protos.google.cloud.redis.cluster.v1beta1.IGetClusterRequest, options?: CallOptions): Promise<[
        protos.google.cloud.redis.cluster.v1beta1.ICluster,
        protos.google.cloud.redis.cluster.v1beta1.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.v1beta1.ICluster, protos.google.cloud.redis.cluster.v1beta1.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').v1beta1;

  // 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.v1beta1.IGetClusterRequest, options: CallOptions, callback: Callback<protos.google.cloud.redis.cluster.v1beta1.ICluster, protos.google.cloud.redis.cluster.v1beta1.IGetClusterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetClusterRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.redis.cluster.v1beta1.ICluster, protos.google.cloud.redis.cluster.v1beta1.IGetClusterRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getCluster(request, callback)

getCluster(request: protos.google.cloud.redis.cluster.v1beta1.IGetClusterRequest, callback: Callback<protos.google.cloud.redis.cluster.v1beta1.ICluster, protos.google.cloud.redis.cluster.v1beta1.IGetClusterRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetClusterRequest`
`callback`	`Callback<protos.google.cloud.redis.cluster.v1beta1.ICluster, protos.google.cloud.redis.cluster.v1beta1.IGetClusterRequest \| 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, options, callback)

getOperation(request: protos.google.longrunning.GetOperationRequest, options?: 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.
`options`	`CallOptions \| Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} \| null \| undefined>` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
`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.

listClusters(request, options)

listClusters(request?: protos.google.cloud.redis.cluster.v1beta1.IListClustersRequest, options?: CallOptions): Promise<[
        protos.google.cloud.redis.cluster.v1beta1.ICluster[],
        protos.google.cloud.redis.cluster.v1beta1.IListClustersRequest | null,
        protos.google.cloud.redis.cluster.v1beta1.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.v1beta1.ICluster[],
        protos.google.cloud.redis.cluster.v1beta1.IListClustersRequest | null,
        protos.google.cloud.redis.cluster.v1beta1.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.v1beta1.IListClustersRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.redis.cluster.v1beta1.IListClustersRequest, protos.google.cloud.redis.cluster.v1beta1.IListClustersResponse | null | undefined, protos.google.cloud.redis.cluster.v1beta1.ICluster>): void;

Parameters
Name	Description
`request`	`IListClustersRequest`
`options`	`CallOptions`
`callback`	`PaginationCallback<protos.google.cloud.redis.cluster.v1beta1.IListClustersRequest, protos.google.cloud.redis.cluster.v1beta1.IListClustersResponse \| null \| undefined, protos.google.cloud.redis.cluster.v1beta1.ICluster>`

Returns
Type	Description
`void`

listClusters(request, callback)

listClusters(request: protos.google.cloud.redis.cluster.v1beta1.IListClustersRequest, callback: PaginationCallback<protos.google.cloud.redis.cluster.v1beta1.IListClustersRequest, protos.google.cloud.redis.cluster.v1beta1.IListClustersResponse | null | undefined, protos.google.cloud.redis.cluster.v1beta1.ICluster>): void;

Parameters
Name	Description
`request`	`IListClustersRequest`
`callback`	`PaginationCallback<protos.google.cloud.redis.cluster.v1beta1.IListClustersRequest, protos.google.cloud.redis.cluster.v1beta1.IListClustersResponse \| null \| undefined, protos.google.cloud.redis.cluster.v1beta1.ICluster>`

Returns
Type	Description
`void`

listClustersAsync(request, options)

listClustersAsync(request?: protos.google.cloud.redis.cluster.v1beta1.IListClustersRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.redis.cluster.v1beta1.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.v1beta1.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.v1beta1.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').v1beta1;

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

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

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

  callListClusters();

listClustersStream(request, options)

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

Equivalent to method.name.toCamelCase(), 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.ListOperationsResponse>;

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.ListOperationsResponse>`	{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.

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.

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.

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.

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.

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.

updateCluster(request, options)

updateCluster(request?: protos.google.cloud.redis.cluster.v1beta1.IUpdateClusterRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.redis.cluster.v1beta1.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.v1beta1.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.v1beta1.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').v1beta1;

  // 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.v1beta1.IUpdateClusterRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.redis.cluster.v1beta1.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.v1beta1.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.v1beta1.IUpdateClusterRequest, callback: Callback<LROperation<protos.google.cloud.redis.cluster.v1beta1.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.v1beta1.ICluster, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`