Class MemorystoreGrpc.MemorystoreStub (0.41.0)

0.41.0 (latest) 0.40.0 0.39.0 0.37.0 0.34.0 0.33.0 0.31.0 0.29.0 0.28.0 0.26.0 0.24.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.16.0 0.14.0 0.13.0 0.10.0 0.9.0 0.8.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

public static final class MemorystoreGrpc.MemorystoreStub extends AbstractAsyncStub<MemorystoreGrpc.MemorystoreStub>

A stub to allow clients to do asynchronous rpc calls to service Memorystore.

Service describing handlers for resources

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractAsyncStub > MemorystoreGrpc.MemorystoreStub

Inherited Members

io.grpc.stub.AbstractAsyncStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractAsyncStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(java.time.Duration)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withOnReadyThreshold(int)

io.grpc.stub.AbstractStub.withWaitForReady()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

addAuthToken(AddAuthTokenRequest request, StreamObserver<Operation> responseObserver)

public 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 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 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>

build(Channel channel, CallOptions callOptions)

protected MemorystoreGrpc.MemorystoreStub build(Channel channel, CallOptions callOptions)

Parameters
Name	Description
channel	io.grpc.Channel
callOptions	io.grpc.CallOptions

Returns
Type	Description
MemorystoreGrpc.MemorystoreStub

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createInstance(CreateInstanceRequest request, StreamObserver<Operation> responseObserver)

public 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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>