public sealed class AlloyDBAdminClientImpl : AlloyDBAdminClient
Reference documentation and code samples for the AlloyDB v1beta API class AlloyDBAdminClientImpl.
AlloyDBAdmin client wrapper implementation, for convenient use.
Namespace
Google.Cloud.AlloyDb.V1BetaAssembly
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.
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 |
CreateBackupOperationsClient
public override OperationsClient CreateBackupOperationsClient { get; }
The long-running operations client for CreateBackup
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
CreateClusterOperationsClient
public override OperationsClient CreateClusterOperationsClient { get; }
The long-running operations client for CreateCluster
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
CreateInstanceOperationsClient
public override OperationsClient CreateInstanceOperationsClient { get; }
The long-running operations client for CreateInstance
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
CreateSecondaryClusterOperationsClient
public override OperationsClient CreateSecondaryClusterOperationsClient { get; }
The long-running operations client for CreateSecondaryCluster
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
CreateSecondaryInstanceOperationsClient
public override OperationsClient CreateSecondaryInstanceOperationsClient { get; }
The long-running operations client for CreateSecondaryInstance
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DeleteBackupOperationsClient
public override OperationsClient DeleteBackupOperationsClient { get; }
The long-running operations client for DeleteBackup
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DeleteClusterOperationsClient
public override OperationsClient DeleteClusterOperationsClient { get; }
The long-running operations client for DeleteCluster
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DeleteInstanceOperationsClient
public override OperationsClient DeleteInstanceOperationsClient { get; }
The long-running operations client for DeleteInstance
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
FailoverInstanceOperationsClient
public override OperationsClient FailoverInstanceOperationsClient { get; }
The long-running operations client for FailoverInstance
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
GrpcClient
public override AlloyDBAdmin.AlloyDBAdminClient GrpcClient { get; }
The underlying gRPC AlloyDBAdmin client
Property Value | |
---|---|
Type | Description |
AlloyDBAdminAlloyDBAdminClient |
IAMPolicyClient
public override IAMPolicyClient IAMPolicyClient { get; }
The IAMPolicyClient associated with this client.
Property Value | |
---|---|
Type | Description |
IAMPolicyClient |
InjectFaultOperationsClient
public override OperationsClient InjectFaultOperationsClient { get; }
The long-running operations client for InjectFault
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
LocationsClient
public override LocationsClient LocationsClient { get; }
The LocationsClient associated with this client.
Property Value | |
---|---|
Type | Description |
LocationsClient |
PromoteClusterOperationsClient
public override OperationsClient PromoteClusterOperationsClient { get; }
The long-running operations client for PromoteCluster
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
RestartInstanceOperationsClient
public override OperationsClient RestartInstanceOperationsClient { get; }
The long-running operations client for RestartInstance
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
RestoreClusterOperationsClient
public override OperationsClient RestoreClusterOperationsClient { get; }
The long-running operations client for RestoreCluster
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
UpdateBackupOperationsClient
public override OperationsClient UpdateBackupOperationsClient { get; }
The long-running operations client for UpdateBackup
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
UpdateClusterOperationsClient
public override OperationsClient UpdateClusterOperationsClient { get; }
The long-running operations client for UpdateCluster
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
UpdateInstanceOperationsClient
public override OperationsClient UpdateInstanceOperationsClient { get; }
The long-running operations client for UpdateInstance
.
Property Value | |
---|---|
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.
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |