Class AlloyDBAdminGrpc.AlloyDBAdminFutureStub (0.44.0)

public static final class AlloyDBAdminGrpc.AlloyDBAdminFutureStub extends AbstractFutureStub<AlloyDBAdminGrpc.AlloyDBAdminFutureStub>

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

Service describing handlers for resources

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > AlloyDBAdminGrpc.AlloyDBAdminFutureStub

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

batchCreateInstances(BatchCreateInstancesRequest request)

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

Parameter
Name	Description
`request`	`BatchCreateInstancesRequest`

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

build(Channel channel, CallOptions callOptions)

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

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

Returns
Type	Description
`AlloyDBAdminGrpc.AlloyDBAdminFutureStub`

Overrides

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

createBackup(CreateBackupRequest request)

public ListenableFuture<Operation> createBackup(CreateBackupRequest request)

Creates a new Backup in a given project and location.

Parameter
Name	Description
`request`	`CreateBackupRequest`

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

createCluster(CreateClusterRequest request)

public ListenableFuture<Operation> createCluster(CreateClusterRequest request)

Creates a new Cluster in a given project and location.

Parameter
Name	Description
`request`	`CreateClusterRequest`

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

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>`

createSecondaryCluster(CreateSecondaryClusterRequest request)

public ListenableFuture<Operation> createSecondaryCluster(CreateSecondaryClusterRequest request)

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

Parameter
Name	Description
`request`	`CreateSecondaryClusterRequest`

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

createSecondaryInstance(CreateSecondaryInstanceRequest request)

public ListenableFuture<Operation> createSecondaryInstance(CreateSecondaryInstanceRequest request)

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

Parameter
Name	Description
`request`	`CreateSecondaryInstanceRequest`

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

createUser(CreateUserRequest request)

public ListenableFuture<User> createUser(CreateUserRequest request)

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

Parameter
Name	Description
`request`	`CreateUserRequest`

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

deleteBackup(DeleteBackupRequest request)

public ListenableFuture<Operation> deleteBackup(DeleteBackupRequest request)

Deletes a single Backup.

Parameter
Name	Description
`request`	`DeleteBackupRequest`

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

deleteCluster(DeleteClusterRequest request)

public ListenableFuture<Operation> deleteCluster(DeleteClusterRequest request)

Deletes a single Cluster.

Parameter
Name	Description
`request`	`DeleteClusterRequest`

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>`

deleteUser(DeleteUserRequest request)

public ListenableFuture<Empty> deleteUser(DeleteUserRequest request)

Deletes a single User.

Parameter
Name	Description
`request`	`DeleteUserRequest`

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

executeSql(ExecuteSqlRequest request)

public ListenableFuture<ExecuteSqlResponse> executeSql(ExecuteSqlRequest request)

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

Parameter
Name	Description
`request`	`ExecuteSqlRequest`

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

failoverInstance(FailoverInstanceRequest request)

public ListenableFuture<Operation> failoverInstance(FailoverInstanceRequest request)

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

Parameter
Name	Description
`request`	`FailoverInstanceRequest`

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

generateClientCertificate(GenerateClientCertificateRequest request)

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

Parameter
Name	Description
`request`	`GenerateClientCertificateRequest`

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

getBackup(GetBackupRequest request)

public ListenableFuture<Backup> getBackup(GetBackupRequest request)

Gets details of a single Backup.

Parameter
Name	Description
`request`	`GetBackupRequest`

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

getCluster(GetClusterRequest request)

public ListenableFuture<Cluster> getCluster(GetClusterRequest request)

Gets details of a single Cluster.

Parameter
Name	Description
`request`	`GetClusterRequest`

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

getConnectionInfo(GetConnectionInfoRequest request)

public ListenableFuture<ConnectionInfo> getConnectionInfo(GetConnectionInfoRequest request)

Get instance metadata used for a connection.

Parameter
Name	Description
`request`	`GetConnectionInfoRequest`

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

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>`

getUser(GetUserRequest request)

public ListenableFuture<User> getUser(GetUserRequest request)

Gets details of a single User.

Parameter
Name	Description
`request`	`GetUserRequest`

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

injectFault(InjectFaultRequest request)

public ListenableFuture<Operation> injectFault(InjectFaultRequest request)

Injects fault in an instance. Imperative only.

Parameter
Name	Description
`request`	`InjectFaultRequest`

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

listBackups(ListBackupsRequest request)

public ListenableFuture<ListBackupsResponse> listBackups(ListBackupsRequest request)

Lists Backups in a given project and location.

Parameter
Name	Description
`request`	`ListBackupsRequest`

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

listClusters(ListClustersRequest request)

public ListenableFuture<ListClustersResponse> listClusters(ListClustersRequest request)

Lists Clusters in a given project and location.

Parameter
Name	Description
`request`	`ListClustersRequest`

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

listDatabases(ListDatabasesRequest request)

public ListenableFuture<ListDatabasesResponse> listDatabases(ListDatabasesRequest request)

Lists Databases in a given project and location.

Parameter
Name	Description
`request`	`ListDatabasesRequest`

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

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>`

listSupportedDatabaseFlags(ListSupportedDatabaseFlagsRequest request)

public ListenableFuture<ListSupportedDatabaseFlagsResponse> listSupportedDatabaseFlags(ListSupportedDatabaseFlagsRequest request)

Lists SupportedDatabaseFlags for a given project and location.

Parameter
Name	Description
`request`	`ListSupportedDatabaseFlagsRequest`

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

listUsers(ListUsersRequest request)

public ListenableFuture<ListUsersResponse> listUsers(ListUsersRequest request)

Lists Users in a given project and location.

Parameter
Name	Description
`request`	`ListUsersRequest`

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

promoteCluster(PromoteClusterRequest request)

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

Parameter
Name	Description
`request`	`PromoteClusterRequest`

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

restartInstance(RestartInstanceRequest request)

public ListenableFuture<Operation> restartInstance(RestartInstanceRequest request)

Restart an Instance in a cluster. Imperative only.

Parameter
Name	Description
`request`	`RestartInstanceRequest`

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

restoreCluster(RestoreClusterRequest request)

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

Parameter
Name	Description
`request`	`RestoreClusterRequest`

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

switchoverCluster(SwitchoverClusterRequest request)

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

Parameter
Name	Description
`request`	`SwitchoverClusterRequest`

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

updateBackup(UpdateBackupRequest request)

public ListenableFuture<Operation> updateBackup(UpdateBackupRequest request)

Updates the parameters of a single Backup.

Parameter
Name	Description
`request`	`UpdateBackupRequest`

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

updateCluster(UpdateClusterRequest request)

public ListenableFuture<Operation> updateCluster(UpdateClusterRequest request)

Updates the parameters of a single Cluster.

Parameter
Name	Description
`request`	`UpdateClusterRequest`

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>`

updateUser(UpdateUserRequest request)

public ListenableFuture<User> updateUser(UpdateUserRequest request)

Updates the parameters of a single User.

Parameter
Name	Description
`request`	`UpdateUserRequest`

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

upgradeCluster(UpgradeClusterRequest request)

public ListenableFuture<Operation> upgradeCluster(UpgradeClusterRequest request)

Upgrades a single Cluster. Imperative only.

Parameter
Name	Description
`request`	`UpgradeClusterRequest`

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