AlloyDB v1alpha API - Class AlloyDBAdminClientImpl (1.0.0-alpha14) 

public sealed class AlloyDBAdminClientImpl : AlloyDBAdminClient

Reference documentation and code samples for the AlloyDB v1alpha API class AlloyDBAdminClientImpl.

AlloyDBAdmin client wrapper implementation, for convenient use.

Inheritance

object > AlloyDBAdminClient > AlloyDBAdminClientImpl

Namespace

Google.Cloud.AlloyDb.V1Alpha

Assembly

Google.Cloud.AlloyDb.V1Alpha.dll

Remarks

Service describing handlers for resources

Constructors

AlloyDBAdminClientImpl(AlloyDBAdminClient, AlloyDBAdminSettings, ILogger)

public AlloyDBAdminClientImpl(AlloyDBAdmin.AlloyDBAdminClient grpcClient, AlloyDBAdminSettings settings, ILogger logger)

Constructs a client wrapper for the AlloyDBAdmin service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient AlloyDBAdminAlloyDBAdminClient

The underlying gRPC client.
settings AlloyDBAdminSettings

The base AlloyDBAdminSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

BatchCreateInstancesOperationsClient

public override OperationsClient BatchCreateInstancesOperationsClient { get; }

The long-running operations client for BatchCreateInstances.

Property Value
Type Description
OperationsClient
Overrides

CreateBackupOperationsClient

public override OperationsClient CreateBackupOperationsClient { get; }

The long-running operations client for CreateBackup.

Property Value
Type Description
OperationsClient
Overrides

CreateClusterOperationsClient

public override OperationsClient CreateClusterOperationsClient { get; }

The long-running operations client for CreateCluster.

Property Value
Type Description
OperationsClient
Overrides

CreateInstanceOperationsClient

public override OperationsClient CreateInstanceOperationsClient { get; }

The long-running operations client for CreateInstance.

Property Value
Type Description
OperationsClient
Overrides

CreateSecondaryClusterOperationsClient

public override OperationsClient CreateSecondaryClusterOperationsClient { get; }

The long-running operations client for CreateSecondaryCluster.

Property Value
Type Description
OperationsClient
Overrides

CreateSecondaryInstanceOperationsClient

public override OperationsClient CreateSecondaryInstanceOperationsClient { get; }

The long-running operations client for CreateSecondaryInstance.

Property Value
Type Description
OperationsClient
Overrides

DeleteBackupOperationsClient

public override OperationsClient DeleteBackupOperationsClient { get; }

The long-running operations client for DeleteBackup.

Property Value
Type Description
OperationsClient
Overrides

DeleteClusterOperationsClient

public override OperationsClient DeleteClusterOperationsClient { get; }

The long-running operations client for DeleteCluster.

Property Value
Type Description
OperationsClient
Overrides

DeleteInstanceOperationsClient

public override OperationsClient DeleteInstanceOperationsClient { get; }

The long-running operations client for DeleteInstance.

Property Value
Type Description
OperationsClient
Overrides

ExportClusterOperationsClient

public override OperationsClient ExportClusterOperationsClient { get; }

The long-running operations client for ExportCluster.

Property Value
Type Description
OperationsClient
Overrides

FailoverInstanceOperationsClient

public override OperationsClient FailoverInstanceOperationsClient { get; }

The long-running operations client for FailoverInstance.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override AlloyDBAdmin.AlloyDBAdminClient GrpcClient { get; }

The underlying gRPC AlloyDBAdmin client

Property Value
Type Description
AlloyDBAdminAlloyDBAdminClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient
Overrides

ImportClusterOperationsClient

public override OperationsClient ImportClusterOperationsClient { get; }

The long-running operations client for ImportCluster.

Property Value
Type Description
OperationsClient
Overrides

InjectFaultOperationsClient

public override OperationsClient InjectFaultOperationsClient { get; }

The long-running operations client for InjectFault.

Property Value
Type Description
OperationsClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

PromoteClusterOperationsClient

public override OperationsClient PromoteClusterOperationsClient { get; }

The long-running operations client for PromoteCluster.

Property Value
Type Description
OperationsClient
Overrides

RestartInstanceOperationsClient

public override OperationsClient RestartInstanceOperationsClient { get; }

The long-running operations client for RestartInstance.

Property Value
Type Description
OperationsClient
Overrides

RestoreClusterOperationsClient

public override OperationsClient RestoreClusterOperationsClient { get; }

The long-running operations client for RestoreCluster.

Property Value
Type Description
OperationsClient
Overrides

SwitchoverClusterOperationsClient

public override OperationsClient SwitchoverClusterOperationsClient { get; }

The long-running operations client for SwitchoverCluster.

Property Value
Type Description
OperationsClient
Overrides

UpdateBackupOperationsClient

public override OperationsClient UpdateBackupOperationsClient { get; }

The long-running operations client for UpdateBackup.

Property Value
Type Description
OperationsClient
Overrides

UpdateClusterOperationsClient

public override OperationsClient UpdateClusterOperationsClient { get; }

The long-running operations client for UpdateCluster.

Property Value
Type Description
OperationsClient
Overrides

UpdateInstanceOperationsClient

public override OperationsClient UpdateInstanceOperationsClient { get; }

The long-running operations client for UpdateInstance.

Property Value
Type Description
OperationsClient
Overrides

UpgradeClusterOperationsClient

public override OperationsClient UpgradeClusterOperationsClient { get; }

The long-running operations client for UpgradeCluster.

Property Value
Type Description
OperationsClient
Overrides

Methods

BatchCreateInstances(BatchCreateInstancesRequest, CallSettings)

public override Operation<BatchCreateInstancesResponse, OperationMetadata> BatchCreateInstances(BatchCreateInstancesRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationBatchCreateInstancesResponseOperationMetadata

The RPC response.
Overrides

BatchCreateInstancesAsync(BatchCreateInstancesRequest, CallSettings)

public override Task<Operation<BatchCreateInstancesResponse, OperationMetadata>> BatchCreateInstancesAsync(BatchCreateInstancesRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationBatchCreateInstancesResponseOperationMetadata

A Task containing the RPC response.
Overrides

CreateBackup(CreateBackupRequest, CallSettings)

public override Operation<Backup, OperationMetadata> CreateBackup(CreateBackupRequest request, CallSettings callSettings = null)

Creates a new Backup in a given project and location.

Parameters
Name Description
request CreateBackupRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationBackupOperationMetadata

The RPC response.
Overrides

CreateBackupAsync(CreateBackupRequest, CallSettings)

public override Task<Operation<Backup, OperationMetadata>> CreateBackupAsync(CreateBackupRequest request, CallSettings callSettings = null)

Creates a new Backup in a given project and location.

Parameters
Name Description
request CreateBackupRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationBackupOperationMetadata

A Task containing the RPC response.
Overrides

CreateCluster(CreateClusterRequest, CallSettings)

public override Operation<Cluster, OperationMetadata> CreateCluster(CreateClusterRequest request, CallSettings callSettings = null)

Creates a new Cluster in a given project and location.

Parameters
Name Description
request CreateClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationClusterOperationMetadata

The RPC response.
Overrides

CreateClusterAsync(CreateClusterRequest, CallSettings)

public override Task<Operation<Cluster, OperationMetadata>> CreateClusterAsync(CreateClusterRequest request, CallSettings callSettings = null)

Creates a new Cluster in a given project and location.

Parameters
Name Description
request CreateClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationClusterOperationMetadata

A Task containing the RPC response.
Overrides

CreateDatabase(CreateDatabaseRequest, CallSettings)

public override Database CreateDatabase(CreateDatabaseRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CreateDatabaseRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Database

The RPC response.
Overrides

CreateDatabaseAsync(CreateDatabaseRequest, CallSettings)

public override Task<Database> CreateDatabaseAsync(CreateDatabaseRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CreateDatabaseRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskDatabase

A Task containing the RPC response.
Overrides

CreateInstance(CreateInstanceRequest, CallSettings)

public override Operation<Instance, OperationMetadata> CreateInstance(CreateInstanceRequest request, CallSettings callSettings = null)

Creates a new Instance in a given project and location.

Parameters
Name Description
request CreateInstanceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.
Overrides

CreateInstanceAsync(CreateInstanceRequest, CallSettings)

public override Task<Operation<Instance, OperationMetadata>> CreateInstanceAsync(CreateInstanceRequest request, CallSettings callSettings = null)

Creates a new Instance in a given project and location.

Parameters
Name Description
request CreateInstanceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.
Overrides

CreateSecondaryCluster(CreateSecondaryClusterRequest, CallSettings)

public override Operation<Cluster, OperationMetadata> CreateSecondaryCluster(CreateSecondaryClusterRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CreateSecondaryClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationClusterOperationMetadata

The RPC response.
Overrides

CreateSecondaryClusterAsync(CreateSecondaryClusterRequest, CallSettings)

public override Task<Operation<Cluster, OperationMetadata>> CreateSecondaryClusterAsync(CreateSecondaryClusterRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CreateSecondaryClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationClusterOperationMetadata

A Task containing the RPC response.
Overrides

CreateSecondaryInstance(CreateSecondaryInstanceRequest, CallSettings)

public override Operation<Instance, OperationMetadata> CreateSecondaryInstance(CreateSecondaryInstanceRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CreateSecondaryInstanceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.
Overrides

CreateSecondaryInstanceAsync(CreateSecondaryInstanceRequest, CallSettings)

public override Task<Operation<Instance, OperationMetadata>> CreateSecondaryInstanceAsync(CreateSecondaryInstanceRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CreateSecondaryInstanceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.
Overrides

CreateUser(CreateUserRequest, CallSettings)

public override User CreateUser(CreateUserRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CreateUserRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
User

The RPC response.
Overrides

CreateUserAsync(CreateUserRequest, CallSettings)

public override Task<User> CreateUserAsync(CreateUserRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CreateUserRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskUser

A Task containing the RPC response.
Overrides

DeleteBackup(DeleteBackupRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteBackup(DeleteBackupRequest request, CallSettings callSettings = null)

Deletes a single Backup.

Parameters
Name Description
request DeleteBackupRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteBackupAsync(DeleteBackupRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteBackupAsync(DeleteBackupRequest request, CallSettings callSettings = null)

Deletes a single Backup.

Parameters
Name Description
request DeleteBackupRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

DeleteCluster(DeleteClusterRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteCluster(DeleteClusterRequest request, CallSettings callSettings = null)

Deletes a single Cluster.

Parameters
Name Description
request DeleteClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteClusterAsync(DeleteClusterRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteClusterAsync(DeleteClusterRequest request, CallSettings callSettings = null)

Deletes a single Cluster.

Parameters
Name Description
request DeleteClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

DeleteInstance(DeleteInstanceRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteInstance(DeleteInstanceRequest request, CallSettings callSettings = null)

Deletes a single Instance.

Parameters
Name Description
request DeleteInstanceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteInstanceAsync(DeleteInstanceRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteInstanceAsync(DeleteInstanceRequest request, CallSettings callSettings = null)

Deletes a single Instance.

Parameters
Name Description
request DeleteInstanceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

DeleteUser(DeleteUserRequest, CallSettings)

public override void DeleteUser(DeleteUserRequest request, CallSettings callSettings = null)

Deletes a single User.

Parameters
Name Description
request DeleteUserRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteUserAsync(DeleteUserRequest, CallSettings)

public override Task DeleteUserAsync(DeleteUserRequest request, CallSettings callSettings = null)

Deletes a single User.

Parameters
Name Description
request DeleteUserRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

ExecuteSql(ExecuteSqlRequest, CallSettings)

public override ExecuteSqlResponse ExecuteSql(ExecuteSqlRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ExecuteSqlRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ExecuteSqlResponse

The RPC response.
Overrides

ExecuteSqlAsync(ExecuteSqlRequest, CallSettings)

public override Task<ExecuteSqlResponse> ExecuteSqlAsync(ExecuteSqlRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ExecuteSqlRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskExecuteSqlResponse

A Task containing the RPC response.
Overrides

ExportCluster(ExportClusterRequest, CallSettings)

public override Operation<ExportClusterResponse, OperationMetadata> ExportCluster(ExportClusterRequest request, CallSettings callSettings = null)

Exports data from the cluster. Imperative only.

Parameters
Name Description
request ExportClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationExportClusterResponseOperationMetadata

The RPC response.
Overrides

ExportClusterAsync(ExportClusterRequest, CallSettings)

public override Task<Operation<ExportClusterResponse, OperationMetadata>> ExportClusterAsync(ExportClusterRequest request, CallSettings callSettings = null)

Exports data from the cluster. Imperative only.

Parameters
Name Description
request ExportClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationExportClusterResponseOperationMetadata

A Task containing the RPC response.
Overrides

FailoverInstance(FailoverInstanceRequest, CallSettings)

public override Operation<Instance, OperationMetadata> FailoverInstance(FailoverInstanceRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.
Overrides

FailoverInstanceAsync(FailoverInstanceRequest, CallSettings)

public override Task<Operation<Instance, OperationMetadata>> FailoverInstanceAsync(FailoverInstanceRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.
Overrides

GenerateClientCertificate(GenerateClientCertificateRequest, CallSettings)

public override GenerateClientCertificateResponse GenerateClientCertificate(GenerateClientCertificateRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
GenerateClientCertificateResponse

The RPC response.
Overrides

GenerateClientCertificateAsync(GenerateClientCertificateRequest, CallSettings)

public override Task<GenerateClientCertificateResponse> GenerateClientCertificateAsync(GenerateClientCertificateRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskGenerateClientCertificateResponse

A Task containing the RPC response.
Overrides

GetBackup(GetBackupRequest, CallSettings)

public override Backup GetBackup(GetBackupRequest request, CallSettings callSettings = null)

Gets details of a single Backup.

Parameters
Name Description
request GetBackupRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Backup

The RPC response.
Overrides

GetBackupAsync(GetBackupRequest, CallSettings)

public override Task<Backup> GetBackupAsync(GetBackupRequest request, CallSettings callSettings = null)

Gets details of a single Backup.

Parameters
Name Description
request GetBackupRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskBackup

A Task containing the RPC response.
Overrides

GetCluster(GetClusterRequest, CallSettings)

public override Cluster GetCluster(GetClusterRequest request, CallSettings callSettings = null)

Gets details of a single Cluster.

Parameters
Name Description
request GetClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Cluster

The RPC response.
Overrides

GetClusterAsync(GetClusterRequest, CallSettings)

public override Task<Cluster> GetClusterAsync(GetClusterRequest request, CallSettings callSettings = null)

Gets details of a single Cluster.

Parameters
Name Description
request GetClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskCluster

A Task containing the RPC response.
Overrides

GetConnectionInfo(GetConnectionInfoRequest, CallSettings)

public override ConnectionInfo GetConnectionInfo(GetConnectionInfoRequest request, CallSettings callSettings = null)

Get instance metadata used for a connection.

Parameters
Name Description
request GetConnectionInfoRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ConnectionInfo

The RPC response.
Overrides

GetConnectionInfoAsync(GetConnectionInfoRequest, CallSettings)

public override Task<ConnectionInfo> GetConnectionInfoAsync(GetConnectionInfoRequest request, CallSettings callSettings = null)

Get instance metadata used for a connection.

Parameters
Name Description
request GetConnectionInfoRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskConnectionInfo

A Task containing the RPC response.
Overrides

GetInstance(GetInstanceRequest, CallSettings)

public override Instance GetInstance(GetInstanceRequest request, CallSettings callSettings = null)

Gets details of a single Instance.

Parameters
Name Description
request GetInstanceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Instance

The RPC response.
Overrides

GetInstanceAsync(GetInstanceRequest, CallSettings)

public override Task<Instance> GetInstanceAsync(GetInstanceRequest request, CallSettings callSettings = null)

Gets details of a single Instance.

Parameters
Name Description
request GetInstanceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskInstance

A Task containing the RPC response.
Overrides

GetUser(GetUserRequest, CallSettings)

public override User GetUser(GetUserRequest request, CallSettings callSettings = null)

Gets details of a single User.

Parameters
Name Description
request GetUserRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
User

The RPC response.
Overrides

GetUserAsync(GetUserRequest, CallSettings)

public override Task<User> GetUserAsync(GetUserRequest request, CallSettings callSettings = null)

Gets details of a single User.

Parameters
Name Description
request GetUserRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskUser

A Task containing the RPC response.
Overrides

ImportCluster(ImportClusterRequest, CallSettings)

public override Operation<ImportClusterResponse, OperationMetadata> ImportCluster(ImportClusterRequest request, CallSettings callSettings = null)

Imports data to the cluster. Imperative only.

Parameters
Name Description
request ImportClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationImportClusterResponseOperationMetadata

The RPC response.
Overrides

ImportClusterAsync(ImportClusterRequest, CallSettings)

public override Task<Operation<ImportClusterResponse, OperationMetadata>> ImportClusterAsync(ImportClusterRequest request, CallSettings callSettings = null)

Imports data to the cluster. Imperative only.

Parameters
Name Description
request ImportClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationImportClusterResponseOperationMetadata

A Task containing the RPC response.
Overrides

InjectFault(InjectFaultRequest, CallSettings)

public override Operation<Instance, OperationMetadata> InjectFault(InjectFaultRequest request, CallSettings callSettings = null)

Injects fault in an instance. Imperative only.

Parameters
Name Description
request InjectFaultRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.
Overrides

InjectFaultAsync(InjectFaultRequest, CallSettings)

public override Task<Operation<Instance, OperationMetadata>> InjectFaultAsync(InjectFaultRequest request, CallSettings callSettings = null)

Injects fault in an instance. Imperative only.

Parameters
Name Description
request InjectFaultRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.
Overrides

ListBackups(ListBackupsRequest, CallSettings)

public override PagedEnumerable<ListBackupsResponse, Backup> ListBackups(ListBackupsRequest request, CallSettings callSettings = null)

Lists Backups in a given project and location.

Parameters
Name Description
request ListBackupsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListBackupsResponseBackup

A pageable sequence of Backup resources.
Overrides

ListBackupsAsync(ListBackupsRequest, CallSettings)

public override PagedAsyncEnumerable<ListBackupsResponse, Backup> ListBackupsAsync(ListBackupsRequest request, CallSettings callSettings = null)

Lists Backups in a given project and location.

Parameters
Name Description
request ListBackupsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListBackupsResponseBackup

A pageable asynchronous sequence of Backup resources.
Overrides

ListClusters(ListClustersRequest, CallSettings)

public override PagedEnumerable<ListClustersResponse, Cluster> ListClusters(ListClustersRequest request, CallSettings callSettings = null)

Lists Clusters in a given project and location.

Parameters
Name Description
request ListClustersRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListClustersResponseCluster

A pageable sequence of Cluster resources.
Overrides

ListClustersAsync(ListClustersRequest, CallSettings)

public override PagedAsyncEnumerable<ListClustersResponse, Cluster> ListClustersAsync(ListClustersRequest request, CallSettings callSettings = null)

Lists Clusters in a given project and location.

Parameters
Name Description
request ListClustersRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListClustersResponseCluster

A pageable asynchronous sequence of Cluster resources.
Overrides

ListDatabases(ListDatabasesRequest, CallSettings)

public override PagedEnumerable<ListDatabasesResponse, Database> ListDatabases(ListDatabasesRequest request, CallSettings callSettings = null)

Lists Databases in a given project and location.

Parameters
Name Description
request ListDatabasesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListDatabasesResponseDatabase

A pageable sequence of Database resources.
Overrides

ListDatabasesAsync(ListDatabasesRequest, CallSettings)

public override PagedAsyncEnumerable<ListDatabasesResponse, Database> ListDatabasesAsync(ListDatabasesRequest request, CallSettings callSettings = null)

Lists Databases in a given project and location.

Parameters
Name Description
request ListDatabasesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListDatabasesResponseDatabase

A pageable asynchronous sequence of Database resources.
Overrides

ListInstances(ListInstancesRequest, CallSettings)

public override PagedEnumerable<ListInstancesResponse, Instance> ListInstances(ListInstancesRequest request, CallSettings callSettings = null)

Lists Instances in a given project and location.

Parameters
Name Description
request ListInstancesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListInstancesResponseInstance

A pageable sequence of Instance resources.
Overrides

ListInstancesAsync(ListInstancesRequest, CallSettings)

public override PagedAsyncEnumerable<ListInstancesResponse, Instance> ListInstancesAsync(ListInstancesRequest request, CallSettings callSettings = null)

Lists Instances in a given project and location.

Parameters
Name Description
request ListInstancesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListInstancesResponseInstance

A pageable asynchronous sequence of Instance resources.
Overrides

ListSupportedDatabaseFlags(ListSupportedDatabaseFlagsRequest, CallSettings)

public override PagedEnumerable<ListSupportedDatabaseFlagsResponse, SupportedDatabaseFlag> ListSupportedDatabaseFlags(ListSupportedDatabaseFlagsRequest request, CallSettings callSettings = null)

Lists SupportedDatabaseFlags for a given project and location.

Parameters
Name Description
request ListSupportedDatabaseFlagsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListSupportedDatabaseFlagsResponseSupportedDatabaseFlag

A pageable sequence of SupportedDatabaseFlag resources.
Overrides

ListSupportedDatabaseFlagsAsync(ListSupportedDatabaseFlagsRequest, CallSettings)

public override PagedAsyncEnumerable<ListSupportedDatabaseFlagsResponse, SupportedDatabaseFlag> ListSupportedDatabaseFlagsAsync(ListSupportedDatabaseFlagsRequest request, CallSettings callSettings = null)

Lists SupportedDatabaseFlags for a given project and location.

Parameters
Name Description
request ListSupportedDatabaseFlagsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListSupportedDatabaseFlagsResponseSupportedDatabaseFlag

A pageable asynchronous sequence of SupportedDatabaseFlag resources.
Overrides

ListUsers(ListUsersRequest, CallSettings)

public override PagedEnumerable<ListUsersResponse, User> ListUsers(ListUsersRequest request, CallSettings callSettings = null)

Lists Users in a given project and location.

Parameters
Name Description
request ListUsersRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListUsersResponseUser

A pageable sequence of User resources.
Overrides

ListUsersAsync(ListUsersRequest, CallSettings)

public override PagedAsyncEnumerable<ListUsersResponse, User> ListUsersAsync(ListUsersRequest request, CallSettings callSettings = null)

Lists Users in a given project and location.

Parameters
Name Description
request ListUsersRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListUsersResponseUser

A pageable asynchronous sequence of User resources.
Overrides

PromoteCluster(PromoteClusterRequest, CallSettings)

public override Operation<Cluster, OperationMetadata> PromoteCluster(PromoteClusterRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationClusterOperationMetadata

The RPC response.
Overrides

PromoteClusterAsync(PromoteClusterRequest, CallSettings)

public override Task<Operation<Cluster, OperationMetadata>> PromoteClusterAsync(PromoteClusterRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationClusterOperationMetadata

A Task containing the RPC response.
Overrides

RestartInstance(RestartInstanceRequest, CallSettings)

public override Operation<Instance, OperationMetadata> RestartInstance(RestartInstanceRequest request, CallSettings callSettings = null)

Restart an Instance in a cluster. Imperative only.

Parameters
Name Description
request RestartInstanceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.
Overrides

RestartInstanceAsync(RestartInstanceRequest, CallSettings)

public override Task<Operation<Instance, OperationMetadata>> RestartInstanceAsync(RestartInstanceRequest request, CallSettings callSettings = null)

Restart an Instance in a cluster. Imperative only.

Parameters
Name Description
request RestartInstanceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.
Overrides

RestoreCluster(RestoreClusterRequest, CallSettings)

public override Operation<Cluster, OperationMetadata> RestoreCluster(RestoreClusterRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationClusterOperationMetadata

The RPC response.
Overrides

RestoreClusterAsync(RestoreClusterRequest, CallSettings)

public override Task<Operation<Cluster, OperationMetadata>> RestoreClusterAsync(RestoreClusterRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationClusterOperationMetadata

A Task containing the RPC response.
Overrides

SwitchoverCluster(SwitchoverClusterRequest, CallSettings)

public override Operation<Cluster, OperationMetadata> SwitchoverCluster(SwitchoverClusterRequest request, CallSettings callSettings = null)

Switches the roles of PRIMARY and SECONDARY clusters without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up the original PRIMARY cluster to replicate from this newly promoted cluster.

Parameters
Name Description
request SwitchoverClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationClusterOperationMetadata

The RPC response.
Overrides

SwitchoverClusterAsync(SwitchoverClusterRequest, CallSettings)

public override Task<Operation<Cluster, OperationMetadata>> SwitchoverClusterAsync(SwitchoverClusterRequest request, CallSettings callSettings = null)

Switches the roles of PRIMARY and SECONDARY clusters without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up the original PRIMARY cluster to replicate from this newly promoted cluster.

Parameters
Name Description
request SwitchoverClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationClusterOperationMetadata

A Task containing the RPC response.
Overrides

UpdateBackup(UpdateBackupRequest, CallSettings)

public override Operation<Backup, OperationMetadata> UpdateBackup(UpdateBackupRequest request, CallSettings callSettings = null)

Updates the parameters of a single Backup.

Parameters
Name Description
request UpdateBackupRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationBackupOperationMetadata

The RPC response.
Overrides

UpdateBackupAsync(UpdateBackupRequest, CallSettings)

public override Task<Operation<Backup, OperationMetadata>> UpdateBackupAsync(UpdateBackupRequest request, CallSettings callSettings = null)

Updates the parameters of a single Backup.

Parameters
Name Description
request UpdateBackupRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationBackupOperationMetadata

A Task containing the RPC response.
Overrides

UpdateCluster(UpdateClusterRequest, CallSettings)

public override Operation<Cluster, OperationMetadata> UpdateCluster(UpdateClusterRequest request, CallSettings callSettings = null)

Updates the parameters of a single Cluster.

Parameters
Name Description
request UpdateClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationClusterOperationMetadata

The RPC response.
Overrides

UpdateClusterAsync(UpdateClusterRequest, CallSettings)

public override Task<Operation<Cluster, OperationMetadata>> UpdateClusterAsync(UpdateClusterRequest request, CallSettings callSettings = null)

Updates the parameters of a single Cluster.

Parameters
Name Description
request UpdateClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationClusterOperationMetadata

A Task containing the RPC response.
Overrides

UpdateInstance(UpdateInstanceRequest, CallSettings)

public override Operation<Instance, OperationMetadata> UpdateInstance(UpdateInstanceRequest request, CallSettings callSettings = null)

Updates the parameters of a single Instance.

Parameters
Name Description
request UpdateInstanceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationInstanceOperationMetadata

The RPC response.
Overrides

UpdateInstanceAsync(UpdateInstanceRequest, CallSettings)

public override Task<Operation<Instance, OperationMetadata>> UpdateInstanceAsync(UpdateInstanceRequest request, CallSettings callSettings = null)

Updates the parameters of a single Instance.

Parameters
Name Description
request UpdateInstanceRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationInstanceOperationMetadata

A Task containing the RPC response.
Overrides

UpdateUser(UpdateUserRequest, CallSettings)

public override User UpdateUser(UpdateUserRequest request, CallSettings callSettings = null)

Updates the parameters of a single User.

Parameters
Name Description
request UpdateUserRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
User

The RPC response.
Overrides

UpdateUserAsync(UpdateUserRequest, CallSettings)

public override Task<User> UpdateUserAsync(UpdateUserRequest request, CallSettings callSettings = null)

Updates the parameters of a single User.

Parameters
Name Description
request UpdateUserRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskUser

A Task containing the RPC response.
Overrides

UpgradeCluster(UpgradeClusterRequest, CallSettings)

public override Operation<UpgradeClusterResponse, OperationMetadata> UpgradeCluster(UpgradeClusterRequest request, CallSettings callSettings = null)

Upgrades a single Cluster. Imperative only.

Parameters
Name Description
request UpgradeClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationUpgradeClusterResponseOperationMetadata

The RPC response.
Overrides

UpgradeClusterAsync(UpgradeClusterRequest, CallSettings)

public override Task<Operation<UpgradeClusterResponse, OperationMetadata>> UpgradeClusterAsync(UpgradeClusterRequest request, CallSettings callSettings = null)

Upgrades a single Cluster. Imperative only.

Parameters
Name Description
request UpgradeClusterRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationUpgradeClusterResponseOperationMetadata

A Task containing the RPC response.
Overrides