com.google.cloud.alloydb.v1alpha

Class AlloyDBAdminGrpc.AlloyDBAdminBlockingV2Stub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<AlloyDBAdminGrpc.AlloyDBAdminBlockingV2Stub>

com.google.cloud.alloydb.v1alpha.AlloyDBAdminGrpc.AlloyDBAdminBlockingV2Stub

Enclosing class:

AlloyDBAdminGrpc

public static final class AlloyDBAdminGrpc.AlloyDBAdminBlockingV2Stub
extends io.grpc.stub.AbstractBlockingStub<AlloyDBAdminGrpc.AlloyDBAdminBlockingV2Stub>

A stub to allow clients to do synchronous 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.longrunning.Operation	batchCreateInstances(BatchCreateInstancesRequest request) Creates new instances under the given project, location and cluster.
protected AlloyDBAdminGrpc.AlloyDBAdminBlockingV2Stub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.longrunning.Operation	createBackup(CreateBackupRequest request) Creates a new Backup in a given project and location.
com.google.longrunning.Operation	createCluster(CreateClusterRequest request) Creates a new Cluster in a given project and location.
Database	createDatabase(CreateDatabaseRequest request) Creates a new Database in a given project, location, and cluster.
com.google.longrunning.Operation	createInstance(CreateInstanceRequest request) Creates a new Instance in a given project and location.
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.longrunning.Operation	createSecondaryInstance(CreateSecondaryInstanceRequest request) Creates a new SECONDARY Instance in a given project and location.
User	createUser(CreateUserRequest request) Creates a new User in a given project, location, and cluster.
com.google.longrunning.Operation	deleteBackup(DeleteBackupRequest request) Deletes a single Backup.
com.google.longrunning.Operation	deleteCluster(DeleteClusterRequest request) Deletes a single Cluster.
com.google.longrunning.Operation	deleteInstance(DeleteInstanceRequest request) Deletes a single Instance.
com.google.protobuf.Empty	deleteUser(DeleteUserRequest request) Deletes a single User.
ExecuteSqlResponse	executeSql(ExecuteSqlRequest request) Executes a SQL statement in a database inside an AlloyDB instance.
com.google.longrunning.Operation	exportCluster(ExportClusterRequest request) Exports data from the cluster.
com.google.longrunning.Operation	failoverInstance(FailoverInstanceRequest request) Forces a Failover for a highly available instance.
GenerateClientCertificateResponse	generateClientCertificate(GenerateClientCertificateRequest request) Generate a client certificate signed by a Cluster CA.
Backup	getBackup(GetBackupRequest request) Gets details of a single Backup.
Cluster	getCluster(GetClusterRequest request) Gets details of a single Cluster.
ConnectionInfo	getConnectionInfo(GetConnectionInfoRequest request) Get instance metadata used for a connection.
Instance	getInstance(GetInstanceRequest request) Gets details of a single Instance.
User	getUser(GetUserRequest request) Gets details of a single User.
com.google.longrunning.Operation	importCluster(ImportClusterRequest request) Imports data to the cluster.
com.google.longrunning.Operation	injectFault(InjectFaultRequest request) Injects fault in an instance.
ListBackupsResponse	listBackups(ListBackupsRequest request) Lists Backups in a given project and location.
ListClustersResponse	listClusters(ListClustersRequest request) Lists Clusters in a given project and location.
ListDatabasesResponse	listDatabases(ListDatabasesRequest request) Lists Databases in a given project and location.
ListInstancesResponse	listInstances(ListInstancesRequest request) Lists Instances in a given project and location.
ListSupportedDatabaseFlagsResponse	listSupportedDatabaseFlags(ListSupportedDatabaseFlagsRequest request) Lists SupportedDatabaseFlags for a given project and location.
ListUsersResponse	listUsers(ListUsersRequest request) Lists Users in a given project and location.
com.google.longrunning.Operation	promoteCluster(PromoteClusterRequest request) Promotes a SECONDARY cluster.
com.google.longrunning.Operation	restartInstance(RestartInstanceRequest request) Restart an Instance in a cluster.
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.longrunning.Operation	switchoverCluster(SwitchoverClusterRequest request) Switches the roles of PRIMARY and SECONDARY clusters without any data loss.
com.google.longrunning.Operation	updateBackup(UpdateBackupRequest request) Updates the parameters of a single Backup.
com.google.longrunning.Operation	updateCluster(UpdateClusterRequest request) Updates the parameters of a single Cluster.
com.google.longrunning.Operation	updateInstance(UpdateInstanceRequest request) Updates the parameters of a single Instance.
User	updateUser(UpdateUserRequest request) Updates the parameters of a single User.
com.google.longrunning.Operation	upgradeCluster(UpgradeClusterRequest request) Upgrades a single Cluster.

Methods inherited from class io.grpc.stub.AbstractBlockingStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOnReadyThreshold, 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.AlloyDBAdminBlockingV2Stub build(io.grpc.Channel channel,
                                                            io.grpc.CallOptions callOptions)

Specified by:

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

listClusters

public ListClustersResponse listClusters(ListClustersRequest request)
                                  throws io.grpc.StatusException

 Lists Clusters in a given project and location.
 

Throws:

io.grpc.StatusException

getCluster

public Cluster getCluster(GetClusterRequest request)
                   throws io.grpc.StatusException

 Gets details of a single Cluster.
 

Throws:

io.grpc.StatusException

createCluster

public com.google.longrunning.Operation createCluster(CreateClusterRequest request)
                                               throws io.grpc.StatusException

 Creates a new Cluster in a given project and location.
 

Throws:

io.grpc.StatusException

updateCluster

public com.google.longrunning.Operation updateCluster(UpdateClusterRequest request)
                                               throws io.grpc.StatusException

 Updates the parameters of a single Cluster.
 

Throws:

io.grpc.StatusException

exportCluster

public com.google.longrunning.Operation exportCluster(ExportClusterRequest request)
                                               throws io.grpc.StatusException

 Exports data from the cluster.
 Imperative only.
 

Throws:

io.grpc.StatusException

importCluster

public com.google.longrunning.Operation importCluster(ImportClusterRequest request)
                                               throws io.grpc.StatusException

 Imports data to the cluster.
 Imperative only.
 

Throws:

io.grpc.StatusException

upgradeCluster

public com.google.longrunning.Operation upgradeCluster(UpgradeClusterRequest request)
                                                throws io.grpc.StatusException

 Upgrades a single Cluster.
 Imperative only.
 

Throws:

io.grpc.StatusException

deleteCluster

public com.google.longrunning.Operation deleteCluster(DeleteClusterRequest request)
                                               throws io.grpc.StatusException

 Deletes a single Cluster.
 

Throws:

io.grpc.StatusException

promoteCluster

public com.google.longrunning.Operation promoteCluster(PromoteClusterRequest request)
                                                throws io.grpc.StatusException

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

Throws:

io.grpc.StatusException

switchoverCluster

public com.google.longrunning.Operation switchoverCluster(SwitchoverClusterRequest request)
                                                   throws io.grpc.StatusException

 Switches the roles of PRIMARY and SECONDARY clusters without any data loss.
 This promotes the SECONDARY cluster to PRIMARY and sets up the original
 PRIMARY cluster to replicate from this newly promoted cluster.
 

Throws:

io.grpc.StatusException

restoreCluster

public com.google.longrunning.Operation restoreCluster(RestoreClusterRequest request)
                                                throws io.grpc.StatusException

 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.
 

Throws:

io.grpc.StatusException

createSecondaryCluster

public com.google.longrunning.Operation createSecondaryCluster(CreateSecondaryClusterRequest request)
                                                        throws io.grpc.StatusException

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

Throws:

io.grpc.StatusException

listInstances

public ListInstancesResponse listInstances(ListInstancesRequest request)
                                    throws io.grpc.StatusException

 Lists Instances in a given project and location.
 

Throws:

io.grpc.StatusException

getInstance

public Instance getInstance(GetInstanceRequest request)
                     throws io.grpc.StatusException

 Gets details of a single Instance.
 

Throws:

io.grpc.StatusException

createInstance

public com.google.longrunning.Operation createInstance(CreateInstanceRequest request)
                                                throws io.grpc.StatusException

 Creates a new Instance in a given project and location.
 

Throws:

io.grpc.StatusException

createSecondaryInstance

public com.google.longrunning.Operation createSecondaryInstance(CreateSecondaryInstanceRequest request)
                                                         throws io.grpc.StatusException

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

Throws:

io.grpc.StatusException

batchCreateInstances

public com.google.longrunning.Operation batchCreateInstances(BatchCreateInstancesRequest request)
                                                      throws io.grpc.StatusException

 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.
 

Throws:

io.grpc.StatusException

updateInstance

public com.google.longrunning.Operation updateInstance(UpdateInstanceRequest request)
                                                throws io.grpc.StatusException

 Updates the parameters of a single Instance.
 

Throws:

io.grpc.StatusException

deleteInstance

public com.google.longrunning.Operation deleteInstance(DeleteInstanceRequest request)
                                                throws io.grpc.StatusException

 Deletes a single Instance.
 

Throws:

io.grpc.StatusException

failoverInstance

public com.google.longrunning.Operation failoverInstance(FailoverInstanceRequest request)
                                                  throws io.grpc.StatusException

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

Throws:

io.grpc.StatusException

injectFault

public com.google.longrunning.Operation injectFault(InjectFaultRequest request)
                                             throws io.grpc.StatusException

 Injects fault in an instance.
 Imperative only.
 

Throws:

io.grpc.StatusException

restartInstance

public com.google.longrunning.Operation restartInstance(RestartInstanceRequest request)
                                                 throws io.grpc.StatusException

 Restart an Instance in a cluster.
 Imperative only.
 

Throws:

io.grpc.StatusException

executeSql

public ExecuteSqlResponse executeSql(ExecuteSqlRequest request)
                              throws io.grpc.StatusException

 Executes a SQL statement in a database inside an AlloyDB instance.
 

Throws:

io.grpc.StatusException

listBackups

public ListBackupsResponse listBackups(ListBackupsRequest request)
                                throws io.grpc.StatusException

 Lists Backups in a given project and location.
 

Throws:

io.grpc.StatusException

getBackup

public Backup getBackup(GetBackupRequest request)
                 throws io.grpc.StatusException

 Gets details of a single Backup.
 

Throws:

io.grpc.StatusException

createBackup

public com.google.longrunning.Operation createBackup(CreateBackupRequest request)
                                              throws io.grpc.StatusException

 Creates a new Backup in a given project and location.
 

Throws:

io.grpc.StatusException

updateBackup

public com.google.longrunning.Operation updateBackup(UpdateBackupRequest request)
                                              throws io.grpc.StatusException

 Updates the parameters of a single Backup.
 

Throws:

io.grpc.StatusException

deleteBackup

public com.google.longrunning.Operation deleteBackup(DeleteBackupRequest request)
                                              throws io.grpc.StatusException

 Deletes a single Backup.
 

Throws:

io.grpc.StatusException

listSupportedDatabaseFlags

public ListSupportedDatabaseFlagsResponse listSupportedDatabaseFlags(ListSupportedDatabaseFlagsRequest request)
                                                              throws io.grpc.StatusException

 Lists SupportedDatabaseFlags for a given project and location.
 

Throws:

io.grpc.StatusException

generateClientCertificate

public GenerateClientCertificateResponse generateClientCertificate(GenerateClientCertificateRequest request)
                                                            throws io.grpc.StatusException

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

Throws:

io.grpc.StatusException

getConnectionInfo

public ConnectionInfo getConnectionInfo(GetConnectionInfoRequest request)
                                 throws io.grpc.StatusException

 Get instance metadata used for a connection.
 

Throws:

io.grpc.StatusException

listUsers

public ListUsersResponse listUsers(ListUsersRequest request)
                            throws io.grpc.StatusException

 Lists Users in a given project and location.
 

Throws:

io.grpc.StatusException

getUser

public User getUser(GetUserRequest request)
             throws io.grpc.StatusException

 Gets details of a single User.
 

Throws:

io.grpc.StatusException

createUser

public User createUser(CreateUserRequest request)
                throws io.grpc.StatusException

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

Throws:

io.grpc.StatusException

updateUser

public User updateUser(UpdateUserRequest request)
                throws io.grpc.StatusException

 Updates the parameters of a single User.
 

Throws:

io.grpc.StatusException

deleteUser

public com.google.protobuf.Empty deleteUser(DeleteUserRequest request)
                                     throws io.grpc.StatusException

 Deletes a single User.
 

Throws:

io.grpc.StatusException

listDatabases

public ListDatabasesResponse listDatabases(ListDatabasesRequest request)
                                    throws io.grpc.StatusException

 Lists Databases in a given project and location.
 

Throws:

io.grpc.StatusException

createDatabase

public Database createDatabase(CreateDatabaseRequest request)
                        throws io.grpc.StatusException

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

Throws:

io.grpc.StatusException