AlloyDB v1 API - Class AlloyDBAdmin.AlloyDBAdminClient (1.6.0)

Version 1.6.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

public class AlloyDBAdmin.AlloyDBAdminClient : ClientBase<AlloyDBAdmin.AlloyDBAdminClient>

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

Client for AlloyDBAdmin

Inheritance

object > ClientBase > ClientBaseAlloyDBAdminAlloyDBAdminClient > AlloyDBAdmin.AlloyDBAdminClient

Inherited Members

ClientBase<AlloyDBAdmin.AlloyDBAdminClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.AlloyDb.V1

Assembly

Google.Cloud.AlloyDb.V1.dll

Constructors

AlloyDBAdminClient()

protected AlloyDBAdminClient()

Protected parameterless constructor to allow creation of test doubles.

AlloyDBAdminClient(CallInvoker)

public AlloyDBAdminClient(CallInvoker callInvoker)

Creates a new client for AlloyDBAdmin that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

AlloyDBAdminClient(ChannelBase)

public AlloyDBAdminClient(ChannelBase channel)

Creates a new client for AlloyDBAdmin

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

AlloyDBAdminClient(ClientBaseConfiguration)

protected AlloyDBAdminClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

BatchCreateInstances(BatchCreateInstancesRequest, CallOptions)

public virtual Operation BatchCreateInstances(BatchCreateInstancesRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

BatchCreateInstances(BatchCreateInstancesRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation BatchCreateInstances(BatchCreateInstancesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

BatchCreateInstancesAsync(BatchCreateInstancesRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> BatchCreateInstancesAsync(BatchCreateInstancesRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

BatchCreateInstancesAsync(BatchCreateInstancesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> BatchCreateInstancesAsync(BatchCreateInstancesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateBackup(CreateBackupRequest, CallOptions)

public virtual Operation CreateBackup(CreateBackupRequest request, CallOptions options)

Creates a new Backup in a given project and location.

Parameters
Name	Description
request	CreateBackupRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

CreateBackup(CreateBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateBackup(CreateBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new Backup in a given project and location.

Parameters
Name	Description
request	CreateBackupRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

CreateBackupAsync(CreateBackupRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateBackupAsync(CreateBackupRequest request, CallOptions options)

Creates a new Backup in a given project and location.

Parameters
Name	Description
request	CreateBackupRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateBackupAsync(CreateBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateBackupAsync(CreateBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new Backup in a given project and location.

Parameters
Name	Description
request	CreateBackupRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateCluster(CreateClusterRequest, CallOptions)

public virtual Operation CreateCluster(CreateClusterRequest request, CallOptions options)

Creates a new Cluster in a given project and location.

Parameters
Name	Description
request	CreateClusterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

CreateCluster(CreateClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateCluster(CreateClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new Cluster in a given project and location.

Parameters
Name	Description
request	CreateClusterRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

CreateClusterAsync(CreateClusterRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateClusterAsync(CreateClusterRequest request, CallOptions options)

Creates a new Cluster in a given project and location.

Parameters
Name	Description
request	CreateClusterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateClusterAsync(CreateClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateClusterAsync(CreateClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new Cluster in a given project and location.

Parameters
Name	Description
request	CreateClusterRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
Type	Description
IAMPolicyIAMPolicyClient	A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateInstance(CreateInstanceRequest, CallOptions)

public virtual Operation CreateInstance(CreateInstanceRequest request, CallOptions options)

Creates a new Instance in a given project and location.

Parameters
Name	Description
request	CreateInstanceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

CreateInstance(CreateInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateInstance(CreateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new Instance in a given project and location.

Parameters
Name	Description
request	CreateInstanceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

CreateInstanceAsync(CreateInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateInstanceAsync(CreateInstanceRequest request, CallOptions options)

Creates a new Instance in a given project and location.

Parameters
Name	Description
request	CreateInstanceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateInstanceAsync(CreateInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateInstanceAsync(CreateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new Instance in a given project and location.

Parameters
Name	Description
request	CreateInstanceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type	Description
LocationsLocationsClient	A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

CreateSecondaryCluster(CreateSecondaryClusterRequest, CallOptions)

public virtual Operation CreateSecondaryCluster(CreateSecondaryClusterRequest request, CallOptions options)

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

Parameters
Name	Description
request	CreateSecondaryClusterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

CreateSecondaryCluster(CreateSecondaryClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateSecondaryCluster(CreateSecondaryClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	CreateSecondaryClusterRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

CreateSecondaryClusterAsync(CreateSecondaryClusterRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateSecondaryClusterAsync(CreateSecondaryClusterRequest request, CallOptions options)

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

Parameters
Name	Description
request	CreateSecondaryClusterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateSecondaryClusterAsync(CreateSecondaryClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateSecondaryClusterAsync(CreateSecondaryClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	CreateSecondaryClusterRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateSecondaryInstance(CreateSecondaryInstanceRequest, CallOptions)

public virtual Operation CreateSecondaryInstance(CreateSecondaryInstanceRequest request, CallOptions options)

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

Parameters
Name	Description
request	CreateSecondaryInstanceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

CreateSecondaryInstance(CreateSecondaryInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateSecondaryInstance(CreateSecondaryInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	CreateSecondaryInstanceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

CreateSecondaryInstanceAsync(CreateSecondaryInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateSecondaryInstanceAsync(CreateSecondaryInstanceRequest request, CallOptions options)

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

Parameters
Name	Description
request	CreateSecondaryInstanceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateSecondaryInstanceAsync(CreateSecondaryInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateSecondaryInstanceAsync(CreateSecondaryInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	CreateSecondaryInstanceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateUser(CreateUserRequest, CallOptions)

public virtual User CreateUser(CreateUserRequest request, CallOptions options)

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

Parameters
Name	Description
request	CreateUserRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
User	The response received from the server.

CreateUser(CreateUserRequest, Metadata, DateTime?, CancellationToken)

public virtual User CreateUser(CreateUserRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	CreateUserRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
User	The response received from the server.

CreateUserAsync(CreateUserRequest, CallOptions)

public virtual AsyncUnaryCall<User> CreateUserAsync(CreateUserRequest request, CallOptions options)

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

Parameters
Name	Description
request	CreateUserRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallUser	The call object.

CreateUserAsync(CreateUserRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<User> CreateUserAsync(CreateUserRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	CreateUserRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallUser	The call object.

DeleteBackup(DeleteBackupRequest, CallOptions)

public virtual Operation DeleteBackup(DeleteBackupRequest request, CallOptions options)

Deletes a single Backup.

Parameters
Name	Description
request	DeleteBackupRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteBackup(DeleteBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteBackup(DeleteBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a single Backup.

Parameters
Name	Description
request	DeleteBackupRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteBackupAsync(DeleteBackupRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteBackupAsync(DeleteBackupRequest request, CallOptions options)

Deletes a single Backup.

Parameters
Name	Description
request	DeleteBackupRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteBackupAsync(DeleteBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteBackupAsync(DeleteBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a single Backup.

Parameters
Name	Description
request	DeleteBackupRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteCluster(DeleteClusterRequest, CallOptions)

public virtual Operation DeleteCluster(DeleteClusterRequest request, CallOptions options)

Deletes a single Cluster.

Parameters
Name	Description
request	DeleteClusterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteCluster(DeleteClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteCluster(DeleteClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a single Cluster.

Parameters
Name	Description
request	DeleteClusterRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteClusterAsync(DeleteClusterRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteClusterAsync(DeleteClusterRequest request, CallOptions options)

Deletes a single Cluster.

Parameters
Name	Description
request	DeleteClusterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteClusterAsync(DeleteClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteClusterAsync(DeleteClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a single Cluster.

Parameters
Name	Description
request	DeleteClusterRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteInstance(DeleteInstanceRequest, CallOptions)

public virtual Operation DeleteInstance(DeleteInstanceRequest request, CallOptions options)

Deletes a single Instance.

Parameters
Name	Description
request	DeleteInstanceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteInstance(DeleteInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteInstance(DeleteInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a single Instance.

Parameters
Name	Description
request	DeleteInstanceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteInstanceAsync(DeleteInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteInstanceAsync(DeleteInstanceRequest request, CallOptions options)

Deletes a single Instance.

Parameters
Name	Description
request	DeleteInstanceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteInstanceAsync(DeleteInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteInstanceAsync(DeleteInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a single Instance.

Parameters
Name	Description
request	DeleteInstanceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteUser(DeleteUserRequest, CallOptions)

public virtual Empty DeleteUser(DeleteUserRequest request, CallOptions options)

Deletes a single User.

Parameters
Name	Description
request	DeleteUserRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteUser(DeleteUserRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteUser(DeleteUserRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a single User.

Parameters
Name	Description
request	DeleteUserRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteUserAsync(DeleteUserRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteUserAsync(DeleteUserRequest request, CallOptions options)

Deletes a single User.

Parameters
Name	Description
request	DeleteUserRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteUserAsync(DeleteUserRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteUserAsync(DeleteUserRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a single User.

Parameters
Name	Description
request	DeleteUserRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

FailoverInstance(FailoverInstanceRequest, CallOptions)

public virtual Operation FailoverInstance(FailoverInstanceRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

FailoverInstance(FailoverInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation FailoverInstance(FailoverInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

FailoverInstanceAsync(FailoverInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> FailoverInstanceAsync(FailoverInstanceRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

FailoverInstanceAsync(FailoverInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> FailoverInstanceAsync(FailoverInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

GenerateClientCertificate(GenerateClientCertificateRequest, CallOptions)

public virtual GenerateClientCertificateResponse GenerateClientCertificate(GenerateClientCertificateRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
GenerateClientCertificateResponse	The response received from the server.

GenerateClientCertificate(GenerateClientCertificateRequest, Metadata, DateTime?, CancellationToken)

public virtual GenerateClientCertificateResponse GenerateClientCertificate(GenerateClientCertificateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
GenerateClientCertificateResponse	The response received from the server.

GenerateClientCertificateAsync(GenerateClientCertificateRequest, CallOptions)

public virtual AsyncUnaryCall<GenerateClientCertificateResponse> GenerateClientCertificateAsync(GenerateClientCertificateRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallGenerateClientCertificateResponse	The call object.

GenerateClientCertificateAsync(GenerateClientCertificateRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<GenerateClientCertificateResponse> GenerateClientCertificateAsync(GenerateClientCertificateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallGenerateClientCertificateResponse	The call object.

GetBackup(GetBackupRequest, CallOptions)

public virtual Backup GetBackup(GetBackupRequest request, CallOptions options)

Gets details of a single Backup.

Parameters
Name	Description
request	GetBackupRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Backup	The response received from the server.

GetBackup(GetBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual Backup GetBackup(GetBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single Backup.

Parameters
Name	Description
request	GetBackupRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Backup	The response received from the server.

GetBackupAsync(GetBackupRequest, CallOptions)

public virtual AsyncUnaryCall<Backup> GetBackupAsync(GetBackupRequest request, CallOptions options)

Gets details of a single Backup.

Parameters
Name	Description
request	GetBackupRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallBackup	The call object.

GetBackupAsync(GetBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Backup> GetBackupAsync(GetBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single Backup.

Parameters
Name	Description
request	GetBackupRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallBackup	The call object.

GetCluster(GetClusterRequest, CallOptions)

public virtual Cluster GetCluster(GetClusterRequest request, CallOptions options)

Gets details of a single Cluster.

Parameters
Name	Description
request	GetClusterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Cluster	The response received from the server.

GetCluster(GetClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual Cluster GetCluster(GetClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single Cluster.

Parameters
Name	Description
request	GetClusterRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Cluster	The response received from the server.

GetClusterAsync(GetClusterRequest, CallOptions)

public virtual AsyncUnaryCall<Cluster> GetClusterAsync(GetClusterRequest request, CallOptions options)

Gets details of a single Cluster.

Parameters
Name	Description
request	GetClusterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallCluster	The call object.

GetClusterAsync(GetClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Cluster> GetClusterAsync(GetClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single Cluster.

Parameters
Name	Description
request	GetClusterRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallCluster	The call object.

GetConnectionInfo(GetConnectionInfoRequest, CallOptions)

public virtual ConnectionInfo GetConnectionInfo(GetConnectionInfoRequest request, CallOptions options)

Get instance metadata used for a connection.

Parameters
Name	Description
request	GetConnectionInfoRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ConnectionInfo	The response received from the server.

GetConnectionInfo(GetConnectionInfoRequest, Metadata, DateTime?, CancellationToken)

public virtual ConnectionInfo GetConnectionInfo(GetConnectionInfoRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get instance metadata used for a connection.

Parameters
Name	Description
request	GetConnectionInfoRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ConnectionInfo	The response received from the server.

GetConnectionInfoAsync(GetConnectionInfoRequest, CallOptions)

public virtual AsyncUnaryCall<ConnectionInfo> GetConnectionInfoAsync(GetConnectionInfoRequest request, CallOptions options)

Get instance metadata used for a connection.

Parameters
Name	Description
request	GetConnectionInfoRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallConnectionInfo	The call object.

GetConnectionInfoAsync(GetConnectionInfoRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ConnectionInfo> GetConnectionInfoAsync(GetConnectionInfoRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get instance metadata used for a connection.

Parameters
Name	Description
request	GetConnectionInfoRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallConnectionInfo	The call object.

GetInstance(GetInstanceRequest, CallOptions)

public virtual Instance GetInstance(GetInstanceRequest request, CallOptions options)

Gets details of a single Instance.

Parameters
Name	Description
request	GetInstanceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Instance	The response received from the server.

GetInstance(GetInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual Instance GetInstance(GetInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single Instance.

Parameters
Name	Description
request	GetInstanceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Instance	The response received from the server.

GetInstanceAsync(GetInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Instance> GetInstanceAsync(GetInstanceRequest request, CallOptions options)

Gets details of a single Instance.

Parameters
Name	Description
request	GetInstanceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallInstance	The call object.

GetInstanceAsync(GetInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Instance> GetInstanceAsync(GetInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single Instance.

Parameters
Name	Description
request	GetInstanceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallInstance	The call object.

GetUser(GetUserRequest, CallOptions)

public virtual User GetUser(GetUserRequest request, CallOptions options)

Gets details of a single User.

Parameters
Name	Description
request	GetUserRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
User	The response received from the server.

GetUser(GetUserRequest, Metadata, DateTime?, CancellationToken)

public virtual User GetUser(GetUserRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single User.

Parameters
Name	Description
request	GetUserRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
User	The response received from the server.

GetUserAsync(GetUserRequest, CallOptions)

public virtual AsyncUnaryCall<User> GetUserAsync(GetUserRequest request, CallOptions options)

Gets details of a single User.

Parameters
Name	Description
request	GetUserRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallUser	The call object.

GetUserAsync(GetUserRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<User> GetUserAsync(GetUserRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single User.

Parameters
Name	Description
request	GetUserRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallUser	The call object.

InjectFault(InjectFaultRequest, CallOptions)

public virtual Operation InjectFault(InjectFaultRequest request, CallOptions options)

Injects fault in an instance. Imperative only.

Parameters
Name	Description
request	InjectFaultRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

InjectFault(InjectFaultRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation InjectFault(InjectFaultRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Injects fault in an instance. Imperative only.

Parameters
Name	Description
request	InjectFaultRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

InjectFaultAsync(InjectFaultRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> InjectFaultAsync(InjectFaultRequest request, CallOptions options)

Injects fault in an instance. Imperative only.

Parameters
Name	Description
request	InjectFaultRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

InjectFaultAsync(InjectFaultRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> InjectFaultAsync(InjectFaultRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Injects fault in an instance. Imperative only.

Parameters
Name	Description
request	InjectFaultRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

ListBackups(ListBackupsRequest, CallOptions)

public virtual ListBackupsResponse ListBackups(ListBackupsRequest request, CallOptions options)

Lists Backups in a given project and location.

Parameters
Name	Description
request	ListBackupsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListBackupsResponse	The response received from the server.

ListBackups(ListBackupsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListBackupsResponse ListBackups(ListBackupsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Backups in a given project and location.

Parameters
Name	Description
request	ListBackupsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListBackupsResponse	The response received from the server.

ListBackupsAsync(ListBackupsRequest, CallOptions)

public virtual AsyncUnaryCall<ListBackupsResponse> ListBackupsAsync(ListBackupsRequest request, CallOptions options)

Lists Backups in a given project and location.

Parameters
Name	Description
request	ListBackupsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListBackupsResponse	The call object.

ListBackupsAsync(ListBackupsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListBackupsResponse> ListBackupsAsync(ListBackupsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Backups in a given project and location.

Parameters
Name	Description
request	ListBackupsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListBackupsResponse	The call object.

ListClusters(ListClustersRequest, CallOptions)

public virtual ListClustersResponse ListClusters(ListClustersRequest request, CallOptions options)

Lists Clusters in a given project and location.

Parameters
Name	Description
request	ListClustersRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListClustersResponse	The response received from the server.

ListClusters(ListClustersRequest, Metadata, DateTime?, CancellationToken)

public virtual ListClustersResponse ListClusters(ListClustersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Clusters in a given project and location.

Parameters
Name	Description
request	ListClustersRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListClustersResponse	The response received from the server.

ListClustersAsync(ListClustersRequest, CallOptions)

public virtual AsyncUnaryCall<ListClustersResponse> ListClustersAsync(ListClustersRequest request, CallOptions options)

Lists Clusters in a given project and location.

Parameters
Name	Description
request	ListClustersRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListClustersResponse	The call object.

ListClustersAsync(ListClustersRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListClustersResponse> ListClustersAsync(ListClustersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Clusters in a given project and location.

Parameters
Name	Description
request	ListClustersRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListClustersResponse	The call object.

ListInstances(ListInstancesRequest, CallOptions)

public virtual ListInstancesResponse ListInstances(ListInstancesRequest request, CallOptions options)

Lists Instances in a given project and location.

Parameters
Name	Description
request	ListInstancesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListInstancesResponse	The response received from the server.

ListInstances(ListInstancesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListInstancesResponse ListInstances(ListInstancesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Instances in a given project and location.

Parameters
Name	Description
request	ListInstancesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListInstancesResponse	The response received from the server.

ListInstancesAsync(ListInstancesRequest, CallOptions)

public virtual AsyncUnaryCall<ListInstancesResponse> ListInstancesAsync(ListInstancesRequest request, CallOptions options)

Lists Instances in a given project and location.

Parameters
Name	Description
request	ListInstancesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListInstancesResponse	The call object.

ListInstancesAsync(ListInstancesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListInstancesResponse> ListInstancesAsync(ListInstancesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Instances in a given project and location.

Parameters
Name	Description
request	ListInstancesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListInstancesResponse	The call object.

ListSupportedDatabaseFlags(ListSupportedDatabaseFlagsRequest, CallOptions)

public virtual ListSupportedDatabaseFlagsResponse ListSupportedDatabaseFlags(ListSupportedDatabaseFlagsRequest request, CallOptions options)

Lists SupportedDatabaseFlags for a given project and location.

Parameters
Name	Description
request	ListSupportedDatabaseFlagsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListSupportedDatabaseFlagsResponse	The response received from the server.

ListSupportedDatabaseFlags(ListSupportedDatabaseFlagsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListSupportedDatabaseFlagsResponse ListSupportedDatabaseFlags(ListSupportedDatabaseFlagsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists SupportedDatabaseFlags for a given project and location.

Parameters
Name	Description
request	ListSupportedDatabaseFlagsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListSupportedDatabaseFlagsResponse	The response received from the server.

ListSupportedDatabaseFlagsAsync(ListSupportedDatabaseFlagsRequest, CallOptions)

public virtual AsyncUnaryCall<ListSupportedDatabaseFlagsResponse> ListSupportedDatabaseFlagsAsync(ListSupportedDatabaseFlagsRequest request, CallOptions options)

Lists SupportedDatabaseFlags for a given project and location.

Parameters
Name	Description
request	ListSupportedDatabaseFlagsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListSupportedDatabaseFlagsResponse	The call object.

ListSupportedDatabaseFlagsAsync(ListSupportedDatabaseFlagsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListSupportedDatabaseFlagsResponse> ListSupportedDatabaseFlagsAsync(ListSupportedDatabaseFlagsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists SupportedDatabaseFlags for a given project and location.

Parameters
Name	Description
request	ListSupportedDatabaseFlagsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListSupportedDatabaseFlagsResponse	The call object.

ListUsers(ListUsersRequest, CallOptions)

public virtual ListUsersResponse ListUsers(ListUsersRequest request, CallOptions options)

Lists Users in a given project and location.

Parameters
Name	Description
request	ListUsersRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListUsersResponse	The response received from the server.

ListUsers(ListUsersRequest, Metadata, DateTime?, CancellationToken)

public virtual ListUsersResponse ListUsers(ListUsersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Users in a given project and location.

Parameters
Name	Description
request	ListUsersRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListUsersResponse	The response received from the server.

ListUsersAsync(ListUsersRequest, CallOptions)

public virtual AsyncUnaryCall<ListUsersResponse> ListUsersAsync(ListUsersRequest request, CallOptions options)

Lists Users in a given project and location.

Parameters
Name	Description
request	ListUsersRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListUsersResponse	The call object.

ListUsersAsync(ListUsersRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListUsersResponse> ListUsersAsync(ListUsersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Users in a given project and location.

Parameters
Name	Description
request	ListUsersRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListUsersResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override AlloyDBAdmin.AlloyDBAdminClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
AlloyDBAdminAlloyDBAdminClient

Overrides

ClientBase<AlloyDBAdmin.AlloyDBAdminClient>.NewInstance(ClientBase.ClientBaseConfiguration)

PromoteCluster(PromoteClusterRequest, CallOptions)

public virtual Operation PromoteCluster(PromoteClusterRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

PromoteCluster(PromoteClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation PromoteCluster(PromoteClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

PromoteClusterAsync(PromoteClusterRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> PromoteClusterAsync(PromoteClusterRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

PromoteClusterAsync(PromoteClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> PromoteClusterAsync(PromoteClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

RestartInstance(RestartInstanceRequest, CallOptions)

public virtual Operation RestartInstance(RestartInstanceRequest request, CallOptions options)

Restart an Instance in a cluster. Imperative only.

Parameters
Name	Description
request	RestartInstanceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

RestartInstance(RestartInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation RestartInstance(RestartInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Restart an Instance in a cluster. Imperative only.

Parameters
Name	Description
request	RestartInstanceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

RestartInstanceAsync(RestartInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RestartInstanceAsync(RestartInstanceRequest request, CallOptions options)

Restart an Instance in a cluster. Imperative only.

Parameters
Name	Description
request	RestartInstanceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

RestartInstanceAsync(RestartInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> RestartInstanceAsync(RestartInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Restart an Instance in a cluster. Imperative only.

Parameters
Name	Description
request	RestartInstanceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

RestoreCluster(RestoreClusterRequest, CallOptions)

public virtual Operation RestoreCluster(RestoreClusterRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

RestoreCluster(RestoreClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation RestoreCluster(RestoreClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

RestoreClusterAsync(RestoreClusterRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RestoreClusterAsync(RestoreClusterRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

RestoreClusterAsync(RestoreClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> RestoreClusterAsync(RestoreClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateBackup(UpdateBackupRequest, CallOptions)

public virtual Operation UpdateBackup(UpdateBackupRequest request, CallOptions options)

Updates the parameters of a single Backup.

Parameters
Name	Description
request	UpdateBackupRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateBackup(UpdateBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateBackup(UpdateBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the parameters of a single Backup.

Parameters
Name	Description
request	UpdateBackupRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateBackupAsync(UpdateBackupRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateBackupAsync(UpdateBackupRequest request, CallOptions options)

Updates the parameters of a single Backup.

Parameters
Name	Description
request	UpdateBackupRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateBackupAsync(UpdateBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateBackupAsync(UpdateBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the parameters of a single Backup.

Parameters
Name	Description
request	UpdateBackupRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateCluster(UpdateClusterRequest, CallOptions)

public virtual Operation UpdateCluster(UpdateClusterRequest request, CallOptions options)

Updates the parameters of a single Cluster.

Parameters
Name	Description
request	UpdateClusterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateCluster(UpdateClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateCluster(UpdateClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the parameters of a single Cluster.

Parameters
Name	Description
request	UpdateClusterRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateClusterAsync(UpdateClusterRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateClusterAsync(UpdateClusterRequest request, CallOptions options)

Updates the parameters of a single Cluster.

Parameters
Name	Description
request	UpdateClusterRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateClusterAsync(UpdateClusterRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateClusterAsync(UpdateClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the parameters of a single Cluster.

Parameters
Name	Description
request	UpdateClusterRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateInstance(UpdateInstanceRequest, CallOptions)

public virtual Operation UpdateInstance(UpdateInstanceRequest request, CallOptions options)

Updates the parameters of a single Instance.

Parameters
Name	Description
request	UpdateInstanceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateInstance(UpdateInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateInstance(UpdateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the parameters of a single Instance.

Parameters
Name	Description
request	UpdateInstanceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

UpdateInstanceAsync(UpdateInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateInstanceAsync(UpdateInstanceRequest request, CallOptions options)

Updates the parameters of a single Instance.

Parameters
Name	Description
request	UpdateInstanceRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateInstanceAsync(UpdateInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateInstanceAsync(UpdateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the parameters of a single Instance.

Parameters
Name	Description
request	UpdateInstanceRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateUser(UpdateUserRequest, CallOptions)

public virtual User UpdateUser(UpdateUserRequest request, CallOptions options)

Updates the parameters of a single User.

Parameters
Name	Description
request	UpdateUserRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
User	The response received from the server.

UpdateUser(UpdateUserRequest, Metadata, DateTime?, CancellationToken)

public virtual User UpdateUser(UpdateUserRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the parameters of a single User.

Parameters
Name	Description
request	UpdateUserRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
User	The response received from the server.

UpdateUserAsync(UpdateUserRequest, CallOptions)

public virtual AsyncUnaryCall<User> UpdateUserAsync(UpdateUserRequest request, CallOptions options)

Updates the parameters of a single User.

Parameters
Name	Description
request	UpdateUserRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallUser	The call object.

UpdateUserAsync(UpdateUserRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<User> UpdateUserAsync(UpdateUserRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the parameters of a single User.

Parameters
Name	Description
request	UpdateUserRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallUser	The call object.