Class AlloyDBAdminGrpc.AlloyDBAdminBlockingStub (0.17.0)

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

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.

Parameter
NameDescription
requestBatchCreateInstancesRequest
Returns
TypeDescription
Operation

build(Channel channel, CallOptions callOptions)

protected AlloyDBAdminGrpc.AlloyDBAdminBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
AlloyDBAdminGrpc.AlloyDBAdminBlockingStub
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.

Parameter
NameDescription
requestCreateBackupRequest
Returns
TypeDescription
Operation

createCluster(CreateClusterRequest request)

public Operation createCluster(CreateClusterRequest request)

Creates a new Cluster in a given project and location.

Parameter
NameDescription
requestCreateClusterRequest
Returns
TypeDescription
Operation

createInstance(CreateInstanceRequest request)

public Operation createInstance(CreateInstanceRequest request)

Creates a new Instance in a given project and location.

Parameter
NameDescription
requestCreateInstanceRequest
Returns
TypeDescription
Operation

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.

Parameter
NameDescription
requestCreateSecondaryClusterRequest
Returns
TypeDescription
Operation

createSecondaryInstance(CreateSecondaryInstanceRequest request)

public Operation createSecondaryInstance(CreateSecondaryInstanceRequest request)

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

Parameter
NameDescription
requestCreateSecondaryInstanceRequest
Returns
TypeDescription
Operation

createUser(CreateUserRequest request)

public User createUser(CreateUserRequest request)

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

Parameter
NameDescription
requestCreateUserRequest
Returns
TypeDescription
User

deleteBackup(DeleteBackupRequest request)

public Operation deleteBackup(DeleteBackupRequest request)

Deletes a single Backup.

Parameter
NameDescription
requestDeleteBackupRequest
Returns
TypeDescription
Operation

deleteCluster(DeleteClusterRequest request)

public Operation deleteCluster(DeleteClusterRequest request)

Deletes a single Cluster.

Parameter
NameDescription
requestDeleteClusterRequest
Returns
TypeDescription
Operation

deleteInstance(DeleteInstanceRequest request)

public Operation deleteInstance(DeleteInstanceRequest request)

Deletes a single Instance.

Parameter
NameDescription
requestDeleteInstanceRequest
Returns
TypeDescription
Operation

deleteUser(DeleteUserRequest request)

public Empty deleteUser(DeleteUserRequest request)

Deletes a single User.

Parameter
NameDescription
requestDeleteUserRequest
Returns
TypeDescription
Empty

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.

Parameter
NameDescription
requestFailoverInstanceRequest
Returns
TypeDescription
Operation

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.

Parameter
NameDescription
requestGenerateClientCertificateRequest
Returns
TypeDescription
GenerateClientCertificateResponse

getBackup(GetBackupRequest request)

public Backup getBackup(GetBackupRequest request)

Gets details of a single Backup.

Parameter
NameDescription
requestGetBackupRequest
Returns
TypeDescription
Backup

getCluster(GetClusterRequest request)

public Cluster getCluster(GetClusterRequest request)

Gets details of a single Cluster.

Parameter
NameDescription
requestGetClusterRequest
Returns
TypeDescription
Cluster

getConnectionInfo(GetConnectionInfoRequest request)

public ConnectionInfo getConnectionInfo(GetConnectionInfoRequest request)

Get instance metadata used for a connection.

Parameter
NameDescription
requestGetConnectionInfoRequest
Returns
TypeDescription
ConnectionInfo

getInstance(GetInstanceRequest request)

public Instance getInstance(GetInstanceRequest request)

Gets details of a single Instance.

Parameter
NameDescription
requestGetInstanceRequest
Returns
TypeDescription
Instance

getUser(GetUserRequest request)

public User getUser(GetUserRequest request)

Gets details of a single User.

Parameter
NameDescription
requestGetUserRequest
Returns
TypeDescription
User

injectFault(InjectFaultRequest request)

public Operation injectFault(InjectFaultRequest request)

Injects fault in an instance. Imperative only.

Parameter
NameDescription
requestInjectFaultRequest
Returns
TypeDescription
Operation

listBackups(ListBackupsRequest request)

public ListBackupsResponse listBackups(ListBackupsRequest request)

Lists Backups in a given project and location.

Parameter
NameDescription
requestListBackupsRequest
Returns
TypeDescription
ListBackupsResponse

listClusters(ListClustersRequest request)

public ListClustersResponse listClusters(ListClustersRequest request)

Lists Clusters in a given project and location.

Parameter
NameDescription
requestListClustersRequest
Returns
TypeDescription
ListClustersResponse

listInstances(ListInstancesRequest request)

public ListInstancesResponse listInstances(ListInstancesRequest request)

Lists Instances in a given project and location.

Parameter
NameDescription
requestListInstancesRequest
Returns
TypeDescription
ListInstancesResponse

listSupportedDatabaseFlags(ListSupportedDatabaseFlagsRequest request)

public ListSupportedDatabaseFlagsResponse listSupportedDatabaseFlags(ListSupportedDatabaseFlagsRequest request)

Lists SupportedDatabaseFlags for a given project and location.

Parameter
NameDescription
requestListSupportedDatabaseFlagsRequest
Returns
TypeDescription
ListSupportedDatabaseFlagsResponse

listUsers(ListUsersRequest request)

public ListUsersResponse listUsers(ListUsersRequest request)

Lists Users in a given project and location.

Parameter
NameDescription
requestListUsersRequest
Returns
TypeDescription
ListUsersResponse

promoteCluster(PromoteClusterRequest request)

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.

Parameter
NameDescription
requestPromoteClusterRequest
Returns
TypeDescription
Operation

restartInstance(RestartInstanceRequest request)

public Operation restartInstance(RestartInstanceRequest request)

Restart an Instance in a cluster. Imperative only.

Parameter
NameDescription
requestRestartInstanceRequest
Returns
TypeDescription
Operation

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.

Parameter
NameDescription
requestRestoreClusterRequest
Returns
TypeDescription
Operation

updateBackup(UpdateBackupRequest request)

public Operation updateBackup(UpdateBackupRequest request)

Updates the parameters of a single Backup.

Parameter
NameDescription
requestUpdateBackupRequest
Returns
TypeDescription
Operation

updateCluster(UpdateClusterRequest request)

public Operation updateCluster(UpdateClusterRequest request)

Updates the parameters of a single Cluster.

Parameter
NameDescription
requestUpdateClusterRequest
Returns
TypeDescription
Operation

updateInstance(UpdateInstanceRequest request)

public Operation updateInstance(UpdateInstanceRequest request)

Updates the parameters of a single Instance.

Parameter
NameDescription
requestUpdateInstanceRequest
Returns
TypeDescription
Operation

updateUser(UpdateUserRequest request)

public User updateUser(UpdateUserRequest request)

Updates the parameters of a single User.

Parameter
NameDescription
requestUpdateUserRequest
Returns
TypeDescription
User