Class protos.google.cloud.redis.cluster.v1.CloudRedisCluster (0.1.0)

Represents a CloudRedisCluster

Inheritance

$protobuf.rpc.Service > protos.google.cloud.redis.cluster.v1.CloudRedisCluster

Package

@google-cloud/redis-cluster

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new CloudRedisCluster service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): CloudRedisCluster;

Creates new CloudRedisCluster service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Returns
Type Description
CloudRedisCluster

RPC service. Useful where requests and/or responses are streamed.

createCluster(request, callback)

public createCluster(request: google.cloud.redis.cluster.v1.ICreateClusterRequest, callback: google.cloud.redis.cluster.v1.CloudRedisCluster.CreateClusterCallback): void;

Calls CreateCluster.

Parameters
Name Description
request ICreateClusterRequest

CreateClusterRequest message or plain object

callback CreateClusterCallback

Node-style callback called with the error, if any, and Operation

Returns
Type Description
void

createCluster(request)

public createCluster(request: google.cloud.redis.cluster.v1.ICreateClusterRequest): Promise<google.longrunning.Operation>;

Calls CreateCluster.

Parameter
Name Description
request ICreateClusterRequest

CreateClusterRequest message or plain object

Returns
Type Description
Promise<google.longrunning.Operation>

Promise

deleteCluster(request, callback)

public deleteCluster(request: google.cloud.redis.cluster.v1.IDeleteClusterRequest, callback: google.cloud.redis.cluster.v1.CloudRedisCluster.DeleteClusterCallback): void;

Calls DeleteCluster.

Parameters
Name Description
request IDeleteClusterRequest

DeleteClusterRequest message or plain object

callback DeleteClusterCallback

Node-style callback called with the error, if any, and Operation

Returns
Type Description
void

deleteCluster(request)

public deleteCluster(request: google.cloud.redis.cluster.v1.IDeleteClusterRequest): Promise<google.longrunning.Operation>;

Calls DeleteCluster.

Parameter
Name Description
request IDeleteClusterRequest

DeleteClusterRequest message or plain object

Returns
Type Description
Promise<google.longrunning.Operation>

Promise

getCluster(request, callback)

public getCluster(request: google.cloud.redis.cluster.v1.IGetClusterRequest, callback: google.cloud.redis.cluster.v1.CloudRedisCluster.GetClusterCallback): void;

Calls GetCluster.

Parameters
Name Description
request IGetClusterRequest

GetClusterRequest message or plain object

callback GetClusterCallback

Node-style callback called with the error, if any, and Cluster

Returns
Type Description
void

getCluster(request)

public getCluster(request: google.cloud.redis.cluster.v1.IGetClusterRequest): Promise<google.cloud.redis.cluster.v1.Cluster>;

Calls GetCluster.

Parameter
Name Description
request IGetClusterRequest

GetClusterRequest message or plain object

Returns
Type Description
Promise<google.cloud.redis.cluster.v1.Cluster>

Promise

listClusters(request, callback)

public listClusters(request: google.cloud.redis.cluster.v1.IListClustersRequest, callback: google.cloud.redis.cluster.v1.CloudRedisCluster.ListClustersCallback): void;

Calls ListClusters.

Parameters
Name Description
request IListClustersRequest

ListClustersRequest message or plain object

callback ListClustersCallback

Node-style callback called with the error, if any, and ListClustersResponse

Returns
Type Description
void

listClusters(request)

public listClusters(request: google.cloud.redis.cluster.v1.IListClustersRequest): Promise<google.cloud.redis.cluster.v1.ListClustersResponse>;

Calls ListClusters.

Parameter
Name Description
request IListClustersRequest

ListClustersRequest message or plain object

Returns
Type Description
Promise<google.cloud.redis.cluster.v1.ListClustersResponse>

Promise

updateCluster(request, callback)

public updateCluster(request: google.cloud.redis.cluster.v1.IUpdateClusterRequest, callback: google.cloud.redis.cluster.v1.CloudRedisCluster.UpdateClusterCallback): void;

Calls UpdateCluster.

Parameters
Name Description
request IUpdateClusterRequest

UpdateClusterRequest message or plain object

callback UpdateClusterCallback

Node-style callback called with the error, if any, and Operation

Returns
Type Description
void

updateCluster(request)

public updateCluster(request: google.cloud.redis.cluster.v1.IUpdateClusterRequest): Promise<google.longrunning.Operation>;

Calls UpdateCluster.

Parameter
Name Description
request IUpdateClusterRequest

UpdateClusterRequest message or plain object

Returns
Type Description
Promise<google.longrunning.Operation>

Promise