Interface MemorystoreGrpc.AsyncService (0.41.0) 

public static interface MemorystoreGrpc.AsyncService

Service describing handlers for resources

Methods

addAuthToken(AddAuthTokenRequest request, StreamObserver<Operation> responseObserver)

public default void addAuthToken(AddAuthTokenRequest request, StreamObserver<Operation> responseObserver)

Adds a token for a user of a token based auth enabled instance.

Parameters
Name Description
request AddAuthTokenRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

addTokenAuthUser(AddTokenAuthUserRequest request, StreamObserver<Operation> responseObserver)

public default void addTokenAuthUser(AddTokenAuthUserRequest request, StreamObserver<Operation> responseObserver)

Adds a token auth user for a token based auth enabled instance.

Parameters
Name Description
request AddTokenAuthUserRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

backupInstance(BackupInstanceRequest request, StreamObserver<Operation> responseObserver)

public default void backupInstance(BackupInstanceRequest request, StreamObserver<Operation> responseObserver)

Backup Instance. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the instance's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.

Parameters
Name Description
request BackupInstanceRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

createInstance(CreateInstanceRequest request, StreamObserver<Operation> responseObserver)

public default void createInstance(CreateInstanceRequest request, StreamObserver<Operation> responseObserver)

Creates a new Instance in a given project and location.

Parameters
Name Description
request CreateInstanceRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteAuthToken(DeleteAuthTokenRequest request, StreamObserver<Operation> responseObserver)

public default void deleteAuthToken(DeleteAuthTokenRequest request, StreamObserver<Operation> responseObserver)

Deletes a token for a user of a token based auth enabled instance.

Parameters
Name Description
request DeleteAuthTokenRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteBackup(DeleteBackupRequest request, StreamObserver<Operation> responseObserver)

public default void deleteBackup(DeleteBackupRequest request, StreamObserver<Operation> responseObserver)

Deletes a specific backup.

Parameters
Name Description
request DeleteBackupRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteInstance(DeleteInstanceRequest request, StreamObserver<Operation> responseObserver)

public default void deleteInstance(DeleteInstanceRequest request, StreamObserver<Operation> responseObserver)

Deletes a single Instance.

Parameters
Name Description
request DeleteInstanceRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteTokenAuthUser(DeleteTokenAuthUserRequest request, StreamObserver<Operation> responseObserver)

public default void deleteTokenAuthUser(DeleteTokenAuthUserRequest request, StreamObserver<Operation> responseObserver)

Deletes a token auth user for a token based auth enabled instance.

Parameters
Name Description
request DeleteTokenAuthUserRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

exportBackup(ExportBackupRequest request, StreamObserver<Operation> responseObserver)

public default void exportBackup(ExportBackupRequest request, StreamObserver<Operation> responseObserver)

Exports a specific backup to a customer target Cloud Storage URI.

Parameters
Name Description
request ExportBackupRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

finishMigration(FinishMigrationRequest request, StreamObserver<Operation> responseObserver)

public default void finishMigration(FinishMigrationRequest request, StreamObserver<Operation> responseObserver)

Finalizes the migration process. After the successful completion of this operation, the target instance will:

  1. Stop replicating from the source instance.
  2. Allow both reads and writes.
Parameters
Name Description
request FinishMigrationRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

getAuthToken(GetAuthTokenRequest request, StreamObserver<AuthToken> responseObserver)

public default void getAuthToken(GetAuthTokenRequest request, StreamObserver<AuthToken> responseObserver)

Gets a token based auth enabled instance's auth token for a given user.

Parameters
Name Description
request GetAuthTokenRequest
responseObserver io.grpc.stub.StreamObserver<AuthToken>

getBackup(GetBackupRequest request, StreamObserver<Backup> responseObserver)

public default void getBackup(GetBackupRequest request, StreamObserver<Backup> responseObserver)

Gets the details of a specific backup.

Parameters
Name Description
request GetBackupRequest
responseObserver io.grpc.stub.StreamObserver<Backup>

getBackupCollection(GetBackupCollectionRequest request, StreamObserver<BackupCollection> responseObserver)

public default void getBackupCollection(GetBackupCollectionRequest request, StreamObserver<BackupCollection> responseObserver)

Get a backup collection.

Parameters
Name Description
request GetBackupCollectionRequest
responseObserver io.grpc.stub.StreamObserver<BackupCollection>

getCertificateAuthority(GetCertificateAuthorityRequest request, StreamObserver<CertificateAuthority> responseObserver)

public default void getCertificateAuthority(GetCertificateAuthorityRequest request, StreamObserver<CertificateAuthority> responseObserver)

Gets details about the certificate authority for an Instance.

Parameters
Name Description
request GetCertificateAuthorityRequest
responseObserver io.grpc.stub.StreamObserver<CertificateAuthority>

getInstance(GetInstanceRequest request, StreamObserver<Instance> responseObserver)

public default void getInstance(GetInstanceRequest request, StreamObserver<Instance> responseObserver)

Gets details of a single Instance.

Parameters
Name Description
request GetInstanceRequest
responseObserver io.grpc.stub.StreamObserver<Instance>

getSharedRegionalCertificateAuthority(GetSharedRegionalCertificateAuthorityRequest request, StreamObserver<SharedRegionalCertificateAuthority> responseObserver)

public default void getSharedRegionalCertificateAuthority(GetSharedRegionalCertificateAuthorityRequest request, StreamObserver<SharedRegionalCertificateAuthority> responseObserver)

Gets the details of shared regional certificate authority information for Memorystore instance.

Parameters
Name Description
request GetSharedRegionalCertificateAuthorityRequest
responseObserver io.grpc.stub.StreamObserver<SharedRegionalCertificateAuthority>

getTokenAuthUser(GetTokenAuthUserRequest request, StreamObserver<TokenAuthUser> responseObserver)

public default void getTokenAuthUser(GetTokenAuthUserRequest request, StreamObserver<TokenAuthUser> responseObserver)

Gets a specific token auth user for a token based auth enabled instance.

Parameters
Name Description
request GetTokenAuthUserRequest
responseObserver io.grpc.stub.StreamObserver<TokenAuthUser>

listAuthTokens(ListAuthTokensRequest request, StreamObserver<ListAuthTokensResponse> responseObserver)

public default void listAuthTokens(ListAuthTokensRequest request, StreamObserver<ListAuthTokensResponse> responseObserver)

Lists all the auth tokens for a specific token auth user.

Parameters
Name Description
request ListAuthTokensRequest
responseObserver io.grpc.stub.StreamObserver<ListAuthTokensResponse>

listBackupCollections(ListBackupCollectionsRequest request, StreamObserver<ListBackupCollectionsResponse> responseObserver)

public default void listBackupCollections(ListBackupCollectionsRequest request, StreamObserver<ListBackupCollectionsResponse> responseObserver)

Lists all backup collections owned by a consumer project in either the specified location (region) or all locations. If location_id is specified as - (wildcard), then all regions available to the project are queried, and the results are aggregated.

Parameters
Name Description
request ListBackupCollectionsRequest
responseObserver io.grpc.stub.StreamObserver<ListBackupCollectionsResponse>

listBackups(ListBackupsRequest request, StreamObserver<ListBackupsResponse> responseObserver)

public default void listBackups(ListBackupsRequest request, StreamObserver<ListBackupsResponse> responseObserver)

Lists all backups owned by a backup collection.

Parameters
Name Description
request ListBackupsRequest
responseObserver io.grpc.stub.StreamObserver<ListBackupsResponse>

listInstances(ListInstancesRequest request, StreamObserver<ListInstancesResponse> responseObserver)

public default void listInstances(ListInstancesRequest request, StreamObserver<ListInstancesResponse> responseObserver)

Lists Instances in a given project and location.

Parameters
Name Description
request ListInstancesRequest
responseObserver io.grpc.stub.StreamObserver<ListInstancesResponse>

listTokenAuthUsers(ListTokenAuthUsersRequest request, StreamObserver<ListTokenAuthUsersResponse> responseObserver)

public default void listTokenAuthUsers(ListTokenAuthUsersRequest request, StreamObserver<ListTokenAuthUsersResponse> responseObserver)

Lists all the token auth users for a token based auth enabled instance.

Parameters
Name Description
request ListTokenAuthUsersRequest
responseObserver io.grpc.stub.StreamObserver<ListTokenAuthUsersResponse>

rescheduleMaintenance(RescheduleMaintenanceRequest request, StreamObserver<Operation> responseObserver)

public default void rescheduleMaintenance(RescheduleMaintenanceRequest request, StreamObserver<Operation> responseObserver)

Reschedules upcoming maintenance event.

Parameters
Name Description
request RescheduleMaintenanceRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

startMigration(StartMigrationRequest request, StreamObserver<Operation> responseObserver)

public default void startMigration(StartMigrationRequest request, StreamObserver<Operation> responseObserver)

Initiates the migration of a source instance to the target Memorystore instance. After the successful completion of this operation, the target instance will:

  1. Set up replication with the source instance and replicate any writes to the source instance.
  2. Only allow reads.
Parameters
Name Description
request StartMigrationRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

updateInstance(UpdateInstanceRequest request, StreamObserver<Operation> responseObserver)

public default void updateInstance(UpdateInstanceRequest request, StreamObserver<Operation> responseObserver)

Updates the parameters of a single Instance.

Parameters
Name Description
request UpdateInstanceRequest
responseObserver io.grpc.stub.StreamObserver<Operation>