public static final class MemorystoreGrpc.MemorystoreBlockingV2Stub extends AbstractBlockingStub<MemorystoreGrpc.MemorystoreBlockingV2Stub>
A stub to allow clients to do synchronous rpc calls to service Memorystore.
Service describing handlers for resources
Inheritance
java.lang.Object >
io.grpc.stub.AbstractStub >
io.grpc.stub.AbstractBlockingStub >
MemorystoreGrpc.MemorystoreBlockingV2Stub
Inherited Members
io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)
io.grpc.stub.AbstractBlockingStub.<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()
Methods
addAuthToken(AddAuthTokenRequest request)
public Operation addAuthToken(AddAuthTokenRequest request)
Adds a token for a user of a token based auth enabled instance.
| Exceptions |
| Type |
Description |
io.grpc.StatusException |
|
addTokenAuthUser(AddTokenAuthUserRequest request)
public Operation addTokenAuthUser(AddTokenAuthUserRequest request)
Adds a token auth user for a token based auth enabled instance.
| Exceptions |
| Type |
Description |
io.grpc.StatusException |
|
backupInstance(BackupInstanceRequest request)
public Operation backupInstance(BackupInstanceRequest request)
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.
| Exceptions |
| Type |
Description |
io.grpc.StatusException |
|
build(Channel channel, CallOptions callOptions)
protected MemorystoreGrpc.MemorystoreBlockingV2Stub build(Channel channel, CallOptions callOptions)
| Parameters |
| Name |
Description |
channel |
io.grpc.Channel
|
callOptions |
io.grpc.CallOptions
|
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
createInstance(CreateInstanceRequest request)
public Operation createInstance(CreateInstanceRequest request)
Creates a new Instance in a given project and location.
| Exceptions |
| Type |
Description |
io.grpc.StatusException |
|
deleteAuthToken(DeleteAuthTokenRequest request)
public Operation deleteAuthToken(DeleteAuthTokenRequest request)
Deletes a token for a user of a token based auth enabled instance.
| Exceptions |
| Type |
Description |
io.grpc.StatusException |
|
deleteBackup(DeleteBackupRequest request)
public Operation deleteBackup(DeleteBackupRequest request)
Deletes a specific backup.
| Exceptions |
| Type |
Description |
io.grpc.StatusException |
|
deleteInstance(DeleteInstanceRequest request)
public Operation deleteInstance(DeleteInstanceRequest request)
Deletes a single Instance.
| Exceptions |
| Type |
Description |
io.grpc.StatusException |
|
deleteTokenAuthUser(DeleteTokenAuthUserRequest request)
public Operation deleteTokenAuthUser(DeleteTokenAuthUserRequest request)
Deletes a token auth user for a token based auth enabled instance.
| Exceptions |
| Type |
Description |
io.grpc.StatusException |
|
exportBackup(ExportBackupRequest request)
public Operation exportBackup(ExportBackupRequest request)
Exports a specific backup to a customer target Cloud Storage URI.
| Exceptions |
| Type |
Description |
io.grpc.StatusException |
|
finishMigration(FinishMigrationRequest request)
public Operation finishMigration(FinishMigrationRequest request)
Finalizes the migration process.
After the successful completion of this operation, the target instance
will:
- Stop replicating from the source instance.
- Allow both reads and writes.
| Exceptions |
| Type |
Description |
io.grpc.StatusException |
|
getAuthToken(GetAuthTokenRequest request)
public AuthToken getAuthToken(GetAuthTokenRequest request)
Gets a token based auth enabled instance's auth token for a given user.
| Exceptions |
| Type |
Description |
io.grpc.StatusException |
|
getBackup(GetBackupRequest request)
public Backup getBackup(GetBackupRequest request)
Gets the details of a specific backup.
| Returns |
| Type |
Description |
Backup |
|
| Exceptions |
| Type |
Description |
io.grpc.StatusException |
|
getBackupCollection(GetBackupCollectionRequest request)
public BackupCollection getBackupCollection(GetBackupCollectionRequest request)
| Exceptions |
| Type |
Description |
io.grpc.StatusException |
|
getCertificateAuthority(GetCertificateAuthorityRequest request)
public CertificateAuthority getCertificateAuthority(GetCertificateAuthorityRequest request)
Gets details about the certificate authority for an Instance.
| Exceptions |
| Type |
Description |
io.grpc.StatusException |
|
getInstance(GetInstanceRequest request)
public Instance getInstance(GetInstanceRequest request)
Gets details of a single Instance.
| Exceptions |
| Type |
Description |
io.grpc.StatusException |
|
getSharedRegionalCertificateAuthority(GetSharedRegionalCertificateAuthorityRequest request)
public SharedRegionalCertificateAuthority getSharedRegionalCertificateAuthority(GetSharedRegionalCertificateAuthorityRequest request)
Gets the details of shared regional certificate authority information for
Memorystore instance.
| Exceptions |
| Type |
Description |
io.grpc.StatusException |
|
getTokenAuthUser(GetTokenAuthUserRequest request)
public TokenAuthUser getTokenAuthUser(GetTokenAuthUserRequest request)
Gets a specific token auth user for a token based auth enabled instance.
| Exceptions |
| Type |
Description |
io.grpc.StatusException |
|
listAuthTokens(ListAuthTokensRequest request)
public ListAuthTokensResponse listAuthTokens(ListAuthTokensRequest request)
Lists all the auth tokens for a specific token auth user.
| Exceptions |
| Type |
Description |
io.grpc.StatusException |
|
listBackupCollections(ListBackupCollectionsRequest request)
public ListBackupCollectionsResponse listBackupCollections(ListBackupCollectionsRequest request)
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.
| Exceptions |
| Type |
Description |
io.grpc.StatusException |
|
listBackups(ListBackupsRequest request)
public ListBackupsResponse listBackups(ListBackupsRequest request)
Lists all backups owned by a backup collection.
| Exceptions |
| Type |
Description |
io.grpc.StatusException |
|
listInstances(ListInstancesRequest request)
public ListInstancesResponse listInstances(ListInstancesRequest request)
Lists Instances in a given project and location.
| Exceptions |
| Type |
Description |
io.grpc.StatusException |
|
listTokenAuthUsers(ListTokenAuthUsersRequest request)
public ListTokenAuthUsersResponse listTokenAuthUsers(ListTokenAuthUsersRequest request)
Lists all the token auth users for a token based auth enabled instance.
| Exceptions |
| Type |
Description |
io.grpc.StatusException |
|
rescheduleMaintenance(RescheduleMaintenanceRequest request)
public Operation rescheduleMaintenance(RescheduleMaintenanceRequest request)
Reschedules upcoming maintenance event.
| Exceptions |
| Type |
Description |
io.grpc.StatusException |
|
startMigration(StartMigrationRequest request)
public Operation startMigration(StartMigrationRequest request)
Initiates the migration of a source instance to the target Memorystore
instance.
After the successful completion of this operation, the target instance
will:
- Set up replication with the source instance and replicate any writes to
the source instance.
- Only allow reads.
| Exceptions |
| Type |
Description |
io.grpc.StatusException |
|
updateInstance(UpdateInstanceRequest request)
public Operation updateInstance(UpdateInstanceRequest request)
Updates the parameters of a single Instance.
| Exceptions |
| Type |
Description |
io.grpc.StatusException |
|
