public sealed class AlloyDBAdminClientImpl : AlloyDBAdminClientReference documentation and code samples for the AlloyDB v1beta API class AlloyDBAdminClientImpl.
AlloyDBAdmin client wrapper implementation, for convenient use.
Namespace
GoogleCloudGoogle.Cloud.AlloyDbV1BetaAssembly
Google.Cloud.AlloyDb.V1Beta.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.
| Name | Description |
grpcClient | AlloyDBAdminAlloyDBAdminClientThe underlying gRPC client. |
settings | AlloyDBAdminSettingsThe base AlloyDBAdminSettings used within this client. |
logger | ILoggerOptional ILogger to use within this client. |
Properties
BatchCreateInstancesOperationsClient
public override OperationsClient BatchCreateInstancesOperationsClient { get; }The long-running operations client for BatchCreateInstances.
| Type | Description |
OperationsClient |
CreateBackupOperationsClient
public override OperationsClient CreateBackupOperationsClient { get; }The long-running operations client for CreateBackup.
| Type | Description |
OperationsClient |
CreateClusterOperationsClient
public override OperationsClient CreateClusterOperationsClient { get; }The long-running operations client for CreateCluster.
| Type | Description |
OperationsClient |
CreateInstanceOperationsClient
public override OperationsClient CreateInstanceOperationsClient { get; }The long-running operations client for CreateInstance.
| Type | Description |
OperationsClient |
CreateSecondaryClusterOperationsClient
public override OperationsClient CreateSecondaryClusterOperationsClient { get; }The long-running operations client for CreateSecondaryCluster.
| Type | Description |
OperationsClient |
CreateSecondaryInstanceOperationsClient
public override OperationsClient CreateSecondaryInstanceOperationsClient { get; }The long-running operations client for CreateSecondaryInstance.
| Type | Description |
OperationsClient |
DeleteBackupOperationsClient
public override OperationsClient DeleteBackupOperationsClient { get; }The long-running operations client for DeleteBackup.
| Type | Description |
OperationsClient |
DeleteClusterOperationsClient
public override OperationsClient DeleteClusterOperationsClient { get; }The long-running operations client for DeleteCluster.
| Type | Description |
OperationsClient |
DeleteInstanceOperationsClient
public override OperationsClient DeleteInstanceOperationsClient { get; }The long-running operations client for DeleteInstance.
| Type | Description |
OperationsClient |
FailoverInstanceOperationsClient
public override OperationsClient FailoverInstanceOperationsClient { get; }The long-running operations client for FailoverInstance.
| Type | Description |
OperationsClient |
GrpcClient
public override AlloyDBAdmin.AlloyDBAdminClient GrpcClient { get; }The underlying gRPC AlloyDBAdmin client
| Type | Description |
AlloyDBAdminAlloyDBAdminClient |
IAMPolicyClient
public override IAMPolicyClient IAMPolicyClient { get; }The IAMPolicyClient associated with this client.
| Type | Description |
IAMPolicyClient |
LocationsClient
public override LocationsClient LocationsClient { get; }The LocationsClient associated with this client.
| Type | Description |
LocationsClient |
PromoteClusterOperationsClient
public override OperationsClient PromoteClusterOperationsClient { get; }The long-running operations client for PromoteCluster.
| Type | Description |
OperationsClient |
RestartInstanceOperationsClient
public override OperationsClient RestartInstanceOperationsClient { get; }The long-running operations client for RestartInstance.
| Type | Description |
OperationsClient |
RestoreClusterOperationsClient
public override OperationsClient RestoreClusterOperationsClient { get; }The long-running operations client for RestoreCluster.
| Type | Description |
OperationsClient |
UpdateBackupOperationsClient
public override OperationsClient UpdateBackupOperationsClient { get; }The long-running operations client for UpdateBackup.
| Type | Description |
OperationsClient |
UpdateClusterOperationsClient
public override OperationsClient UpdateClusterOperationsClient { get; }The long-running operations client for UpdateCluster.
| Type | Description |
OperationsClient |
UpdateInstanceOperationsClient
public override OperationsClient UpdateInstanceOperationsClient { get; }The long-running operations client for UpdateInstance.
| Type | Description |
OperationsClient |
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.
| Name | Description |
request | BatchCreateInstancesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
OperationBatchCreateInstancesResponseOperationMetadata | The RPC response. |
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.
| Name | Description |
request | BatchCreateInstancesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
TaskOperationBatchCreateInstancesResponseOperationMetadata | A Task containing the RPC response. |
CreateBackup(CreateBackupRequest, CallSettings)
public override Operation<Backup, OperationMetadata> CreateBackup(CreateBackupRequest request, CallSettings callSettings = null)Creates a new Backup in a given project and location.
| Name | Description |
request | CreateBackupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
OperationBackupOperationMetadata | The RPC response. |
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.
| Name | Description |
request | CreateBackupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
TaskOperationBackupOperationMetadata | A Task containing the RPC response. |
CreateCluster(CreateClusterRequest, CallSettings)
public override Operation<Cluster, OperationMetadata> CreateCluster(CreateClusterRequest request, CallSettings callSettings = null)Creates a new Cluster in a given project and location.
| Name | Description |
request | CreateClusterRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
OperationClusterOperationMetadata | The RPC response. |
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.
| Name | Description |
request | CreateClusterRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
TaskOperationClusterOperationMetadata | A Task containing the RPC response. |
CreateInstance(CreateInstanceRequest, CallSettings)
public override Operation<Instance, OperationMetadata> CreateInstance(CreateInstanceRequest request, CallSettings callSettings = null)Creates a new Instance in a given project and location.
| Name | Description |
request | CreateInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
OperationInstanceOperationMetadata | The RPC response. |
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.
| Name | Description |
request | CreateInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
TaskOperationInstanceOperationMetadata | A Task containing the RPC response. |
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.
| Name | Description |
request | CreateSecondaryClusterRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
OperationClusterOperationMetadata | The RPC response. |
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.
| Name | Description |
request | CreateSecondaryClusterRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
TaskOperationClusterOperationMetadata | A Task containing the RPC response. |
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.
| Name | Description |
request | CreateSecondaryInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
OperationInstanceOperationMetadata | The RPC response. |
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.
| Name | Description |
request | CreateSecondaryInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
TaskOperationInstanceOperationMetadata | A Task containing the RPC response. |
DeleteBackup(DeleteBackupRequest, CallSettings)
public override Operation<Empty, OperationMetadata> DeleteBackup(DeleteBackupRequest request, CallSettings callSettings = null)Deletes a single Backup.
| Name | Description |
request | DeleteBackupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
OperationEmptyOperationMetadata | The RPC response. |
DeleteBackupAsync(DeleteBackupRequest, CallSettings)
public override Task<Operation<Empty, OperationMetadata>> DeleteBackupAsync(DeleteBackupRequest request, CallSettings callSettings = null)Deletes a single Backup.
| Name | Description |
request | DeleteBackupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
TaskOperationEmptyOperationMetadata | A Task containing the RPC response. |
DeleteCluster(DeleteClusterRequest, CallSettings)
public override Operation<Empty, OperationMetadata> DeleteCluster(DeleteClusterRequest request, CallSettings callSettings = null)Deletes a single Cluster.
| Name | Description |
request | DeleteClusterRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
OperationEmptyOperationMetadata | The RPC response. |
DeleteClusterAsync(DeleteClusterRequest, CallSettings)
public override Task<Operation<Empty, OperationMetadata>> DeleteClusterAsync(DeleteClusterRequest request, CallSettings callSettings = null)Deletes a single Cluster.
| Name | Description |
request | DeleteClusterRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
TaskOperationEmptyOperationMetadata | A Task containing the RPC response. |
DeleteInstance(DeleteInstanceRequest, CallSettings)
public override Operation<Empty, OperationMetadata> DeleteInstance(DeleteInstanceRequest request, CallSettings callSettings = null)Deletes a single Instance.
| Name | Description |
request | DeleteInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
OperationEmptyOperationMetadata | The RPC response. |
DeleteInstanceAsync(DeleteInstanceRequest, CallSettings)
public override Task<Operation<Empty, OperationMetadata>> DeleteInstanceAsync(DeleteInstanceRequest request, CallSettings callSettings = null)Deletes a single Instance.
| Name | Description |
request | DeleteInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
TaskOperationEmptyOperationMetadata | A Task containing the RPC response. |
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.
| Name | Description |
request | FailoverInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
OperationInstanceOperationMetadata | The RPC response. |
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.
| Name | Description |
request | FailoverInstanceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
TaskOperationInstanceOperationMetadata | A Task containing the RPC response. |
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 the Auth Proxy client and the endpoint's behavior is subject to change without notice, so do not rely on its behavior remaining constant. Future changes will not break the Auth Proxy client.
| Name | Description |
request | GenerateClientCertificateRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
GenerateClientCertificateResponse | The RPC response. |
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 the Auth Proxy client and the endpoint's behavior is subject to change without notice, so do not rely on its behavior remaining constant. Future changes will not break the Auth Proxy client.
| Name | Description |
request | GenerateClientCertificateRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
TaskGenerateClientCertificateResponse | A Task containing the RPC response. |
GetBackup(GetBackupRequest, CallSettings)
public override Backup GetBackup(GetBackupRequest request, CallSettings callSettings = null)Gets details of a single Backup.
| Name | Description |
request | GetBackupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
Backup | The RPC response. |
GetBackupAsync(GetBackupRequest, CallSettings)
public override Task<Backup> GetBackupAsync(GetBackupRequest request, CallSettings callSettings = null)Gets details of a single Backup.
| Name | Description |
request | GetBackupRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
TaskBackup | A Task containing the RPC response. |
GetCluster(GetClusterRequest, CallSettings)
public override Cluster GetCluster(GetClusterRequest request, CallSettings callSettings = null)Gets details of a single Cluster.
| Name | Description |
request | GetClusterRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
Cluster | The RPC response. |
GetClusterAsync(GetClusterRequest, CallSettings)
public override Task<Cluster> GetClusterAsync(GetClusterRequest request, CallSettings callSettings = null)Gets details of a single Cluster.
| Name | Description |
request | GetClusterRequestThe request obj |