Class protos.google.cloud.memorystore.v1beta.Memorystore (0.8.0)

Represents a Memorystore

Inheritance

$protobuf.rpc.Service > protos.google.cloud.memorystore.v1beta.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

addAuthToken(request, callback)

public addAuthToken(request: google.cloud.memorystore.v1beta.IAddAuthTokenRequest, callback: google.cloud.memorystore.v1beta.Memorystore.AddAuthTokenCallback): void;

Calls AddAuthToken.

Parameters
Name Description
request IAddAuthTokenRequest

AddAuthTokenRequest message or plain object
callback AddAuthTokenCallback

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

addAuthToken(request)

public addAuthToken(request: google.cloud.memorystore.v1beta.IAddAuthTokenRequest): Promise<google.longrunning.Operation>;

Calls AddAuthToken.

Parameter
Name Description
request IAddAuthTokenRequest

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

Promise

addTokenAuthUser(request, callback)

public addTokenAuthUser(request: google.cloud.memorystore.v1beta.IAddTokenAuthUserRequest, callback: google.cloud.memorystore.v1beta.Memorystore.AddTokenAuthUserCallback): void;

Calls AddTokenAuthUser.

Parameters
Name Description
request IAddTokenAuthUserRequest

AddTokenAuthUserRequest message or plain object
callback AddTokenAuthUserCallback

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

addTokenAuthUser(request)

public addTokenAuthUser(request: google.cloud.memorystore.v1beta.IAddTokenAuthUserRequest): Promise<google.longrunning.Operation>;

Calls AddTokenAuthUser.

Parameter
Name Description
request IAddTokenAuthUserRequest

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

Promise

backupInstance(request, callback)

public backupInstance(request: google.cloud.memorystore.v1beta.IBackupInstanceRequest, callback: google.cloud.memorystore.v1beta.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.v1beta.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.v1beta.ICreateInstanceRequest, callback: google.cloud.memorystore.v1beta.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.v1beta.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

deleteAuthToken(request, callback)

public deleteAuthToken(request: google.cloud.memorystore.v1beta.IDeleteAuthTokenRequest, callback: google.cloud.memorystore.v1beta.Memorystore.DeleteAuthTokenCallback): void;

Calls DeleteAuthToken.

Parameters
Name Description
request IDeleteAuthTokenRequest

DeleteAuthTokenRequest message or plain object
callback DeleteAuthTokenCallback

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

deleteAuthToken(request)

public deleteAuthToken(request: google.cloud.memorystore.v1beta.IDeleteAuthTokenRequest): Promise<google.longrunning.Operation>;

Calls DeleteAuthToken.

Parameter
Name Description
request IDeleteAuthTokenRequest

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

Promise

deleteBackup(request, callback)

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

deleteTokenAuthUser(request, callback)

public deleteTokenAuthUser(request: google.cloud.memorystore.v1beta.IDeleteTokenAuthUserRequest, callback: google.cloud.memorystore.v1beta.Memorystore.DeleteTokenAuthUserCallback): void;

Calls DeleteTokenAuthUser.

Parameters
Name Description
request IDeleteTokenAuthUserRequest

DeleteTokenAuthUserRequest message or plain object
callback DeleteTokenAuthUserCallback

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

deleteTokenAuthUser(request)

public deleteTokenAuthUser(request: google.cloud.memorystore.v1beta.IDeleteTokenAuthUserRequest): Promise<google.longrunning.Operation>;

Calls DeleteTokenAuthUser.

Parameter
Name Description
request IDeleteTokenAuthUserRequest

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

Promise

exportBackup(request, callback)

public exportBackup(request: google.cloud.memorystore.v1beta.IExportBackupRequest, callback: google.cloud.memorystore.v1beta.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.v1beta.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

finishMigration(request, callback)

public finishMigration(request: google.cloud.memorystore.v1beta.IFinishMigrationRequest, callback: google.cloud.memorystore.v1beta.Memorystore.FinishMigrationCallback): void;

Calls FinishMigration.

Parameters
Name Description
request IFinishMigrationRequest

FinishMigrationRequest message or plain object
callback FinishMigrationCallback

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

finishMigration(request)

public finishMigration(request: google.cloud.memorystore.v1beta.IFinishMigrationRequest): Promise<google.longrunning.Operation>;

Calls FinishMigration.

Parameter
Name Description
request IFinishMigrationRequest

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

Promise

getAuthToken(request, callback)

public getAuthToken(request: google.cloud.memorystore.v1beta.IGetAuthTokenRequest, callback: google.cloud.memorystore.v1beta.Memorystore.GetAuthTokenCallback): void;

Calls GetAuthToken.

Parameters
Name Description
request IGetAuthTokenRequest

GetAuthTokenRequest message or plain object
callback GetAuthTokenCallback

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

getAuthToken(request)

public getAuthToken(request: google.cloud.memorystore.v1beta.IGetAuthTokenRequest): Promise<google.cloud.memorystore.v1beta.AuthToken>;

Calls GetAuthToken.

Parameter
Name Description
request IGetAuthTokenRequest

GetAuthTokenRequest message or plain object
Returns
Type Description
Promise<google.cloud.memorystore.v1beta.AuthToken>

Promise

getBackup(request, callback)

public getBackup(request: google.cloud.memorystore.v1beta.IGetBackupRequest, callback: google.cloud.memorystore.v1beta.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.v1beta.IGetBackupRequest): Promise<google.cloud.memorystore.v1beta.Backup>;

Calls GetBackup.

Parameter
Name Description
request IGetBackupRequest

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

Promise

getBackupCollection(request, callback)

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

Calls GetBackupCollection.

Parameter
Name Description
request IGetBackupCollectionRequest

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

Promise

getCertificateAuthority(request, callback)

public getCertificateAuthority(request: google.cloud.memorystore.v1beta.IGetCertificateAuthorityRequest, callback: google.cloud.memorystore.v1beta.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.v1beta.IGetCertificateAuthorityRequest): Promise<google.cloud.memorystore.v1beta.CertificateAuthority>;

Calls GetCertificateAuthority.

Parameter
Name Description
request IGetCertificateAuthorityRequest

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

Promise

getInstance(request, callback)

public getInstance(request: google.cloud.memorystore.v1beta.IGetInstanceRequest, callback: google.cloud.memorystore.v1beta.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.v1beta.IGetInstanceRequest): Promise<google.cloud.memorystore.v1beta.Instance>;

Calls GetInstance.

Parameter
Name Description
request IGetInstanceRequest

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

Promise

getSharedRegionalCertificateAuthority(request, callback)

public getSharedRegionalCertificateAuthority(request: google.cloud.memorystore.v1beta.IGetSharedRegionalCertificateAuthorityRequest, callback: google.cloud.memorystore.v1beta.Memorystore.GetSharedRegionalCertificateAuthorityCallback): void;

Calls GetSharedRegionalCertificateAuthority.

Parameters
Name Description
request IGetSharedRegionalCertificateAuthorityRequest

GetSharedRegionalCertificateAuthorityRequest message or plain object
callback GetSharedRegionalCertificateAuthorityCallback

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

getSharedRegionalCertificateAuthority(request)

public getSharedRegionalCertificateAuthority(request: google.cloud.memorystore.v1beta.IGetSharedRegionalCertificateAuthorityRequest): Promise<google.cloud.memorystore.v1beta.SharedRegionalCertificateAuthority>;

Calls GetSharedRegionalCertificateAuthority.

Parameter
Name Description
request IGetSharedRegionalCertificateAuthorityRequest

GetSharedRegionalCertificateAuthorityRequest message or plain object
Returns
Type Description
Promise<google.cloud.memorystore.v1beta.SharedRegionalCertificateAuthority>

Promise

getTokenAuthUser(request, callback)

public getTokenAuthUser(request: google.cloud.memorystore.v1beta.IGetTokenAuthUserRequest, callback: google.cloud.memorystore.v1beta.Memorystore.GetTokenAuthUserCallback): void;

Calls GetTokenAuthUser.

Parameters
Name Description
request IGetTokenAuthUserRequest

GetTokenAuthUserRequest message or plain object
callback GetTokenAuthUserCallback

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

getTokenAuthUser(request)

public getTokenAuthUser(request: google.cloud.memorystore.v1beta.IGetTokenAuthUserRequest): Promise<google.cloud.memorystore.v1beta.TokenAuthUser>;

Calls GetTokenAuthUser.

Parameter
Name Description
request IGetTokenAuthUserRequest

GetTokenAuthUserRequest message or plain object
Returns
Type Description
Promise<google.cloud.memorystore.v1beta.TokenAuthUser>

Promise

listAuthTokens(request, callback)

public listAuthTokens(request: google.cloud.memorystore.v1beta.IListAuthTokensRequest, callback: google.cloud.memorystore.v1beta.Memorystore.ListAuthTokensCallback): void;

Calls ListAuthTokens.

Parameters
Name Description
request IListAuthTokensRequest

ListAuthTokensRequest message or plain object
callback ListAuthTokensCallback

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

listAuthTokens(request)

public listAuthTokens(request: google.cloud.memorystore.v1beta.IListAuthTokensRequest): Promise<google.cloud.memorystore.v1beta.ListAuthTokensResponse>;

Calls ListAuthTokens.

Parameter
Name Description
request IListAuthTokensRequest

ListAuthTokensRequest message or plain object
Returns
Type Description
Promise<google.cloud.memorystore.v1beta.ListAuthTokensResponse>

Promise

listBackupCollections(request, callback)

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

Calls ListBackupCollections.

Parameter
Name Description
request IListBackupCollectionsRequest

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

Promise

listBackups(request, callback)

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

Calls ListBackups.

Parameter
Name Description
request IListBackupsRequest

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

Promise

listInstances(request, callback)

public listInstances(request: google.cloud.memorystore.v1beta.IListInstancesRequest, callback: google.cloud.memorystore.v1beta.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.v1beta.IListInstancesRequest): Promise<google.cloud.memorystore.v1beta.ListInstancesResponse>;

Calls ListInstances.

Parameter
Name Description
request IListInstancesRequest

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

Promise

listTokenAuthUsers(request, callback)

public listTokenAuthUsers(request: google.cloud.memorystore.v1beta.IListTokenAuthUsersRequest, callback: google.cloud.memorystore.v1beta.Memorystore.ListTokenAuthUsersCallback): void;

Calls ListTokenAuthUsers.

Parameters
Name Description
request IListTokenAuthUsersRequest

ListTokenAuthUsersRequest message or plain object
callback ListTokenAuthUsersCallback

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

listTokenAuthUsers(request)

public listTokenAuthUsers(request: google.cloud.memorystore.v1beta.IListTokenAuthUsersRequest): Promise<google.cloud.memorystore.v1beta.ListTokenAuthUsersResponse>;

Calls ListTokenAuthUsers.

Parameter
Name Description
request IListTokenAuthUsersRequest

ListTokenAuthUsersRequest message or plain object
Returns
Type Description
Promise<google.cloud.memorystore.v1beta.ListTokenAuthUsersResponse>

Promise

rescheduleMaintenance(request, callback)

public rescheduleMaintenance(request: google.cloud.memorystore.v1beta.IRescheduleMaintenanceRequest, callback: google.cloud.memorystore.v1beta.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.v1beta.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

startMigration(request, callback)

public startMigration(request: google.cloud.memorystore.v1beta.IStartMigrationRequest, callback: google.cloud.memorystore.v1beta.Memorystore.StartMigrationCallback): void;

Calls StartMigration.

Parameters
Name Description
request IStartMigrationRequest

StartMigrationRequest message or plain object
callback StartMigrationCallback

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

startMigration(request)

public startMigration(request: google.cloud.memorystore.v1beta.IStartMigrationRequest): Promise<google.longrunning.Operation>;

Calls StartMigration.

Parameter
Name Description
request IStartMigrationRequest

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

Promise

updateInstance(request, callback)

public updateInstance(request: google.cloud.memorystore.v1beta.IUpdateInstanceRequest, callback: google.cloud.memorystore.v1beta.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.v1beta.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