Class v1beta1.CloudRedisClient (2.3.1)

Configures and manages Cloud Memorystore for Redis instances

Google Cloud Memorystore for Redis v1beta1

The redis.googleapis.com service implements the Google Cloud Memorystore for Redis API and defines the following resource model for managing Redis instances: * 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 instances, named: /instances/* * As such, Redis instances are resources of the form: /projects/{project_id}/locations/{location_id}/instances/{instance_id}

Note that location_id must be refering to a GCP region; for example: * projects/redpepper-1290/locations/us-central1/instances/my-redis v1beta1

Package

@google-cloud/redis

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of CloudRedisClient.

Parameter
Name Description
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

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

Property Value
Type Description
string

auth

auth: gax.GoogleAuth;
Property Value
Type Description
gax.GoogleAuth

cloudRedisStub

cloudRedisStub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
Type Description
Promise<{ [name: string]: Function; }>

descriptors

descriptors: Descriptors;
Property Value
Type Description
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };
Property Value
Type Description
{ [name: string]: Function; }

operationsClient

operationsClient: gax.OperationsClient;
Property Value
Type Description
gax.OperationsClient

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
Property Value
Type Description
{ [name: string]: gax.PathTemplate; }

port

static get port(): number;

The port for this API service.

Property Value
Type Description
number

scopes

static get scopes(): string[];

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

Property Value
Type Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
Type Description
string

warn

warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type Description
(code: string, message: string, warnType?: string) => void

Methods

checkCreateInstanceProgress(name)

checkCreateInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.redis.v1beta1.Instance, protos.google.protobuf.Any>>;

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

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.redis.v1beta1.Instance, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
Example

const decodedOperation = await checkCreateInstanceProgress(name); console.log(decodedOperation.result); console.log(decodedOperation.done); console.log(decodedOperation.metadata);

checkDeleteInstanceProgress(name)

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

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

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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
Example

const decodedOperation = await checkDeleteInstanceProgress(name); console.log(decodedOperation.result); console.log(decodedOperation.done); console.log(decodedOperation.metadata);

checkExportInstanceProgress(name)

checkExportInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.redis.v1beta1.Instance, protos.google.protobuf.Any>>;

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

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.redis.v1beta1.Instance, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
Example

const decodedOperation = await checkExportInstanceProgress(name); console.log(decodedOperation.result); console.log(decodedOperation.done); console.log(decodedOperation.metadata);

checkFailoverInstanceProgress(name)

checkFailoverInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.redis.v1beta1.Instance, protos.google.protobuf.Any>>;

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

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.redis.v1beta1.Instance, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
Example

const decodedOperation = await checkFailoverInstanceProgress(name); console.log(decodedOperation.result); console.log(decodedOperation.done); console.log(decodedOperation.metadata);

checkImportInstanceProgress(name)

checkImportInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.redis.v1beta1.Instance, protos.google.protobuf.Any>>;

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

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.redis.v1beta1.Instance, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
Example

const decodedOperation = await checkImportInstanceProgress(name); console.log(decodedOperation.result); console.log(decodedOperation.done); console.log(decodedOperation.metadata);

checkUpdateInstanceProgress(name)

checkUpdateInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.redis.v1beta1.Instance, protos.google.protobuf.Any>>;

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

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.redis.v1beta1.Instance, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
Example

const decodedOperation = await checkUpdateInstanceProgress(name); console.log(decodedOperation.result); console.log(decodedOperation.done); console.log(decodedOperation.metadata);

checkUpgradeInstanceProgress(name)

checkUpgradeInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.redis.v1beta1.Instance, protos.google.protobuf.Any>>;

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

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.redis.v1beta1.Instance, 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
Example

const decodedOperation = await checkUpgradeInstanceProgress(name); console.log(decodedOperation.result); console.log(decodedOperation.done); console.log(decodedOperation.metadata);

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.

createInstance(request, options)

createInstance(request?: protos.google.cloud.redis.v1beta1.ICreateInstanceRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.redis.v1beta1.ICreateInstanceRequest
options CallOptions
Returns
Type Description
Promise<[LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

createInstance(request, options, callback)

createInstance(request: protos.google.cloud.redis.v1beta1.ICreateInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.redis.v1beta1.ICreateInstanceRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createInstance(request, callback)

createInstance(request: protos.google.cloud.redis.v1beta1.ICreateInstanceRequest, callback: Callback<LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.redis.v1beta1.ICreateInstanceRequest
callback Callback<LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteInstance(request, options)

deleteInstance(request?: protos.google.cloud.redis.v1beta1.IDeleteInstanceRequest, options?: CallOptions): Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.redis.v1beta1.IDeleteInstanceRequest
options CallOptions
Returns
Type Description
Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

deleteInstance(request, options, callback)

deleteInstance(request: protos.google.cloud.redis.v1beta1.IDeleteInstanceRequest, 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 protos.google.cloud.redis.v1beta1.IDeleteInstanceRequest
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

deleteInstance(request, callback)

deleteInstance(request: protos.google.cloud.redis.v1beta1.IDeleteInstanceRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.redis.v1beta1.IDeleteInstanceRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

exportInstance(request, options)

exportInstance(request?: protos.google.cloud.redis.v1beta1.IExportInstanceRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.redis.v1beta1.IExportInstanceRequest
options CallOptions
Returns
Type Description
Promise<[LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

exportInstance(request, options, callback)

exportInstance(request: protos.google.cloud.redis.v1beta1.IExportInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.redis.v1beta1.IExportInstanceRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

exportInstance(request, callback)

exportInstance(request: protos.google.cloud.redis.v1beta1.IExportInstanceRequest, callback: Callback<LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.redis.v1beta1.IExportInstanceRequest
callback Callback<LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

failoverInstance(request, options)

failoverInstance(request?: protos.google.cloud.redis.v1beta1.IFailoverInstanceRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.redis.v1beta1.IFailoverInstanceRequest
options CallOptions
Returns
Type Description
Promise<[LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

failoverInstance(request, options, callback)

failoverInstance(request: protos.google.cloud.redis.v1beta1.IFailoverInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.redis.v1beta1.IFailoverInstanceRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

failoverInstance(request, callback)

failoverInstance(request: protos.google.cloud.redis.v1beta1.IFailoverInstanceRequest, callback: Callback<LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.redis.v1beta1.IFailoverInstanceRequest
callback Callback<LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

getInstance(request, options)

getInstance(request?: protos.google.cloud.redis.v1beta1.IGetInstanceRequest, options?: CallOptions): Promise<[protos.google.cloud.redis.v1beta1.IInstance, protos.google.cloud.redis.v1beta1.IGetInstanceRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.redis.v1beta1.IGetInstanceRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.redis.v1beta1.IInstance, protos.google.cloud.redis.v1beta1.IGetInstanceRequest | undefined, {} | undefined]>

getInstance(request, options, callback)

getInstance(request: protos.google.cloud.redis.v1beta1.IGetInstanceRequest, options: CallOptions, callback: Callback<protos.google.cloud.redis.v1beta1.IInstance, protos.google.cloud.redis.v1beta1.IGetInstanceRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.redis.v1beta1.IGetInstanceRequest
options CallOptions
callback Callback<protos.google.cloud.redis.v1beta1.IInstance, protos.google.cloud.redis.v1beta1.IGetInstanceRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getInstance(request, callback)

getInstance(request: protos.google.cloud.redis.v1beta1.IGetInstanceRequest, callback: Callback<protos.google.cloud.redis.v1beta1.IInstance, protos.google.cloud.redis.v1beta1.IGetInstanceRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.redis.v1beta1.IGetInstanceRequest
callback Callback<protos.google.cloud.redis.v1beta1.IInstance, protos.google.cloud.redis.v1beta1.IGetInstanceRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

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

importInstance(request, options)

importInstance(request?: protos.google.cloud.redis.v1beta1.IImportInstanceRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.redis.v1beta1.IImportInstanceRequest
options CallOptions
Returns
Type Description
Promise<[LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

importInstance(request, options, callback)

importInstance(request: protos.google.cloud.redis.v1beta1.IImportInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.redis.v1beta1.IImportInstanceRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

importInstance(request, callback)

importInstance(request: protos.google.cloud.redis.v1beta1.IImportInstanceRequest, callback: Callback<LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.redis.v1beta1.IImportInstanceRequest
callback Callback<LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | 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.

instancePath(project, location, instance)

instancePath(project: string, location: string, instance: string): string;

Return a fully-qualified instance resource name string.

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

{string} Resource name string.

listInstances(request, options)

listInstances(request?: protos.google.cloud.redis.v1beta1.IListInstancesRequest, options?: CallOptions): Promise<[protos.google.cloud.redis.v1beta1.IInstance[], protos.google.cloud.redis.v1beta1.IListInstancesRequest | null, protos.google.cloud.redis.v1beta1.IListInstancesResponse]>;
Parameters
Name Description
request protos.google.cloud.redis.v1beta1.IListInstancesRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.redis.v1beta1.IInstance[], protos.google.cloud.redis.v1beta1.IListInstancesRequest | null, protos.google.cloud.redis.v1beta1.IListInstancesResponse]>

listInstances(request, options, callback)

listInstances(request: protos.google.cloud.redis.v1beta1.IListInstancesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.redis.v1beta1.IListInstancesRequest, protos.google.cloud.redis.v1beta1.IListInstancesResponse | null | undefined, protos.google.cloud.redis.v1beta1.IInstance>): void;
Parameters
Name Description
request protos.google.cloud.redis.v1beta1.IListInstancesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.redis.v1beta1.IListInstancesRequest, protos.google.cloud.redis.v1beta1.IListInstancesResponse | null | undefined, protos.google.cloud.redis.v1beta1.IInstance>
Returns
Type Description
void

listInstances(request, callback)

listInstances(request: protos.google.cloud.redis.v1beta1.IListInstancesRequest, callback: PaginationCallback<protos.google.cloud.redis.v1beta1.IListInstancesRequest, protos.google.cloud.redis.v1beta1.IListInstancesResponse | null | undefined, protos.google.cloud.redis.v1beta1.IInstance>): void;
Parameters
Name Description
request protos.google.cloud.redis.v1beta1.IListInstancesRequest
callback PaginationCallback<protos.google.cloud.redis.v1beta1.IListInstancesRequest, protos.google.cloud.redis.v1beta1.IListInstancesResponse | null | undefined, protos.google.cloud.redis.v1beta1.IInstance>
Returns
Type Description
void

listInstancesAsync(request, options)

listInstancesAsync(request?: protos.google.cloud.redis.v1beta1.IListInstancesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.redis.v1beta1.IInstance>;

Equivalent to listInstances, but returns an iterable object.

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

Parameters
Name Description
request protos.google.cloud.redis.v1beta1.IListInstancesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.redis.v1beta1.IInstance>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Instance]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
Example

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

listInstancesStream(request, options)

listInstancesStream(request?: protos.google.cloud.redis.v1beta1.IListInstancesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request protos.google.cloud.redis.v1beta1.IListInstancesRequest

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 [Instance] 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 listInstancesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

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.

matchInstanceFromInstanceName(instanceName)

matchInstanceFromInstanceName(instanceName: string): string | number;

Parse the instance from Instance resource.

Parameter
Name Description
instanceName string

A fully-qualified path representing Instance resource.
Returns
Type Description
string | number

{string} A string representing the instance.

matchLocationFromInstanceName(instanceName)

matchLocationFromInstanceName(instanceName: string): string | number;

Parse the location from Instance resource.

Parameter
Name Description
instanceName string

A fully-qualified path representing Instance 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.

matchProjectFromInstanceName(instanceName)

matchProjectFromInstanceName(instanceName: string): string | number;

Parse the project from Instance resource.

Parameter
Name Description
instanceName string

A fully-qualified path representing Instance 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.

updateInstance(request, options)

updateInstance(request?: protos.google.cloud.redis.v1beta1.IUpdateInstanceRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.redis.v1beta1.IUpdateInstanceRequest
options CallOptions
Returns
Type Description
Promise<[LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

updateInstance(request, options, callback)

updateInstance(request: protos.google.cloud.redis.v1beta1.IUpdateInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.redis.v1beta1.IUpdateInstanceRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateInstance(request, callback)

updateInstance(request: protos.google.cloud.redis.v1beta1.IUpdateInstanceRequest, callback: Callback<LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.redis.v1beta1.IUpdateInstanceRequest
callback Callback<LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

upgradeInstance(request, options)

upgradeInstance(request?: protos.google.cloud.redis.v1beta1.IUpgradeInstanceRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.redis.v1beta1.IUpgradeInstanceRequest
options CallOptions
Returns
Type Description
Promise<[LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

upgradeInstance(request, options, callback)

upgradeInstance(request: protos.google.cloud.redis.v1beta1.IUpgradeInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.redis.v1beta1.IUpgradeInstanceRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

upgradeInstance(request, callback)

upgradeInstance(request: protos.google.cloud.redis.v1beta1.IUpgradeInstanceRequest, callback: Callback<LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.redis.v1beta1.IUpgradeInstanceRequest
callback Callback<LROperation<protos.google.cloud.redis.v1beta1.IInstance, protos.google.protobuf.IAny>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void