public static final class AlloyDBAdminGrpc.AlloyDBAdminBlockingStub extends AbstractBlockingStub<AlloyDBAdminGrpc.AlloyDBAdminBlockingStub>
A stub to allow clients to do synchronous rpc calls to service AlloyDBAdmin.
Service describing handlers for resources
Inheritance
java.lang.Object >
io.grpc.stub.AbstractStub >
io.grpc.stub.AbstractBlockingStub >
AlloyDBAdminGrpc.AlloyDBAdminBlockingStub
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(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
batchCreateInstances(BatchCreateInstancesRequest request)
public 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.
build(Channel channel, CallOptions callOptions)
protected AlloyDBAdminGrpc.AlloyDBAdminBlockingStub 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)
createBackup(CreateBackupRequest request)
public Operation createBackup(CreateBackupRequest request)
Creates a new Backup in a given project and location.
createCluster(CreateClusterRequest request)
public Operation createCluster(CreateClusterRequest request)
Creates a new Cluster in a given project and location.
createInstance(CreateInstanceRequest request)
public Operation createInstance(CreateInstanceRequest request)
Creates a new Instance in a given project and location.
createSecondaryCluster(CreateSecondaryClusterRequest request)
public Operation createSecondaryCluster(CreateSecondaryClusterRequest request)
Creates a cluster of type SECONDARY in the given location using
the primary cluster as the source.
createSecondaryInstance(CreateSecondaryInstanceRequest request)
public Operation createSecondaryInstance(CreateSecondaryInstanceRequest request)
Creates a new SECONDARY Instance in a given project and location.
createUser(CreateUserRequest request)
public User createUser(CreateUserRequest request)
Creates a new User in a given project, location, and cluster.
| Returns |
| Type |
Description |
User |
|
deleteBackup(DeleteBackupRequest request)
public Operation deleteBackup(DeleteBackupRequest request)
deleteCluster(DeleteClusterRequest request)
public Operation deleteCluster(DeleteClusterRequest request)
Deletes a single Cluster.
deleteInstance(DeleteInstanceRequest request)
public Operation deleteInstance(DeleteInstanceRequest request)
Deletes a single Instance.
deleteUser(DeleteUserRequest request)
public Empty deleteUser(DeleteUserRequest request)
| Returns |
| Type |
Description |
Empty |
|
executeSql(ExecuteSqlRequest request)
public ExecuteSqlResponse executeSql(ExecuteSqlRequest request)
Executes a SQL statement in a database inside an AlloyDB instance.
failoverInstance(FailoverInstanceRequest request)
public Operation failoverInstance(FailoverInstanceRequest request)
Forces a Failover for a highly available instance.
Failover promotes the HA standby instance as the new primary.
Imperative only.
generateClientCertificate(GenerateClientCertificateRequest request)
public GenerateClientCertificateResponse generateClientCertificate(GenerateClientCertificateRequest request)
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.
getBackup(GetBackupRequest request)
public Backup getBackup(GetBackupRequest request)
Gets details of a single Backup.
| Returns |
| Type |
Description |
Backup |
|
getCluster(GetClusterRequest request)
public Cluster getCluster(GetClusterRequest request)
Gets details of a single Cluster.
getConnectionInfo(GetConnectionInfoRequest request)
public ConnectionInfo getConnectionInfo(GetConnectionInfoRequest request)
Get instance metadata used for a connection.
getInstance(GetInstanceRequest request)
public Instance getInstance(GetInstanceRequest request)
Gets details of a single Instance.
getUser(GetUserRequest request)
public User getUser(GetUserRequest request)
Gets details of a single User.
| Returns |
| Type |
Description |
User |
|
injectFault(InjectFaultRequest request)
public Operation injectFault(InjectFaultRequest request)
Injects fault in an instance.
Imperative only.
listBackups(ListBackupsRequest request)
public ListBackupsResponse listBackups(ListBackupsRequest request)
Lists Backups in a given project and location.
listClusters(ListClustersRequest request)
public ListClustersResponse listClusters(ListClustersRequest request)
Lists Clusters in a given project and location.
listDatabases(ListDatabasesRequest request)
public ListDatabasesResponse listDatabases(ListDatabasesRequest request)
Lists Databases in a given project and location.
listInstances(ListInstancesRequest request)
public ListInstancesResponse listInstances(ListInstancesRequest request)
Lists Instances in a given project and location.
listSupportedDatabaseFlags(ListSupportedDatabaseFlagsRequest request)
public ListSupportedDatabaseFlagsResponse listSupportedDatabaseFlags(ListSupportedDatabaseFlagsRequest request)
Lists SupportedDatabaseFlags for a given project and location.
listUsers(ListUsersRequest request)
public ListUsersResponse listUsers(ListUsersRequest request)
Lists Users in a given project and location.
public 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.
restartInstance(RestartInstanceRequest request)
public Operation restartInstance(RestartInstanceRequest request)
Restart an Instance in a cluster.
Imperative only.
restoreCluster(RestoreClusterRequest request)
public 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.
switchoverCluster(SwitchoverClusterRequest request)
public Operation switchoverCluster(SwitchoverClusterRequest request)
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.
updateBackup(UpdateBackupRequest request)
public Operation updateBackup(UpdateBackupRequest request)
Updates the parameters of a single Backup.
updateCluster(UpdateClusterRequest request)
public Operation updateCluster(UpdateClusterRequest request)
Updates the parameters of a single Cluster.
updateInstance(UpdateInstanceRequest request)
public Operation updateInstance(UpdateInstanceRequest request)
Updates the parameters of a single Instance.
updateUser(UpdateUserRequest request)
public User updateUser(UpdateUserRequest request)
Updates the parameters of a single User.
| Returns |
| Type |
Description |
User |
|
upgradeCluster(UpgradeClusterRequest request)
public Operation upgradeCluster(UpgradeClusterRequest request)
Upgrades a single Cluster.
Imperative only.
