Class protos.google.cloud.redis.cluster.v1.CloudRedisCluster (0.8.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

backupCluster(request, callback)

public backupCluster(request: google.cloud.redis.cluster.v1.IBackupClusterRequest, callback: google.cloud.redis.cluster.v1.CloudRedisCluster.BackupClusterCallback): void;

Calls BackupCluster.

Parameters
Name Description
request IBackupClusterRequest

BackupClusterRequest message or plain object
callback BackupClusterCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

backupCluster(request)

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

Calls BackupCluster.

Parameter
Name Description
request IBackupClusterRequest

BackupClusterRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

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

deleteBackup(request, callback)

public deleteBackup(request: google.cloud.redis.cluster.v1.IDeleteBackupRequest, callback: google.cloud.redis.cluster.v1.CloudRedisCluster.DeleteBackupCallback): void;

Calls DeleteBackup.

Parameters
Name Description
request IDeleteBackupRequest

DeleteBackupRequest message or plain object
callback DeleteBackupCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deleteBackup(request)

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

Calls DeleteBackup.

Parameter
Name Description
request IDeleteBackupRequest

DeleteBackupRequest 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

exportBackup(request, callback)

public exportBackup(request: google.cloud.redis.cluster.v1.IExportBackupRequest, callback: google.cloud.redis.cluster.v1.CloudRedisCluster.ExportBackupCallback): void;

Calls ExportBackup.

Parameters
Name Description
request IExportBackupRequest

ExportBackupRequest message or plain object
callback ExportBackupCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

exportBackup(request)

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

Calls ExportBackup.

Parameter
Name Description
request IExportBackupRequest

ExportBackupRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

getBackup(request, callback)

public getBackup(request: google.cloud.redis.cluster.v1.IGetBackupRequest, callback: google.cloud.redis.cluster.v1.CloudRedisCluster.GetBackupCallback): void;

Calls GetBackup.

Parameters
Name Description
request IGetBackupRequest

GetBackupRequest message or plain object
callback GetBackupCallback

Node-style callback called with the error, if any, and Backup
Returns
Type Description
void

getBackup(request)

public getBackup(request: google.cloud.redis.cluster.v1.IGetBackupRequest): Promise<google.cloud.redis.cluster.v1.Backup>;

Calls GetBackup.

Parameter
Name Description
request IGetBackupRequest

GetBackupRequest message or plain object
Returns
Type Description
Promise<google.cloud.redis.cluster.v1.Backup>

Promise

getBackupCollection(request, callback)

public getBackupCollection(request: google.cloud.redis.cluster.v1.IGetBackupCollectionRequest, callback: google.cloud.redis.cluster.v1.CloudRedisCluster.GetBackupCollectionCallback): void;

Calls GetBackupCollection.

Parameters
Name Description
request IGetBackupCollectionRequest

GetBackupCollectionRequest message or plain object
callback GetBackupCollectionCallback

Node-style callback called with the error, if any, and BackupCollection
Returns
Type Description
void

getBackupCollection(request)

public getBackupCollection(request: google.cloud.redis.cluster.v1.IGetBackupCollectionRequest): Promise<google.cloud.redis.cluster.v1.BackupCollection>;

Calls GetBackupCollection.

Parameter
Name Description
request IGetBackupCollectionRequest

GetBackupCollectionRequest message or plain object
Returns
Type Description
Promise<google.cloud.redis.cluster.v1.BackupCollection>

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

getClusterCertificateAuthority(request, callback)

public getClusterCertificateAuthority(request: google.cloud.redis.cluster.v1.IGetClusterCertificateAuthorityRequest, callback: google.cloud.redis.cluster.v1.CloudRedisCluster.GetClusterCertificateAuthorityCallback): void;

Calls GetClusterCertificateAuthority.

Parameters
Name Description
request IGetClusterCertificateAuthorityRequest

GetClusterCertificateAuthorityRequest message or plain object
callback GetClusterCertificateAuthorityCallback

Node-style callback called with the error, if any, and CertificateAuthority
Returns
Type Description
void

getClusterCertificateAuthority(request)

public getClusterCertificateAuthority(request: google.cloud.redis.cluster.v1.IGetClusterCertificateAuthorityRequest): Promise<google.cloud.redis.cluster.v1.CertificateAuthority>;

Calls GetClusterCertificateAuthority.

Parameter
Name Description
request IGetClusterCertificateAuthorityRequest

GetClusterCertificateAuthorityRequest message or plain object
Returns
Type Description
Promise<google.cloud.redis.cluster.v1.CertificateAuthority>

Promise

listBackupCollections(request, callback)

public listBackupCollections(request: google.cloud.redis.cluster.v1.IListBackupCollectionsRequest, callback: google.cloud.redis.cluster.v1.CloudRedisCluster.ListBackupCollectionsCallback): void;

Calls ListBackupCollections.

Parameters
Name Description
request IListBackupCollectionsRequest

ListBackupCollectionsRequest message or plain object
callback ListBackupCollectionsCallback

Node-style callback called with the error, if any, and ListBackupCollectionsResponse
Returns
Type Description
void

listBackupCollections(request)

public listBackupCollections(request: google.cloud.redis.cluster.v1.IListBackupCollectionsRequest): Promise<google.cloud.redis.cluster.v1.ListBackupCollectionsResponse>;

Calls ListBackupCollections.

Parameter
Name Description
request IListBackupCollectionsRequest

ListBackupCollectionsRequest message or plain object
Returns
Type Description
Promise<google.cloud.redis.cluster.v1.ListBackupCollectionsResponse>

Promise

listBackups(request, callback)

public listBackups(request: google.cloud.redis.cluster.v1.IListBackupsRequest, callback: google.cloud.redis.cluster.v1.CloudRedisCluster.ListBackupsCallback): void;

Calls ListBackups.

Parameters
Name Description
request IListBackupsRequest

ListBackupsRequest message or plain object
callback ListBackupsCallback

Node-style callback called with the error, if any, and ListBackupsResponse
Returns
Type Description
void

listBackups(request)

public listBackups(request: google.cloud.redis.cluster.v1.IListBackupsRequest): Promise<google.cloud.redis.cluster.v1.ListBackupsResponse>;

Calls ListBackups.

Parameter
Name Description
request IListBackupsRequest

ListBackupsRequest message or plain object
Returns
Type Description
Promise<google.cloud.redis.cluster.v1.ListBackupsResponse>

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

rescheduleClusterMaintenance(request, callback)

public rescheduleClusterMaintenance(request: google.cloud.redis.cluster.v1.IRescheduleClusterMaintenanceRequest, callback: google.cloud.redis.cluster.v1.CloudRedisCluster.RescheduleClusterMaintenanceCallback): void;

Calls RescheduleClusterMaintenance.

Parameters
Name Description
request IRescheduleClusterMaintenanceRequest

RescheduleClusterMaintenanceRequest message or plain object
callback RescheduleClusterMaintenanceCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

rescheduleClusterMaintenance(request)

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

Calls RescheduleClusterMaintenance.

Parameter
Name Description
request IRescheduleClusterMaintenanceRequest

RescheduleClusterMaintenanceRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

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