Class protos.google.cloud.memorystore.v1.Memorystore (0.4.0)

Represents a Memorystore

Inheritance

$protobuf.rpc.Service > protos.google.cloud.memorystore.v1.Memorystore

Package

@google-cloud/memorystore

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new Memorystore service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

backupInstance(request, callback)

public backupInstance(request: google.cloud.memorystore.v1.IBackupInstanceRequest, callback: google.cloud.memorystore.v1.Memorystore.BackupInstanceCallback): void;

Calls BackupInstance.

Parameters
Name Description
request IBackupInstanceRequest

BackupInstanceRequest message or plain object
callback BackupInstanceCallback

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

backupInstance(request)

public backupInstance(request: google.cloud.memorystore.v1.IBackupInstanceRequest): Promise<google.longrunning.Operation>;

Calls BackupInstance.

Parameter
Name Description
request IBackupInstanceRequest

BackupInstanceRequest 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): Memorystore;

Creates new Memorystore 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
Memorystore

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

createInstance(request, callback)

public createInstance(request: google.cloud.memorystore.v1.ICreateInstanceRequest, callback: google.cloud.memorystore.v1.Memorystore.CreateInstanceCallback): void;

Calls CreateInstance.

Parameters
Name Description
request ICreateInstanceRequest

CreateInstanceRequest message or plain object
callback CreateInstanceCallback

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

createInstance(request)

public createInstance(request: google.cloud.memorystore.v1.ICreateInstanceRequest): Promise<google.longrunning.Operation>;

Calls CreateInstance.

Parameter
Name Description
request ICreateInstanceRequest

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

Promise

deleteBackup(request, callback)

public deleteBackup(request: google.cloud.memorystore.v1.IDeleteBackupRequest, callback: google.cloud.memorystore.v1.Memorystore.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.memorystore.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

deleteInstance(request, callback)

public deleteInstance(request: google.cloud.memorystore.v1.IDeleteInstanceRequest, callback: google.cloud.memorystore.v1.Memorystore.DeleteInstanceCallback): void;

Calls DeleteInstance.

Parameters
Name Description
request IDeleteInstanceRequest

DeleteInstanceRequest message or plain object
callback DeleteInstanceCallback

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

deleteInstance(request)

public deleteInstance(request: google.cloud.memorystore.v1.IDeleteInstanceRequest): Promise<google.longrunning.Operation>;

Calls DeleteInstance.

Parameter
Name Description
request IDeleteInstanceRequest

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

Promise

exportBackup(request, callback)

public exportBackup(request: google.cloud.memorystore.v1.IExportBackupRequest, callback: google.cloud.memorystore.v1.Memorystore.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.memorystore.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.memorystore.v1.IGetBackupRequest, callback: google.cloud.memorystore.v1.Memorystore.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.memorystore.v1.IGetBackupRequest): Promise<google.cloud.memorystore.v1.Backup>;

Calls GetBackup.

Parameter
Name Description
request IGetBackupRequest

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

Promise

getBackupCollection(request, callback)

public getBackupCollection(request: google.cloud.memorystore.v1.IGetBackupCollectionRequest, callback: google.cloud.memorystore.v1.Memorystore.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.memorystore.v1.IGetBackupCollectionRequest): Promise<google.cloud.memorystore.v1.BackupCollection>;

Calls GetBackupCollection.

Parameter
Name Description
request IGetBackupCollectionRequest

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

Promise

getCertificateAuthority(request, callback)

public getCertificateAuthority(request: google.cloud.memorystore.v1.IGetCertificateAuthorityRequest, callback: google.cloud.memorystore.v1.Memorystore.GetCertificateAuthorityCallback): void;

Calls GetCertificateAuthority.

Parameters
Name Description
request IGetCertificateAuthorityRequest

GetCertificateAuthorityRequest message or plain object
callback GetCertificateAuthorityCallback

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

getCertificateAuthority(request)

public getCertificateAuthority(request: google.cloud.memorystore.v1.IGetCertificateAuthorityRequest): Promise<google.cloud.memorystore.v1.CertificateAuthority>;

Calls GetCertificateAuthority.

Parameter
Name Description
request IGetCertificateAuthorityRequest

GetCertificateAuthorityRequest message or plain object
Returns
Type Description
Promise<google.cloud.memorystore.v1.CertificateAuthority>

Promise

getInstance(request, callback)

public getInstance(request: google.cloud.memorystore.v1.IGetInstanceRequest, callback: google.cloud.memorystore.v1.Memorystore.GetInstanceCallback): void;

Calls GetInstance.

Parameters
Name Description
request IGetInstanceRequest

GetInstanceRequest message or plain object
callback GetInstanceCallback

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

getInstance(request)

public getInstance(request: google.cloud.memorystore.v1.IGetInstanceRequest): Promise<google.cloud.memorystore.v1.Instance>;

Calls GetInstance.

Parameter
Name Description
request IGetInstanceRequest

GetInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.memorystore.v1.Instance>

Promise

listBackupCollections(request, callback)

public listBackupCollections(request: google.cloud.memorystore.v1.IListBackupCollectionsRequest, callback: google.cloud.memorystore.v1.Memorystore.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.memorystore.v1.IListBackupCollectionsRequest): Promise<google.cloud.memorystore.v1.ListBackupCollectionsResponse>;

Calls ListBackupCollections.

Parameter
Name Description
request IListBackupCollectionsRequest

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

Promise

listBackups(request, callback)

public listBackups(request: google.cloud.memorystore.v1.IListBackupsRequest, callback: google.cloud.memorystore.v1.Memorystore.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.memorystore.v1.IListBackupsRequest): Promise<google.cloud.memorystore.v1.ListBackupsResponse>;

Calls ListBackups.

Parameter
Name Description
request IListBackupsRequest

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

Promise

listInstances(request, callback)

public listInstances(request: google.cloud.memorystore.v1.IListInstancesRequest, callback: google.cloud.memorystore.v1.Memorystore.ListInstancesCallback): void;

Calls ListInstances.

Parameters
Name Description
request IListInstancesRequest

ListInstancesRequest message or plain object
callback ListInstancesCallback

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

listInstances(request)

public listInstances(request: google.cloud.memorystore.v1.IListInstancesRequest): Promise<google.cloud.memorystore.v1.ListInstancesResponse>;

Calls ListInstances.

Parameter
Name Description
request IListInstancesRequest

ListInstancesRequest message or plain object
Returns
Type Description
Promise<google.cloud.memorystore.v1.ListInstancesResponse>

Promise

rescheduleMaintenance(request, callback)

public rescheduleMaintenance(request: google.cloud.memorystore.v1.IRescheduleMaintenanceRequest, callback: google.cloud.memorystore.v1.Memorystore.RescheduleMaintenanceCallback): void;

Calls RescheduleMaintenance.

Parameters
Name Description
request IRescheduleMaintenanceRequest

RescheduleMaintenanceRequest message or plain object
callback RescheduleMaintenanceCallback

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

rescheduleMaintenance(request)

public rescheduleMaintenance(request: google.cloud.memorystore.v1.IRescheduleMaintenanceRequest): Promise<google.longrunning.Operation>;

Calls RescheduleMaintenance.

Parameter
Name Description
request IRescheduleMaintenanceRequest

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

Promise

updateInstance(request, callback)

public updateInstance(request: google.cloud.memorystore.v1.IUpdateInstanceRequest, callback: google.cloud.memorystore.v1.Memorystore.UpdateInstanceCallback): void;

Calls UpdateInstance.

Parameters
Name Description
request IUpdateInstanceRequest

UpdateInstanceRequest message or plain object
callback UpdateInstanceCallback

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

updateInstance(request)

public updateInstance(request: google.cloud.memorystore.v1.IUpdateInstanceRequest): Promise<google.longrunning.Operation>;

Calls UpdateInstance.

Parameter
Name Description
request IUpdateInstanceRequest

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

Promise