AlloyDB v1 API - Class AlloyDBAdminClientImpl (1.4.0)

Version 1.4.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 sealed class AlloyDBAdminClientImpl : AlloyDBAdminClient

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

AlloyDBAdmin client wrapper implementation, for convenient use.

Inheritance

object > AlloyDBAdminClient > AlloyDBAdminClientImpl

Inherited Members

AlloyDBAdminClient.DefaultEndpoint

AlloyDBAdminClient.DefaultScopes

AlloyDBAdminClient.ServiceMetadata

AlloyDBAdminClient.CreateAsync(CancellationToken)

AlloyDBAdminClient.Create()

AlloyDBAdminClient.ShutdownDefaultChannelsAsync()

AlloyDBAdminClient.ListClusters(string, string, int?, CallSettings)

AlloyDBAdminClient.ListClustersAsync(string, string, int?, CallSettings)

AlloyDBAdminClient.ListClusters(LocationName, string, int?, CallSettings)

AlloyDBAdminClient.ListClustersAsync(LocationName, string, int?, CallSettings)

AlloyDBAdminClient.GetClusterAsync(GetClusterRequest, CancellationToken)

AlloyDBAdminClient.GetCluster(string, CallSettings)

AlloyDBAdminClient.GetClusterAsync(string, CallSettings)

AlloyDBAdminClient.GetClusterAsync(string, CancellationToken)

AlloyDBAdminClient.GetCluster(ClusterName, CallSettings)

AlloyDBAdminClient.GetClusterAsync(ClusterName, CallSettings)

AlloyDBAdminClient.GetClusterAsync(ClusterName, CancellationToken)

AlloyDBAdminClient.CreateClusterAsync(CreateClusterRequest, CancellationToken)

AlloyDBAdminClient.PollOnceCreateCluster(string, CallSettings)

AlloyDBAdminClient.PollOnceCreateClusterAsync(string, CallSettings)

AlloyDBAdminClient.CreateCluster(string, Cluster, string, CallSettings)

AlloyDBAdminClient.CreateClusterAsync(string, Cluster, string, CallSettings)

AlloyDBAdminClient.CreateClusterAsync(string, Cluster, string, CancellationToken)

AlloyDBAdminClient.CreateCluster(LocationName, Cluster, string, CallSettings)

AlloyDBAdminClient.CreateClusterAsync(LocationName, Cluster, string, CallSettings)

AlloyDBAdminClient.CreateClusterAsync(LocationName, Cluster, string, CancellationToken)

AlloyDBAdminClient.UpdateClusterAsync(UpdateClusterRequest, CancellationToken)

AlloyDBAdminClient.PollOnceUpdateCluster(string, CallSettings)

AlloyDBAdminClient.PollOnceUpdateClusterAsync(string, CallSettings)

AlloyDBAdminClient.UpdateCluster(Cluster, FieldMask, CallSettings)

AlloyDBAdminClient.UpdateClusterAsync(Cluster, FieldMask, CallSettings)

AlloyDBAdminClient.UpdateClusterAsync(Cluster, FieldMask, CancellationToken)

AlloyDBAdminClient.DeleteClusterAsync(DeleteClusterRequest, CancellationToken)

AlloyDBAdminClient.PollOnceDeleteCluster(string, CallSettings)

AlloyDBAdminClient.PollOnceDeleteClusterAsync(string, CallSettings)

AlloyDBAdminClient.DeleteCluster(string, CallSettings)

AlloyDBAdminClient.DeleteClusterAsync(string, CallSettings)

AlloyDBAdminClient.DeleteClusterAsync(string, CancellationToken)

AlloyDBAdminClient.DeleteCluster(ClusterName, CallSettings)

AlloyDBAdminClient.DeleteClusterAsync(ClusterName, CallSettings)

AlloyDBAdminClient.DeleteClusterAsync(ClusterName, CancellationToken)

AlloyDBAdminClient.PromoteClusterAsync(PromoteClusterRequest, CancellationToken)

AlloyDBAdminClient.PollOncePromoteCluster(string, CallSettings)

AlloyDBAdminClient.PollOncePromoteClusterAsync(string, CallSettings)

AlloyDBAdminClient.PromoteCluster(string, CallSettings)

AlloyDBAdminClient.PromoteClusterAsync(string, CallSettings)

AlloyDBAdminClient.PromoteClusterAsync(string, CancellationToken)

AlloyDBAdminClient.PromoteCluster(ClusterName, CallSettings)

AlloyDBAdminClient.PromoteClusterAsync(ClusterName, CallSettings)

AlloyDBAdminClient.PromoteClusterAsync(ClusterName, CancellationToken)

AlloyDBAdminClient.RestoreClusterAsync(RestoreClusterRequest, CancellationToken)

AlloyDBAdminClient.PollOnceRestoreCluster(string, CallSettings)

AlloyDBAdminClient.PollOnceRestoreClusterAsync(string, CallSettings)

AlloyDBAdminClient.CreateSecondaryClusterAsync(CreateSecondaryClusterRequest, CancellationToken)

AlloyDBAdminClient.PollOnceCreateSecondaryCluster(string, CallSettings)

AlloyDBAdminClient.PollOnceCreateSecondaryClusterAsync(string, CallSettings)

AlloyDBAdminClient.CreateSecondaryCluster(string, Cluster, string, CallSettings)

AlloyDBAdminClient.CreateSecondaryClusterAsync(string, Cluster, string, CallSettings)

AlloyDBAdminClient.CreateSecondaryClusterAsync(string, Cluster, string, CancellationToken)

AlloyDBAdminClient.CreateSecondaryCluster(LocationName, Cluster, string, CallSettings)

AlloyDBAdminClient.CreateSecondaryClusterAsync(LocationName, Cluster, string, CallSettings)

AlloyDBAdminClient.CreateSecondaryClusterAsync(LocationName, Cluster, string, CancellationToken)

AlloyDBAdminClient.ListInstances(string, string, int?, CallSettings)

AlloyDBAdminClient.ListInstancesAsync(string, string, int?, CallSettings)

AlloyDBAdminClient.ListInstances(ClusterName, string, int?, CallSettings)

AlloyDBAdminClient.ListInstancesAsync(ClusterName, string, int?, CallSettings)

AlloyDBAdminClient.GetInstanceAsync(GetInstanceRequest, CancellationToken)

AlloyDBAdminClient.GetInstance(string, CallSettings)

AlloyDBAdminClient.GetInstanceAsync(string, CallSettings)

AlloyDBAdminClient.GetInstanceAsync(string, CancellationToken)

AlloyDBAdminClient.GetInstance(InstanceName, CallSettings)

AlloyDBAdminClient.GetInstanceAsync(InstanceName, CallSettings)

AlloyDBAdminClient.GetInstanceAsync(InstanceName, CancellationToken)

AlloyDBAdminClient.CreateInstanceAsync(CreateInstanceRequest, CancellationToken)

AlloyDBAdminClient.PollOnceCreateInstance(string, CallSettings)

AlloyDBAdminClient.PollOnceCreateInstanceAsync(string, CallSettings)

AlloyDBAdminClient.CreateInstance(string, Instance, string, CallSettings)

AlloyDBAdminClient.CreateInstanceAsync(string, Instance, string, CallSettings)

AlloyDBAdminClient.CreateInstanceAsync(string, Instance, string, CancellationToken)

AlloyDBAdminClient.CreateInstance(ClusterName, Instance, string, CallSettings)

AlloyDBAdminClient.CreateInstanceAsync(ClusterName, Instance, string, CallSettings)

AlloyDBAdminClient.CreateInstanceAsync(ClusterName, Instance, string, CancellationToken)

AlloyDBAdminClient.CreateSecondaryInstanceAsync(CreateSecondaryInstanceRequest, CancellationToken)

AlloyDBAdminClient.PollOnceCreateSecondaryInstance(string, CallSettings)

AlloyDBAdminClient.PollOnceCreateSecondaryInstanceAsync(string, CallSettings)

AlloyDBAdminClient.CreateSecondaryInstance(string, Instance, string, CallSettings)

AlloyDBAdminClient.CreateSecondaryInstanceAsync(string, Instance, string, CallSettings)

AlloyDBAdminClient.CreateSecondaryInstanceAsync(string, Instance, string, CancellationToken)

AlloyDBAdminClient.CreateSecondaryInstance(ClusterName, Instance, string, CallSettings)

AlloyDBAdminClient.CreateSecondaryInstanceAsync(ClusterName, Instance, string, CallSettings)

AlloyDBAdminClient.CreateSecondaryInstanceAsync(ClusterName, Instance, string, CancellationToken)

AlloyDBAdminClient.BatchCreateInstancesAsync(BatchCreateInstancesRequest, CancellationToken)

AlloyDBAdminClient.PollOnceBatchCreateInstances(string, CallSettings)

AlloyDBAdminClient.PollOnceBatchCreateInstancesAsync(string, CallSettings)

AlloyDBAdminClient.UpdateInstanceAsync(UpdateInstanceRequest, CancellationToken)

AlloyDBAdminClient.PollOnceUpdateInstance(string, CallSettings)

AlloyDBAdminClient.PollOnceUpdateInstanceAsync(string, CallSettings)

AlloyDBAdminClient.UpdateInstance(Instance, FieldMask, CallSettings)

AlloyDBAdminClient.UpdateInstanceAsync(Instance, FieldMask, CallSettings)

AlloyDBAdminClient.UpdateInstanceAsync(Instance, FieldMask, CancellationToken)

AlloyDBAdminClient.DeleteInstanceAsync(DeleteInstanceRequest, CancellationToken)

AlloyDBAdminClient.PollOnceDeleteInstance(string, CallSettings)

AlloyDBAdminClient.PollOnceDeleteInstanceAsync(string, CallSettings)

AlloyDBAdminClient.DeleteInstance(string, CallSettings)

AlloyDBAdminClient.DeleteInstanceAsync(string, CallSettings)

AlloyDBAdminClient.DeleteInstanceAsync(string, CancellationToken)

AlloyDBAdminClient.DeleteInstance(InstanceName, CallSettings)

AlloyDBAdminClient.DeleteInstanceAsync(InstanceName, CallSettings)

AlloyDBAdminClient.DeleteInstanceAsync(InstanceName, CancellationToken)

AlloyDBAdminClient.FailoverInstanceAsync(FailoverInstanceRequest, CancellationToken)

AlloyDBAdminClient.PollOnceFailoverInstance(string, CallSettings)

AlloyDBAdminClient.PollOnceFailoverInstanceAsync(string, CallSettings)

AlloyDBAdminClient.FailoverInstance(string, CallSettings)

AlloyDBAdminClient.FailoverInstanceAsync(string, CallSettings)

AlloyDBAdminClient.FailoverInstanceAsync(string, CancellationToken)

AlloyDBAdminClient.FailoverInstance(InstanceName, CallSettings)

AlloyDBAdminClient.FailoverInstanceAsync(InstanceName, CallSettings)

AlloyDBAdminClient.FailoverInstanceAsync(InstanceName, CancellationToken)

AlloyDBAdminClient.InjectFaultAsync(InjectFaultRequest, CancellationToken)

AlloyDBAdminClient.PollOnceInjectFault(string, CallSettings)

AlloyDBAdminClient.PollOnceInjectFaultAsync(string, CallSettings)

AlloyDBAdminClient.InjectFault(InjectFaultRequest.Types.FaultType, string, CallSettings)

AlloyDBAdminClient.InjectFaultAsync(InjectFaultRequest.Types.FaultType, string, CallSettings)

AlloyDBAdminClient.InjectFaultAsync(InjectFaultRequest.Types.FaultType, string, CancellationToken)

AlloyDBAdminClient.InjectFault(InjectFaultRequest.Types.FaultType, InstanceName, CallSettings)

AlloyDBAdminClient.InjectFaultAsync(InjectFaultRequest.Types.FaultType, InstanceName, CallSettings)

AlloyDBAdminClient.InjectFaultAsync(InjectFaultRequest.Types.FaultType, InstanceName, CancellationToken)

AlloyDBAdminClient.RestartInstanceAsync(RestartInstanceRequest, CancellationToken)

AlloyDBAdminClient.PollOnceRestartInstance(string, CallSettings)

AlloyDBAdminClient.PollOnceRestartInstanceAsync(string, CallSettings)

AlloyDBAdminClient.RestartInstance(string, CallSettings)

AlloyDBAdminClient.RestartInstanceAsync(string, CallSettings)

AlloyDBAdminClient.RestartInstanceAsync(string, CancellationToken)

AlloyDBAdminClient.RestartInstance(InstanceName, CallSettings)

AlloyDBAdminClient.RestartInstanceAsync(InstanceName, CallSettings)

AlloyDBAdminClient.RestartInstanceAsync(InstanceName, CancellationToken)

AlloyDBAdminClient.ListBackups(string, string, int?, CallSettings)

AlloyDBAdminClient.ListBackupsAsync(string, string, int?, CallSettings)

AlloyDBAdminClient.ListBackups(LocationName, string, int?, CallSettings)

AlloyDBAdminClient.ListBackupsAsync(LocationName, string, int?, CallSettings)

AlloyDBAdminClient.GetBackupAsync(GetBackupRequest, CancellationToken)

AlloyDBAdminClient.GetBackup(string, CallSettings)

AlloyDBAdminClient.GetBackupAsync(string, CallSettings)

AlloyDBAdminClient.GetBackupAsync(string, CancellationToken)

AlloyDBAdminClient.GetBackup(BackupName, CallSettings)

AlloyDBAdminClient.GetBackupAsync(BackupName, CallSettings)

AlloyDBAdminClient.GetBackupAsync(BackupName, CancellationToken)

AlloyDBAdminClient.CreateBackupAsync(CreateBackupRequest, CancellationToken)

AlloyDBAdminClient.PollOnceCreateBackup(string, CallSettings)

AlloyDBAdminClient.PollOnceCreateBackupAsync(string, CallSettings)

AlloyDBAdminClient.CreateBackup(string, Backup, string, CallSettings)

AlloyDBAdminClient.CreateBackupAsync(string, Backup, string, CallSettings)

AlloyDBAdminClient.CreateBackupAsync(string, Backup, string, CancellationToken)

AlloyDBAdminClient.CreateBackup(LocationName, Backup, string, CallSettings)

AlloyDBAdminClient.CreateBackupAsync(LocationName, Backup, string, CallSettings)

AlloyDBAdminClient.CreateBackupAsync(LocationName, Backup, string, CancellationToken)

AlloyDBAdminClient.UpdateBackupAsync(UpdateBackupRequest, CancellationToken)

AlloyDBAdminClient.PollOnceUpdateBackup(string, CallSettings)

AlloyDBAdminClient.PollOnceUpdateBackupAsync(string, CallSettings)

AlloyDBAdminClient.UpdateBackup(Backup, FieldMask, CallSettings)

AlloyDBAdminClient.UpdateBackupAsync(Backup, FieldMask, CallSettings)

AlloyDBAdminClient.UpdateBackupAsync(Backup, FieldMask, CancellationToken)

AlloyDBAdminClient.DeleteBackupAsync(DeleteBackupRequest, CancellationToken)

AlloyDBAdminClient.PollOnceDeleteBackup(string, CallSettings)

AlloyDBAdminClient.PollOnceDeleteBackupAsync(string, CallSettings)

AlloyDBAdminClient.DeleteBackup(string, CallSettings)

AlloyDBAdminClient.DeleteBackupAsync(string, CallSettings)

AlloyDBAdminClient.DeleteBackupAsync(string, CancellationToken)

AlloyDBAdminClient.DeleteBackup(BackupName, CallSettings)

AlloyDBAdminClient.DeleteBackupAsync(BackupName, CallSettings)

AlloyDBAdminClient.DeleteBackupAsync(BackupName, CancellationToken)

AlloyDBAdminClient.ListSupportedDatabaseFlags(string, string, int?, CallSettings)

AlloyDBAdminClient.ListSupportedDatabaseFlagsAsync(string, string, int?, CallSettings)

AlloyDBAdminClient.ListSupportedDatabaseFlags(LocationName, string, int?, CallSettings)

AlloyDBAdminClient.ListSupportedDatabaseFlagsAsync(LocationName, string, int?, CallSettings)

AlloyDBAdminClient.GenerateClientCertificateAsync(GenerateClientCertificateRequest, CancellationToken)

AlloyDBAdminClient.GenerateClientCertificate(string, CallSettings)

AlloyDBAdminClient.GenerateClientCertificateAsync(string, CallSettings)

AlloyDBAdminClient.GenerateClientCertificateAsync(string, CancellationToken)

AlloyDBAdminClient.GenerateClientCertificate(ClusterName, CallSettings)

AlloyDBAdminClient.GenerateClientCertificateAsync(ClusterName, CallSettings)

AlloyDBAdminClient.GenerateClientCertificateAsync(ClusterName, CancellationToken)

AlloyDBAdminClient.GetConnectionInfoAsync(GetConnectionInfoRequest, CancellationToken)

AlloyDBAdminClient.GetConnectionInfo(string, CallSettings)

AlloyDBAdminClient.GetConnectionInfoAsync(string, CallSettings)

AlloyDBAdminClient.GetConnectionInfoAsync(string, CancellationToken)

AlloyDBAdminClient.GetConnectionInfo(InstanceName, CallSettings)

AlloyDBAdminClient.GetConnectionInfoAsync(InstanceName, CallSettings)

AlloyDBAdminClient.GetConnectionInfoAsync(InstanceName, CancellationToken)

AlloyDBAdminClient.ListUsers(string, string, int?, CallSettings)

AlloyDBAdminClient.ListUsersAsync(string, string, int?, CallSettings)

AlloyDBAdminClient.ListUsers(ClusterName, string, int?, CallSettings)

AlloyDBAdminClient.ListUsersAsync(ClusterName, string, int?, CallSettings)

AlloyDBAdminClient.GetUserAsync(GetUserRequest, CancellationToken)

AlloyDBAdminClient.GetUser(string, CallSettings)

AlloyDBAdminClient.GetUserAsync(string, CallSettings)

AlloyDBAdminClient.GetUserAsync(string, CancellationToken)

AlloyDBAdminClient.GetUser(UserName, CallSettings)

AlloyDBAdminClient.GetUserAsync(UserName, CallSettings)

AlloyDBAdminClient.GetUserAsync(UserName, CancellationToken)

AlloyDBAdminClient.CreateUserAsync(CreateUserRequest, CancellationToken)

AlloyDBAdminClient.CreateUser(string, User, string, CallSettings)

AlloyDBAdminClient.CreateUserAsync(string, User, string, CallSettings)

AlloyDBAdminClient.CreateUserAsync(string, User, string, CancellationToken)

AlloyDBAdminClient.CreateUser(ClusterName, User, string, CallSettings)

AlloyDBAdminClient.CreateUserAsync(ClusterName, User, string, CallSettings)

AlloyDBAdminClient.CreateUserAsync(ClusterName, User, string, CancellationToken)

AlloyDBAdminClient.UpdateUserAsync(UpdateUserRequest, CancellationToken)

AlloyDBAdminClient.UpdateUser(User, FieldMask, CallSettings)

AlloyDBAdminClient.UpdateUserAsync(User, FieldMask, CallSettings)

AlloyDBAdminClient.UpdateUserAsync(User, FieldMask, CancellationToken)

AlloyDBAdminClient.DeleteUserAsync(DeleteUserRequest, CancellationToken)

AlloyDBAdminClient.DeleteUser(string, CallSettings)

AlloyDBAdminClient.DeleteUserAsync(string, CallSettings)

AlloyDBAdminClient.DeleteUserAsync(string, CancellationToken)

AlloyDBAdminClient.DeleteUser(UserName, CallSettings)

AlloyDBAdminClient.DeleteUserAsync(UserName, CallSettings)

AlloyDBAdminClient.DeleteUserAsync(UserName, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AlloyDb.V1

Assembly

Google.Cloud.AlloyDb.V1.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

AlloyDBAdminClient.BatchCreateInstancesOperationsClient

CreateBackupOperationsClient

public override OperationsClient CreateBackupOperationsClient { get; }

The long-running operations client for CreateBackup.

Property Value
Type	Description
OperationsClient

Overrides

AlloyDBAdminClient.CreateBackupOperationsClient

CreateClusterOperationsClient

public override OperationsClient CreateClusterOperationsClient { get; }

The long-running operations client for CreateCluster.

Property Value
Type	Description
OperationsClient

Overrides

AlloyDBAdminClient.CreateClusterOperationsClient

CreateInstanceOperationsClient

public override OperationsClient CreateInstanceOperationsClient { get; }

The long-running operations client for CreateInstance.

Property Value
Type	Description
OperationsClient

Overrides

AlloyDBAdminClient.CreateInstanceOperationsClient

CreateSecondaryClusterOperationsClient

public override OperationsClient CreateSecondaryClusterOperationsClient { get; }

The long-running operations client for CreateSecondaryCluster.

Property Value
Type	Description
OperationsClient

Overrides

AlloyDBAdminClient.CreateSecondaryClusterOperationsClient

CreateSecondaryInstanceOperationsClient

public override OperationsClient CreateSecondaryInstanceOperationsClient { get; }

The long-running operations client for CreateSecondaryInstance.

Property Value
Type	Description
OperationsClient

Overrides

AlloyDBAdminClient.CreateSecondaryInstanceOperationsClient

DeleteBackupOperationsClient

public override OperationsClient DeleteBackupOperationsClient { get; }

The long-running operations client for DeleteBackup.

Property Value
Type	Description
OperationsClient

Overrides

AlloyDBAdminClient.DeleteBackupOperationsClient

DeleteClusterOperationsClient

public override OperationsClient DeleteClusterOperationsClient { get; }

The long-running operations client for DeleteCluster.

Property Value
Type	Description
OperationsClient

Overrides

AlloyDBAdminClient.DeleteClusterOperationsClient

DeleteInstanceOperationsClient

public override OperationsClient DeleteInstanceOperationsClient { get; }

The long-running operations client for DeleteInstance.

Property Value
Type	Description
OperationsClient

Overrides

AlloyDBAdminClient.DeleteInstanceOperationsClient

FailoverInstanceOperationsClient

public override OperationsClient FailoverInstanceOperationsClient { get; }

The long-running operations client for FailoverInstance.

Property Value
Type	Description
OperationsClient

Overrides

AlloyDBAdminClient.FailoverInstanceOperationsClient

GrpcClient

public override AlloyDBAdmin.AlloyDBAdminClient GrpcClient { get; }

The underlying gRPC AlloyDBAdmin client

Property Value
Type	Description
AlloyDBAdminAlloyDBAdminClient

Overrides

AlloyDBAdminClient.GrpcClient

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type	Description
IAMPolicyClient

Overrides

AlloyDBAdminClient.IAMPolicyClient

InjectFaultOperationsClient

public override OperationsClient InjectFaultOperationsClient { get; }

The long-running operations client for InjectFault.

Property Value
Type	Description
OperationsClient

Overrides

AlloyDBAdminClient.InjectFaultOperationsClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

Overrides

AlloyDBAdminClient.LocationsClient

PromoteClusterOperationsClient

public override OperationsClient PromoteClusterOperationsClient { get; }

The long-running operations client for PromoteCluster.

Property Value
Type	Description
OperationsClient

Overrides

AlloyDBAdminClient.PromoteClusterOperationsClient

RestartInstanceOperationsClient

public override OperationsClient RestartInstanceOperationsClient { get; }

The long-running operations client for RestartInstance.

Property Value
Type	Description
OperationsClient

Overrides

AlloyDBAdminClient.RestartInstanceOperationsClient

RestoreClusterOperationsClient

public override OperationsClient RestoreClusterOperationsClient { get; }

The long-running operations client for RestoreCluster.

Property Value
Type	Description
OperationsClient

Overrides

AlloyDBAdminClient.RestoreClusterOperationsClient

UpdateBackupOperationsClient

public override OperationsClient UpdateBackupOperationsClient { get; }

The long-running operations client for UpdateBackup.

Property Value
Type	Description
OperationsClient

Overrides

AlloyDBAdminClient.UpdateBackupOperationsClient

UpdateClusterOperationsClient

public override OperationsClient UpdateClusterOperationsClient { get; }

The long-running operations client for UpdateCluster.

Property Value
Type	Description
OperationsClient

Overrides

AlloyDBAdminClient.UpdateClusterOperationsClient

UpdateInstanceOperationsClient

public override OperationsClient UpdateInstanceOperationsClient { get; }

The long-running operations client for UpdateInstance.

Property Value
Type	Description
OperationsClient

Overrides

AlloyDBAdminClient.UpdateInstanceOperationsClient

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

AlloyDBAdminClient.BatchCreateInstances(BatchCreateInstancesRequest, CallSettings)

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

AlloyDBAdminClient.BatchCreateInstancesAsync(BatchCreateInstancesRequest, CallSettings)

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

AlloyDBAdminClient.CreateBackup(CreateBackupRequest, CallSettings)

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

AlloyDBAdminClient.CreateBackupAsync(CreateBackupRequest, CallSettings)

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

AlloyDBAdminClient.CreateCluster(CreateClusterRequest, CallSettings)

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

AlloyDBAdminClient.CreateClusterAsync(CreateClusterRequest, CallSettings)

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

AlloyDBAdminClient.CreateInstance(CreateInstanceRequest, CallSettings)

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

AlloyDBAdminClient.CreateInstanceAsync(CreateInstanceRequest, CallSettings)

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

AlloyDBAdminClient.CreateSecondaryCluster(CreateSecondaryClusterRequest, CallSettings)

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

AlloyDBAdminClient.CreateSecondaryClusterAsync(CreateSecondaryClusterRequest, CallSettings)

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

AlloyDBAdminClient.CreateSecondaryInstance(CreateSecondaryInstanceRequest, CallSettings)

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

AlloyDBAdminClient.CreateSecondaryInstanceAsync(CreateSecondaryInstanceRequest, CallSettings)

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

AlloyDBAdminClient.CreateUser(CreateUserRequest, CallSettings)

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

AlloyDBAdminClient.CreateUserAsync(CreateUserRequest, CallSettings)

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

AlloyDBAdminClient.DeleteBackup(DeleteBackupRequest, CallSettings)

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

AlloyDBAdminClient.DeleteBackupAsync(DeleteBackupRequest, CallSettings)

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

AlloyDBAdminClient.DeleteCluster(DeleteClusterRequest, CallSettings)

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

AlloyDBAdminClient.DeleteClusterAsync(DeleteClusterRequest, CallSettings)

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

AlloyDBAdminClient.DeleteInstance(DeleteInstanceRequest, CallSettings)

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

AlloyDBAdminClient.DeleteInstanceAsync(DeleteInstanceRequest, CallSettings)

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

AlloyDBAdminClient.DeleteUser(DeleteUserRequest, CallSettings)

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

AlloyDBAdminClient.DeleteUserAsync(DeleteUserRequest, CallSettings)

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

AlloyDBAdminClient.FailoverInstance(FailoverInstanceRequest, CallSettings)

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

AlloyDBAdminClient.FailoverInstanceAsync(FailoverInstanceRequest, CallSettings)

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

AlloyDBAdminClient.GenerateClientCertificate(GenerateClientCertificateRequest, CallSettings)

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

AlloyDBAdminClient.GenerateClientCertificateAsync(GenerateClientCertificateRequest, CallSettings)

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

AlloyDBAdminClient.GetBackup(GetBackupRequest, CallSettings)

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

AlloyDBAdminClient.GetBackupAsync(GetBackupRequest, CallSettings)

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

AlloyDBAdminClient.GetCluster(GetClusterRequest, CallSettings)

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

AlloyDBAdminClient.GetClusterAsync(GetClusterRequest, CallSettings)

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

AlloyDBAdminClient.GetConnectionInfo(GetConnectionInfoRequest, CallSettings)

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

AlloyDBAdminClient.GetConnectionInfoAsync(GetConnectionInfoRequest, CallSettings)

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

AlloyDBAdminClient.GetInstance(GetInstanceRequest, CallSettings)

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

AlloyDBAdminClient.GetInstanceAsync(GetInstanceRequest, CallSettings)

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

AlloyDBAdminClient.GetUser(GetUserRequest, CallSettings)

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

AlloyDBAdminClient.GetUserAsync(GetUserRequest, CallSettings)

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

AlloyDBAdminClient.InjectFault(InjectFaultRequest, CallSettings)

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

AlloyDBAdminClient.InjectFaultAsync(InjectFaultRequest, CallSettings)

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

AlloyDBAdminClient.ListBackups(ListBackupsRequest, CallSettings)

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

AlloyDBAdminClient.ListBackupsAsync(ListBackupsRequest, CallSettings)

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

AlloyDBAdminClient.ListClusters(ListClustersRequest, CallSettings)

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

AlloyDBAdminClient.ListClustersAsync(ListClustersRequest, CallSettings)

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

AlloyDBAdminClient.ListInstances(ListInstancesRequest, CallSettings)

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

AlloyDBAdminClient.ListInstancesAsync(ListInstancesRequest, CallSettings)

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

AlloyDBAdminClient.ListSupportedDatabaseFlags(ListSupportedDatabaseFlagsRequest, CallSettings)

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

AlloyDBAdminClient.ListSupportedDatabaseFlagsAsync(ListSupportedDatabaseFlagsRequest, CallSettings)

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

AlloyDBAdminClient.ListUsers(ListUsersRequest, CallSettings)

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

AlloyDBAdminClient.ListUsersAsync(ListUsersRequest, CallSettings)

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

AlloyDBAdminClient.PromoteCluster(PromoteClusterRequest, CallSettings)

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

AlloyDBAdminClient.PromoteClusterAsync(PromoteClusterRequest, CallSettings)

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

AlloyDBAdminClient.RestartInstance(RestartInstanceRequest, CallSettings)

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

AlloyDBAdminClient.RestartInstanceAsync(RestartInstanceRequest, CallSettings)

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

AlloyDBAdminClient.RestoreCluster(RestoreClusterRequest, CallSettings)

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

AlloyDBAdminClient.RestoreClusterAsync(RestoreClusterRequest, CallSettings)

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

AlloyDBAdminClient.UpdateBackup(UpdateBackupRequest, CallSettings)

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

AlloyDBAdminClient.UpdateBackupAsync(UpdateBackupRequest, CallSettings)

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

AlloyDBAdminClient.UpdateCluster(UpdateClusterRequest, CallSettings)

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

AlloyDBAdminClient.UpdateClusterAsync(UpdateClusterRequest, CallSettings)

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

AlloyDBAdminClient.UpdateInstance(UpdateInstanceRequest, CallSettings)

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

AlloyDBAdminClient.UpdateInstanceAsync(UpdateInstanceRequest, CallSettings)

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

AlloyDBAdminClient.UpdateUser(UpdateUserRequest, CallSettings)

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

AlloyDBAdminClient.UpdateUserAsync(UpdateUserRequest, CallSettings)