AlloyDB v1 API - Class AlloyDBAdmin.AlloyDBAdminBase (1.7.0)

Version 1.7.0

• 1.9.0 (latest)
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

[BindServiceMethod(typeof(AlloyDBAdmin), "BindService")]
public abstract class AlloyDBAdmin.AlloyDBAdminBase

Reference documentation and code samples for the AlloyDB v1 API class AlloyDBAdmin.AlloyDBAdminBase.

Base class for server-side implementations of AlloyDBAdmin

Inheritance

object > AlloyDBAdmin.AlloyDBAdminBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.AlloyDb.V1

Assembly

Google.Cloud.AlloyDb.V1.dll

Methods

BatchCreateInstances(BatchCreateInstancesRequest, ServerCallContext)

public virtual Task<Operation> BatchCreateInstances(BatchCreateInstancesRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateBackup(CreateBackupRequest, ServerCallContext)

public virtual Task<Operation> CreateBackup(CreateBackupRequest request, ServerCallContext context)

Creates a new Backup in a given project and location.

Parameters
Name	Description
request	CreateBackupRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateCluster(CreateClusterRequest, ServerCallContext)

public virtual Task<Operation> CreateCluster(CreateClusterRequest request, ServerCallContext context)

Creates a new Cluster in a given project and location.

Parameters
Name	Description
request	CreateClusterRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateInstance(CreateInstanceRequest, ServerCallContext)

public virtual Task<Operation> CreateInstance(CreateInstanceRequest request, ServerCallContext context)

Creates a new Instance in a given project and location.

Parameters
Name	Description
request	CreateInstanceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateSecondaryCluster(CreateSecondaryClusterRequest, ServerCallContext)

public virtual Task<Operation> CreateSecondaryCluster(CreateSecondaryClusterRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	CreateSecondaryClusterRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateSecondaryInstance(CreateSecondaryInstanceRequest, ServerCallContext)

public virtual Task<Operation> CreateSecondaryInstance(CreateSecondaryInstanceRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	CreateSecondaryInstanceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateUser(CreateUserRequest, ServerCallContext)

public virtual Task<User> CreateUser(CreateUserRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	CreateUserRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskUser	The response to send back to the client (wrapped by a task).

DeleteBackup(DeleteBackupRequest, ServerCallContext)

public virtual Task<Operation> DeleteBackup(DeleteBackupRequest request, ServerCallContext context)

Deletes a single Backup.

Parameters
Name	Description
request	DeleteBackupRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteCluster(DeleteClusterRequest, ServerCallContext)

public virtual Task<Operation> DeleteCluster(DeleteClusterRequest request, ServerCallContext context)

Deletes a single Cluster.

Parameters
Name	Description
request	DeleteClusterRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteInstance(DeleteInstanceRequest, ServerCallContext)

public virtual Task<Operation> DeleteInstance(DeleteInstanceRequest request, ServerCallContext context)

Deletes a single Instance.

Parameters
Name	Description
request	DeleteInstanceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteUser(DeleteUserRequest, ServerCallContext)

public virtual Task<Empty> DeleteUser(DeleteUserRequest request, ServerCallContext context)

Deletes a single User.

Parameters
Name	Description
request	DeleteUserRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

FailoverInstance(FailoverInstanceRequest, ServerCallContext)

public virtual Task<Operation> FailoverInstance(FailoverInstanceRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

GenerateClientCertificate(GenerateClientCertificateRequest, ServerCallContext)

public virtual Task<GenerateClientCertificateResponse> GenerateClientCertificate(GenerateClientCertificateRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskGenerateClientCertificateResponse	The response to send back to the client (wrapped by a task).

GetBackup(GetBackupRequest, ServerCallContext)

public virtual Task<Backup> GetBackup(GetBackupRequest request, ServerCallContext context)

Gets details of a single Backup.

Parameters
Name	Description
request	GetBackupRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskBackup	The response to send back to the client (wrapped by a task).

GetCluster(GetClusterRequest, ServerCallContext)

public virtual Task<Cluster> GetCluster(GetClusterRequest request, ServerCallContext context)

Gets details of a single Cluster.

Parameters
Name	Description
request	GetClusterRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskCluster	The response to send back to the client (wrapped by a task).

GetConnectionInfo(GetConnectionInfoRequest, ServerCallContext)

public virtual Task<ConnectionInfo> GetConnectionInfo(GetConnectionInfoRequest request, ServerCallContext context)

Get instance metadata used for a connection.

Parameters
Name	Description
request	GetConnectionInfoRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskConnectionInfo	The response to send back to the client (wrapped by a task).

GetInstance(GetInstanceRequest, ServerCallContext)

public virtual Task<Instance> GetInstance(GetInstanceRequest request, ServerCallContext context)

Gets details of a single Instance.

Parameters
Name	Description
request	GetInstanceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskInstance	The response to send back to the client (wrapped by a task).

GetUser(GetUserRequest, ServerCallContext)

public virtual Task<User> GetUser(GetUserRequest request, ServerCallContext context)

Gets details of a single User.

Parameters
Name	Description
request	GetUserRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskUser	The response to send back to the client (wrapped by a task).

InjectFault(InjectFaultRequest, ServerCallContext)

public virtual Task<Operation> InjectFault(InjectFaultRequest request, ServerCallContext context)

Injects fault in an instance. Imperative only.

Parameters
Name	Description
request	InjectFaultRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

ListBackups(ListBackupsRequest, ServerCallContext)

public virtual Task<ListBackupsResponse> ListBackups(ListBackupsRequest request, ServerCallContext context)

Lists Backups in a given project and location.

Parameters
Name	Description
request	ListBackupsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListBackupsResponse	The response to send back to the client (wrapped by a task).

ListClusters(ListClustersRequest, ServerCallContext)

public virtual Task<ListClustersResponse> ListClusters(ListClustersRequest request, ServerCallContext context)

Lists Clusters in a given project and location.

Parameters
Name	Description
request	ListClustersRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListClustersResponse	The response to send back to the client (wrapped by a task).

ListInstances(ListInstancesRequest, ServerCallContext)

public virtual Task<ListInstancesResponse> ListInstances(ListInstancesRequest request, ServerCallContext context)

Lists Instances in a given project and location.

Parameters
Name	Description
request	ListInstancesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListInstancesResponse	The response to send back to the client (wrapped by a task).

ListSupportedDatabaseFlags(ListSupportedDatabaseFlagsRequest, ServerCallContext)

public virtual Task<ListSupportedDatabaseFlagsResponse> ListSupportedDatabaseFlags(ListSupportedDatabaseFlagsRequest request, ServerCallContext context)

Lists SupportedDatabaseFlags for a given project and location.

Parameters
Name	Description
request	ListSupportedDatabaseFlagsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListSupportedDatabaseFlagsResponse	The response to send back to the client (wrapped by a task).

ListUsers(ListUsersRequest, ServerCallContext)

public virtual Task<ListUsersResponse> ListUsers(ListUsersRequest request, ServerCallContext context)

Lists Users in a given project and location.

Parameters
Name	Description
request	ListUsersRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListUsersResponse	The response to send back to the client (wrapped by a task).

PromoteCluster(PromoteClusterRequest, ServerCallContext)

public virtual Task<Operation> PromoteCluster(PromoteClusterRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

RestartInstance(RestartInstanceRequest, ServerCallContext)

public virtual Task<Operation> RestartInstance(RestartInstanceRequest request, ServerCallContext context)

Restart an Instance in a cluster. Imperative only.

Parameters
Name	Description
request	RestartInstanceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

RestoreCluster(RestoreClusterRequest, ServerCallContext)

public virtual Task<Operation> RestoreCluster(RestoreClusterRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateBackup(UpdateBackupRequest, ServerCallContext)

public virtual Task<Operation> UpdateBackup(UpdateBackupRequest request, ServerCallContext context)

Updates the parameters of a single Backup.

Parameters
Name	Description
request	UpdateBackupRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateCluster(UpdateClusterRequest, ServerCallContext)

public virtual Task<Operation> UpdateCluster(UpdateClusterRequest request, ServerCallContext context)

Updates the parameters of a single Cluster.

Parameters
Name	Description
request	UpdateClusterRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateInstance(UpdateInstanceRequest, ServerCallContext)

public virtual Task<Operation> UpdateInstance(UpdateInstanceRequest request, ServerCallContext context)

Updates the parameters of a single Instance.

Parameters
Name	Description
request	UpdateInstanceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateUser(UpdateUserRequest, ServerCallContext)

public virtual Task<User> UpdateUser(UpdateUserRequest request, ServerCallContext context)

Updates the parameters of a single User.

Parameters
Name	Description
request	UpdateUserRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskUser	The response to send back to the client (wrapped by a task).