Class MemorystoreGrpc.MemorystoreFutureStub (0.41.0)

public static final class MemorystoreGrpc.MemorystoreFutureStub extends AbstractFutureStub<MemorystoreGrpc.MemorystoreFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service Memorystore.

Service describing handlers for resources

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > MemorystoreGrpc.MemorystoreFutureStub

Inherited Members

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

io.grpc.stub.AbstractFutureStub.<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)

public ListenableFuture<Operation> addAuthToken(AddAuthTokenRequest request)

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

Parameter
Name	Description
`request`	`AddAuthTokenRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

addTokenAuthUser(AddTokenAuthUserRequest request)

public ListenableFuture<Operation> addTokenAuthUser(AddTokenAuthUserRequest request)

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

Parameter
Name	Description
`request`	`AddTokenAuthUserRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

backupInstance(BackupInstanceRequest request)

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

Parameter
Name	Description
`request`	`BackupInstanceRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

build(Channel channel, CallOptions callOptions)

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

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

Returns
Type	Description
`MemorystoreGrpc.MemorystoreFutureStub`

Overrides

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

createInstance(CreateInstanceRequest request)

public ListenableFuture<Operation> createInstance(CreateInstanceRequest request)

Creates a new Instance in a given project and location.

Parameter
Name	Description
`request`	`CreateInstanceRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

deleteAuthToken(DeleteAuthTokenRequest request)

public ListenableFuture<Operation> deleteAuthToken(DeleteAuthTokenRequest request)

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

Parameter
Name	Description
`request`	`DeleteAuthTokenRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

deleteBackup(DeleteBackupRequest request)

public ListenableFuture<Operation> deleteBackup(DeleteBackupRequest request)

Deletes a specific backup.

Parameter
Name	Description
`request`	`DeleteBackupRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

deleteInstance(DeleteInstanceRequest request)

public ListenableFuture<Operation> deleteInstance(DeleteInstanceRequest request)

Deletes a single Instance.

Parameter
Name	Description
`request`	`DeleteInstanceRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

deleteTokenAuthUser(DeleteTokenAuthUserRequest request)

public ListenableFuture<Operation> deleteTokenAuthUser(DeleteTokenAuthUserRequest request)

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

Parameter
Name	Description
`request`	`DeleteTokenAuthUserRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

exportBackup(ExportBackupRequest request)

public ListenableFuture<Operation> exportBackup(ExportBackupRequest request)

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

Parameter
Name	Description
`request`	`ExportBackupRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

finishMigration(FinishMigrationRequest request)

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

Parameter
Name	Description
`request`	`FinishMigrationRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

getAuthToken(GetAuthTokenRequest request)

public ListenableFuture<AuthToken> getAuthToken(GetAuthTokenRequest request)

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

Parameter
Name	Description
`request`	`GetAuthTokenRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<AuthToken>`

getBackup(GetBackupRequest request)

public ListenableFuture<Backup> getBackup(GetBackupRequest request)

Gets the details of a specific backup.

Parameter
Name	Description
`request`	`GetBackupRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Backup>`

getBackupCollection(GetBackupCollectionRequest request)

public ListenableFuture<BackupCollection> getBackupCollection(GetBackupCollectionRequest request)

Get a backup collection.

Parameter
Name	Description
`request`	`GetBackupCollectionRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<BackupCollection>`

getCertificateAuthority(GetCertificateAuthorityRequest request)

public ListenableFuture<CertificateAuthority> getCertificateAuthority(GetCertificateAuthorityRequest request)

Gets details about the certificate authority for an Instance.

Parameter
Name	Description
`request`	`GetCertificateAuthorityRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<CertificateAuthority>`

getInstance(GetInstanceRequest request)

public ListenableFuture<Instance> getInstance(GetInstanceRequest request)

Gets details of a single Instance.

Parameter
Name	Description
`request`	`GetInstanceRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Instance>`

getSharedRegionalCertificateAuthority(GetSharedRegionalCertificateAuthorityRequest request)

public ListenableFuture<SharedRegionalCertificateAuthority> getSharedRegionalCertificateAuthority(GetSharedRegionalCertificateAuthorityRequest request)

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

Parameter
Name	Description
`request`	`GetSharedRegionalCertificateAuthorityRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<SharedRegionalCertificateAuthority>`

getTokenAuthUser(GetTokenAuthUserRequest request)

public ListenableFuture<TokenAuthUser> getTokenAuthUser(GetTokenAuthUserRequest request)

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

Parameter
Name	Description
`request`	`GetTokenAuthUserRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<TokenAuthUser>`

listAuthTokens(ListAuthTokensRequest request)

public ListenableFuture<ListAuthTokensResponse> listAuthTokens(ListAuthTokensRequest request)

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

Parameter
Name	Description
`request`	`ListAuthTokensRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListAuthTokensResponse>`

listBackupCollections(ListBackupCollectionsRequest request)

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

Parameter
Name	Description
`request`	`ListBackupCollectionsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListBackupCollectionsResponse>`

listBackups(ListBackupsRequest request)

public ListenableFuture<ListBackupsResponse> listBackups(ListBackupsRequest request)

Lists all backups owned by a backup collection.

Parameter
Name	Description
`request`	`ListBackupsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListBackupsResponse>`

listInstances(ListInstancesRequest request)

public ListenableFuture<ListInstancesResponse> listInstances(ListInstancesRequest request)

Lists Instances in a given project and location.

Parameter
Name	Description
`request`	`ListInstancesRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListInstancesResponse>`

listTokenAuthUsers(ListTokenAuthUsersRequest request)

public ListenableFuture<ListTokenAuthUsersResponse> listTokenAuthUsers(ListTokenAuthUsersRequest request)

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

Parameter
Name	Description
`request`	`ListTokenAuthUsersRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListTokenAuthUsersResponse>`

rescheduleMaintenance(RescheduleMaintenanceRequest request)

public ListenableFuture<Operation> rescheduleMaintenance(RescheduleMaintenanceRequest request)

Reschedules upcoming maintenance event.

Parameter
Name	Description
`request`	`RescheduleMaintenanceRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

startMigration(StartMigrationRequest request)

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

Parameter
Name	Description
`request`	`StartMigrationRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

updateInstance(UpdateInstanceRequest request)

public ListenableFuture<Operation> updateInstance(UpdateInstanceRequest request)

Updates the parameters of a single Instance.

Parameter
Name	Description
`request`	`UpdateInstanceRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

Class MemorystoreGrpc.MemorystoreFutureStub (0.41.0) Stay organized with collections Save and categorize content based on your preferences.