com.google.cloud.alloydb.v1beta

Class AlloyDBAdminGrpc.AlloyDBAdminFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<AlloyDBAdminGrpc.AlloyDBAdminFutureStub>

com.google.cloud.alloydb.v1beta.AlloyDBAdminGrpc.AlloyDBAdminFutureStub

Enclosing class:

AlloyDBAdminGrpc

public static final class AlloyDBAdminGrpc.AlloyDBAdminFutureStub
extends io.grpc.stub.AbstractFutureStub<AlloyDBAdminGrpc.AlloyDBAdminFutureStub>

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

 Service describing handlers for resources
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method and Description
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	batchCreateInstances(BatchCreateInstancesRequest request) Creates new instances under the given project, location and cluster.
protected AlloyDBAdminGrpc.AlloyDBAdminFutureStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	createBackup(CreateBackupRequest request) Creates a new Backup in a given project and location.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	createCluster(CreateClusterRequest request) Creates a new Cluster in a given project and location.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	createInstance(CreateInstanceRequest request) Creates a new Instance in a given project and location.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	createSecondaryCluster(CreateSecondaryClusterRequest request) Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	createSecondaryInstance(CreateSecondaryInstanceRequest request) Creates a new SECONDARY Instance in a given project and location.
com.google.common.util.concurrent.ListenableFuture<User>	createUser(CreateUserRequest request) Creates a new User in a given project, location, and cluster.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	deleteBackup(DeleteBackupRequest request) Deletes a single Backup.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	deleteCluster(DeleteClusterRequest request) Deletes a single Cluster.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	deleteInstance(DeleteInstanceRequest request) Deletes a single Instance.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	deleteUser(DeleteUserRequest request) Deletes a single User.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	failoverInstance(FailoverInstanceRequest request) Forces a Failover for a highly available instance.
com.google.common.util.concurrent.ListenableFuture<GenerateClientCertificateResponse>	generateClientCertificate(GenerateClientCertificateRequest request) Generate a client certificate signed by a Cluster CA.
com.google.common.util.concurrent.ListenableFuture<Backup>	getBackup(GetBackupRequest request) Gets details of a single Backup.
com.google.common.util.concurrent.ListenableFuture<Cluster>	getCluster(GetClusterRequest request) Gets details of a single Cluster.
com.google.common.util.concurrent.ListenableFuture<ConnectionInfo>	getConnectionInfo(GetConnectionInfoRequest request) Get instance metadata used for a connection.
com.google.common.util.concurrent.ListenableFuture<Instance>	getInstance(GetInstanceRequest request) Gets details of a single Instance.
com.google.common.util.concurrent.ListenableFuture<User>	getUser(GetUserRequest request) Gets details of a single User.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	injectFault(InjectFaultRequest request) Injects fault in an instance.
com.google.common.util.concurrent.ListenableFuture<ListBackupsResponse>	listBackups(ListBackupsRequest request) Lists Backups in a given project and location.
com.google.common.util.concurrent.ListenableFuture<ListClustersResponse>	listClusters(ListClustersRequest request) Lists Clusters in a given project and location.
com.google.common.util.concurrent.ListenableFuture<ListInstancesResponse>	listInstances(ListInstancesRequest request) Lists Instances in a given project and location.
com.google.common.util.concurrent.ListenableFuture<ListSupportedDatabaseFlagsResponse>	listSupportedDatabaseFlags(ListSupportedDatabaseFlagsRequest request) Lists SupportedDatabaseFlags for a given project and location.
com.google.common.util.concurrent.ListenableFuture<ListUsersResponse>	listUsers(ListUsersRequest request) Lists Users in a given project and location.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	promoteCluster(PromoteClusterRequest request) Promotes a SECONDARY cluster.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	restartInstance(RestartInstanceRequest request) Restart an Instance in a cluster.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	restoreCluster(RestoreClusterRequest request) Creates a new Cluster in a given project and location, with a volume restored from the provided source, either a backup ID or a point-in-time and a source cluster.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	updateBackup(UpdateBackupRequest request) Updates the parameters of a single Backup.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	updateCluster(UpdateClusterRequest request) Updates the parameters of a single Cluster.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	updateInstance(UpdateInstanceRequest request) Updates the parameters of a single Instance.
com.google.common.util.concurrent.ListenableFuture<User>	updateUser(UpdateUserRequest request) Updates the parameters of a single User.

Methods inherited from class io.grpc.stub.AbstractFutureStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

protected AlloyDBAdminGrpc.AlloyDBAdminFutureStub build(io.grpc.Channel channel,
                                                        io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<AlloyDBAdminGrpc.AlloyDBAdminFutureStub>

listClusters

public com.google.common.util.concurrent.ListenableFuture<ListClustersResponse> listClusters(ListClustersRequest request)

 Lists Clusters in a given project and location.
 

getCluster

public com.google.common.util.concurrent.ListenableFuture<Cluster> getCluster(GetClusterRequest request)

 Gets details of a single Cluster.
 

createCluster

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> createCluster(CreateClusterRequest request)

 Creates a new Cluster in a given project and location.
 

updateCluster

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> updateCluster(UpdateClusterRequest request)

 Updates the parameters of a single Cluster.
 

deleteCluster

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> deleteCluster(DeleteClusterRequest request)

 Deletes a single Cluster.
 

promoteCluster

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> promoteCluster(PromoteClusterRequest request)

 Promotes a SECONDARY cluster. This turns down replication
 from the PRIMARY cluster and promotes a secondary cluster
 into its own standalone cluster.
 Imperative only.
 

restoreCluster

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> restoreCluster(RestoreClusterRequest request)

 Creates a new Cluster in a given project and location, with a volume
 restored from the provided source, either a backup ID or a point-in-time
 and a source cluster.
 

createSecondaryCluster

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> createSecondaryCluster(CreateSecondaryClusterRequest request)

 Creates a cluster of type SECONDARY in the given location using
 the primary cluster as the source.
 

listInstances

public com.google.common.util.concurrent.ListenableFuture<ListInstancesResponse> listInstances(ListInstancesRequest request)

 Lists Instances in a given project and location.
 

getInstance

public com.google.common.util.concurrent.ListenableFuture<Instance> getInstance(GetInstanceRequest request)

 Gets details of a single Instance.
 

createInstance

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> createInstance(CreateInstanceRequest request)

 Creates a new Instance in a given project and location.
 

createSecondaryInstance

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> createSecondaryInstance(CreateSecondaryInstanceRequest request)

 Creates a new SECONDARY Instance in a given project and location.
 

batchCreateInstances

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> batchCreateInstances(BatchCreateInstancesRequest request)

 Creates new instances under the given project, location and cluster.
 There can be only one primary instance in a cluster. If the primary
 instance exists in the cluster as well as this request, then API will
 throw an error.
 The primary instance should exist before any read pool instance is
 created. If the primary instance is a part of the request payload, then
 the API will take care of creating instances in the correct order.
 This method is here to support Google-internal use cases, and is not meant
 for external customers to consume. Please do not start relying on it; its
 behavior is subject to change without notice.
 

updateInstance

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> updateInstance(UpdateInstanceRequest request)

 Updates the parameters of a single Instance.
 

deleteInstance

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> deleteInstance(DeleteInstanceRequest request)

 Deletes a single Instance.
 

failoverInstance

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> failoverInstance(FailoverInstanceRequest request)

 Forces a Failover for a highly available instance.
 Failover promotes the HA standby instance as the new primary.
 Imperative only.
 

injectFault

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> injectFault(InjectFaultRequest request)

 Injects fault in an instance.
 Imperative only.
 

restartInstance

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> restartInstance(RestartInstanceRequest request)

 Restart an Instance in a cluster.
 Imperative only.
 

listBackups

public com.google.common.util.concurrent.ListenableFuture<ListBackupsResponse> listBackups(ListBackupsRequest request)

 Lists Backups in a given project and location.
 

getBackup

public com.google.common.util.concurrent.ListenableFuture<Backup> getBackup(GetBackupRequest request)

 Gets details of a single Backup.
 

createBackup

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> createBackup(CreateBackupRequest request)

 Creates a new Backup in a given project and location.
 

updateBackup

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> updateBackup(UpdateBackupRequest request)

 Updates the parameters of a single Backup.
 

deleteBackup

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> deleteBackup(DeleteBackupRequest request)

 Deletes a single Backup.
 

listSupportedDatabaseFlags

public com.google.common.util.concurrent.ListenableFuture<ListSupportedDatabaseFlagsResponse> listSupportedDatabaseFlags(ListSupportedDatabaseFlagsRequest request)

 Lists SupportedDatabaseFlags for a given project and location.
 

generateClientCertificate

public com.google.common.util.concurrent.ListenableFuture<GenerateClientCertificateResponse> generateClientCertificate(GenerateClientCertificateRequest request)

 Generate a client certificate signed by a Cluster CA.
 The sole purpose of this endpoint is to support the Auth Proxy client and
 the endpoint's behavior is subject to change without notice, so do not rely
 on its behavior remaining constant. Future changes will not break the Auth
 Proxy client.
 

getConnectionInfo

public com.google.common.util.concurrent.ListenableFuture<ConnectionInfo> getConnectionInfo(GetConnectionInfoRequest request)

 Get instance metadata used for a connection.
 

listUsers

public com.google.common.util.concurrent.ListenableFuture<ListUsersResponse> listUsers(ListUsersRequest request)

 Lists Users in a given project and location.
 

getUser

public com.google.common.util.concurrent.ListenableFuture<User> getUser(GetUserRequest request)

 Gets details of a single User.
 

createUser

public com.google.common.util.concurrent.ListenableFuture<User> createUser(CreateUserRequest request)

 Creates a new User in a given project, location, and cluster.
 

updateUser

public com.google.common.util.concurrent.ListenableFuture<User> updateUser(UpdateUserRequest request)

 Updates the parameters of a single User.
 

deleteUser

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteUser(DeleteUserRequest request)

 Deletes a single User.