Interface AlloyDBAdminGrpc.AsyncService (0.43.0)

Version 0.43.0

• 0.44.0 (latest)
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public static interface AlloyDBAdminGrpc.AsyncService

Service describing handlers for resources

Methods

batchCreateInstances(BatchCreateInstancesRequest request, StreamObserver<Operation> responseObserver)

public default void batchCreateInstances(BatchCreateInstancesRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name	Description
request	BatchCreateInstancesRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

createBackup(CreateBackupRequest request, StreamObserver<Operation> responseObserver)

public default void createBackup(CreateBackupRequest request, StreamObserver<Operation> responseObserver)

Creates a new Backup in a given project and location.

Parameters
Name	Description
request	CreateBackupRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

createCluster(CreateClusterRequest request, StreamObserver<Operation> responseObserver)

public default void createCluster(CreateClusterRequest request, StreamObserver<Operation> responseObserver)

Creates a new Cluster in a given project and location.

Parameters
Name	Description
request	CreateClusterRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

createInstance(CreateInstanceRequest request, StreamObserver<Operation> responseObserver)

public default void createInstance(CreateInstanceRequest request, StreamObserver<Operation> responseObserver)

Creates a new Instance in a given project and location.

Parameters
Name	Description
request	CreateInstanceRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

createSecondaryCluster(CreateSecondaryClusterRequest request, StreamObserver<Operation> responseObserver)

public default void createSecondaryCluster(CreateSecondaryClusterRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name	Description
request	CreateSecondaryClusterRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

createSecondaryInstance(CreateSecondaryInstanceRequest request, StreamObserver<Operation> responseObserver)

public default void createSecondaryInstance(CreateSecondaryInstanceRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name	Description
request	CreateSecondaryInstanceRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

createUser(CreateUserRequest request, StreamObserver<User> responseObserver)

public default void createUser(CreateUserRequest request, StreamObserver<User> responseObserver)

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

Parameters
Name	Description
request	CreateUserRequest
responseObserver	io.grpc.stub.StreamObserver<User>

deleteBackup(DeleteBackupRequest request, StreamObserver<Operation> responseObserver)

public default void deleteBackup(DeleteBackupRequest request, StreamObserver<Operation> responseObserver)

Deletes a single Backup.

Parameters
Name	Description
request	DeleteBackupRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

deleteCluster(DeleteClusterRequest request, StreamObserver<Operation> responseObserver)

public default void deleteCluster(DeleteClusterRequest request, StreamObserver<Operation> responseObserver)

Deletes a single Cluster.

Parameters
Name	Description
request	DeleteClusterRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

deleteInstance(DeleteInstanceRequest request, StreamObserver<Operation> responseObserver)

public default void deleteInstance(DeleteInstanceRequest request, StreamObserver<Operation> responseObserver)

Deletes a single Instance.

Parameters
Name	Description
request	DeleteInstanceRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

deleteUser(DeleteUserRequest request, StreamObserver<Empty> responseObserver)

public default void deleteUser(DeleteUserRequest request, StreamObserver<Empty> responseObserver)

Deletes a single User.

Parameters
Name	Description
request	DeleteUserRequest
responseObserver	io.grpc.stub.StreamObserver<Empty>

executeSql(ExecuteSqlRequest request, StreamObserver<ExecuteSqlResponse> responseObserver)

public default void executeSql(ExecuteSqlRequest request, StreamObserver<ExecuteSqlResponse> responseObserver)

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

Parameters
Name	Description
request	ExecuteSqlRequest
responseObserver	io.grpc.stub.StreamObserver<ExecuteSqlResponse>

failoverInstance(FailoverInstanceRequest request, StreamObserver<Operation> responseObserver)

public default void failoverInstance(FailoverInstanceRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name	Description
request	FailoverInstanceRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

generateClientCertificate(GenerateClientCertificateRequest request, StreamObserver<GenerateClientCertificateResponse> responseObserver)

public default void generateClientCertificate(GenerateClientCertificateRequest request, StreamObserver<GenerateClientCertificateResponse> responseObserver)

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.

Parameters
Name	Description
request	GenerateClientCertificateRequest
responseObserver	io.grpc.stub.StreamObserver<GenerateClientCertificateResponse>

getBackup(GetBackupRequest request, StreamObserver<Backup> responseObserver)

public default void getBackup(GetBackupRequest request, StreamObserver<Backup> responseObserver)

Gets details of a single Backup.

Parameters
Name	Description
request	GetBackupRequest
responseObserver	io.grpc.stub.StreamObserver<Backup>

getCluster(GetClusterRequest request, StreamObserver<Cluster> responseObserver)

public default void getCluster(GetClusterRequest request, StreamObserver<Cluster> responseObserver)

Gets details of a single Cluster.

Parameters
Name	Description
request	GetClusterRequest
responseObserver	io.grpc.stub.StreamObserver<Cluster>

getConnectionInfo(GetConnectionInfoRequest request, StreamObserver<ConnectionInfo> responseObserver)

public default void getConnectionInfo(GetConnectionInfoRequest request, StreamObserver<ConnectionInfo> responseObserver)

Get instance metadata used for a connection.

Parameters
Name	Description
request	GetConnectionInfoRequest
responseObserver	io.grpc.stub.StreamObserver<ConnectionInfo>

getInstance(GetInstanceRequest request, StreamObserver<Instance> responseObserver)

public default void getInstance(GetInstanceRequest request, StreamObserver<Instance> responseObserver)

Gets details of a single Instance.

Parameters
Name	Description
request	GetInstanceRequest
responseObserver	io.grpc.stub.StreamObserver<Instance>

getUser(GetUserRequest request, StreamObserver<User> responseObserver)

public default void getUser(GetUserRequest request, StreamObserver<User> responseObserver)

Gets details of a single User.

Parameters
Name	Description
request	GetUserRequest
responseObserver	io.grpc.stub.StreamObserver<User>

injectFault(InjectFaultRequest request, StreamObserver<Operation> responseObserver)

public default void injectFault(InjectFaultRequest request, StreamObserver<Operation> responseObserver)

Injects fault in an instance. Imperative only.

Parameters
Name	Description
request	InjectFaultRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

listBackups(ListBackupsRequest request, StreamObserver<ListBackupsResponse> responseObserver)

public default void listBackups(ListBackupsRequest request, StreamObserver<ListBackupsResponse> responseObserver)

Lists Backups in a given project and location.

Parameters
Name	Description
request	ListBackupsRequest
responseObserver	io.grpc.stub.StreamObserver<ListBackupsResponse>

listClusters(ListClustersRequest request, StreamObserver<ListClustersResponse> responseObserver)

public default void listClusters(ListClustersRequest request, StreamObserver<ListClustersResponse> responseObserver)

Lists Clusters in a given project and location.

Parameters
Name	Description
request	ListClustersRequest
responseObserver	io.grpc.stub.StreamObserver<ListClustersResponse>

listDatabases(ListDatabasesRequest request, StreamObserver<ListDatabasesResponse> responseObserver)

public default void listDatabases(ListDatabasesRequest request, StreamObserver<ListDatabasesResponse> responseObserver)

Lists Databases in a given project and location.

Parameters
Name	Description
request	ListDatabasesRequest
responseObserver	io.grpc.stub.StreamObserver<ListDatabasesResponse>

listInstances(ListInstancesRequest request, StreamObserver<ListInstancesResponse> responseObserver)

public default void listInstances(ListInstancesRequest request, StreamObserver<ListInstancesResponse> responseObserver)

Lists Instances in a given project and location.

Parameters
Name	Description
request	ListInstancesRequest
responseObserver	io.grpc.stub.StreamObserver<ListInstancesResponse>

listSupportedDatabaseFlags(ListSupportedDatabaseFlagsRequest request, StreamObserver<ListSupportedDatabaseFlagsResponse> responseObserver)

public default void listSupportedDatabaseFlags(ListSupportedDatabaseFlagsRequest request, StreamObserver<ListSupportedDatabaseFlagsResponse> responseObserver)

Lists SupportedDatabaseFlags for a given project and location.

Parameters
Name	Description
request	ListSupportedDatabaseFlagsRequest
responseObserver	io.grpc.stub.StreamObserver<ListSupportedDatabaseFlagsResponse>

listUsers(ListUsersRequest request, StreamObserver<ListUsersResponse> responseObserver)

public default void listUsers(ListUsersRequest request, StreamObserver<ListUsersResponse> responseObserver)

Lists Users in a given project and location.

Parameters
Name	Description
request	ListUsersRequest
responseObserver	io.grpc.stub.StreamObserver<ListUsersResponse>

promoteCluster(PromoteClusterRequest request, StreamObserver<Operation> responseObserver)

public default void promoteCluster(PromoteClusterRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name	Description
request	PromoteClusterRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

restartInstance(RestartInstanceRequest request, StreamObserver<Operation> responseObserver)

public default void restartInstance(RestartInstanceRequest request, StreamObserver<Operation> responseObserver)

Restart an Instance in a cluster. Imperative only.

Parameters
Name	Description
request	RestartInstanceRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

restoreCluster(RestoreClusterRequest request, StreamObserver<Operation> responseObserver)

public default void restoreCluster(RestoreClusterRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name	Description
request	RestoreClusterRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

switchoverCluster(SwitchoverClusterRequest request, StreamObserver<Operation> responseObserver)

public default void switchoverCluster(SwitchoverClusterRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name	Description
request	SwitchoverClusterRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

updateBackup(UpdateBackupRequest request, StreamObserver<Operation> responseObserver)

public default void updateBackup(UpdateBackupRequest request, StreamObserver<Operation> responseObserver)

Updates the parameters of a single Backup.

Parameters
Name	Description
request	UpdateBackupRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

updateCluster(UpdateClusterRequest request, StreamObserver<Operation> responseObserver)

public default void updateCluster(UpdateClusterRequest request, StreamObserver<Operation> responseObserver)

Updates the parameters of a single Cluster.

Parameters
Name	Description
request	UpdateClusterRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

updateInstance(UpdateInstanceRequest request, StreamObserver<Operation> responseObserver)

public default void updateInstance(UpdateInstanceRequest request, StreamObserver<Operation> responseObserver)

Updates the parameters of a single Instance.

Parameters
Name	Description
request	UpdateInstanceRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

updateUser(UpdateUserRequest request, StreamObserver<User> responseObserver)

public default void updateUser(UpdateUserRequest request, StreamObserver<User> responseObserver)

Updates the parameters of a single User.

Parameters
Name	Description
request	UpdateUserRequest
responseObserver	io.grpc.stub.StreamObserver<User>

upgradeCluster(UpgradeClusterRequest request, StreamObserver<Operation> responseObserver)

public default void upgradeCluster(UpgradeClusterRequest request, StreamObserver<Operation> responseObserver)

Upgrades a single Cluster. Imperative only.

Parameters
Name	Description
request	UpgradeClusterRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>