Class PostgresqlClient

Service client instance for Postgresql.

Inheritance

object

ClientBase

RegionalClientBase

PostgresqlClient

Implements

IDisposable

Inherited Members

RegionalClientBase.logger

RegionalClientBase.SetRegion(Region)

RegionalClientBase.SetRegion(string)

RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)

RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)

RegionalClientBase.parseEndpointForParameters(string)

ClientBase.restClient

ClientBase.service

ClientBase.userAgent

ClientBase.Dispose()

ClientBase.Dispose(bool)

ClientBase.SetEndpoint(string)

ClientBase.GetEndpoint()

ClientBase.GetUserAgent()

ClientBase.SetRealmSpecificEndpointTemplate(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.PsqlService

Assembly: OCI.DotNetSDK.Psql.dll

Syntax

public class PostgresqlClient : RegionalClientBase, IDisposable

Constructors

PostgresqlClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)

Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.

Declaration

public PostgresqlClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)

Parameters

Type	Name	Description
IBasicAuthenticationDetailsProvider	authenticationDetailsProvider	The authentication details provider. Required.
ClientConfiguration	clientConfiguration	The client configuration that contains settings to adjust REST client behaviors. Optional.
string	endpoint	The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional.

Properties

Paginators

Declaration

public PostgresqlPaginators Paginators { get; }

Property Value

Type	Description
PostgresqlPaginators

Waiters

Declaration

public PostgresqlWaiters Waiters { get; }

Property Value

Type	Description
PostgresqlWaiters

Methods

BackupCopy(BackupCopyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Backup Copy Request to copy back up in remote region. When provided, If-Match is checked against ETag values of the resource.

Declaration

public Task<BackupCopyResponse> BackupCopy(BackupCopyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
BackupCopyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<BackupCopyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use BackupCopy API.

ChangeBackupCompartment(ChangeBackupCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a backup from one compartment to another. When provided, If-Match is checked against ETag values of the resource.

Declaration

public Task<ChangeBackupCompartmentResponse> ChangeBackupCompartment(ChangeBackupCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeBackupCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeBackupCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeBackupCompartment API.

ChangeConfigurationCompartment(ChangeConfigurationCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a configuration from one compartment to another. When provided, If-Match is checked against ETag values of the resource.

Declaration

public Task<ChangeConfigurationCompartmentResponse> ChangeConfigurationCompartment(ChangeConfigurationCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeConfigurationCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeConfigurationCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeConfigurationCompartment API.

ChangeDbSystemCompartment(ChangeDbSystemCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a database system from one compartment to another. When provided, If-Match is checked against ETag values of the resource.

Declaration

public Task<ChangeDbSystemCompartmentResponse> ChangeDbSystemCompartment(ChangeDbSystemCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeDbSystemCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeDbSystemCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeDbSystemCompartment API.

CreateBackup(CreateBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new backup.

Declaration

public Task<CreateBackupResponse> CreateBackup(CreateBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateBackupRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateBackupResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateBackup API.

CreateConfiguration(CreateConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new configuration.

Declaration

public Task<CreateConfigurationResponse> CreateConfiguration(CreateConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateConfigurationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateConfigurationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateConfiguration API.

CreateDbSystem(CreateDbSystemRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new database system.

Declaration

public Task<CreateDbSystemResponse> CreateDbSystem(CreateDbSystemRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateDbSystemRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateDbSystemResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateDbSystem API.

DeleteBackup(DeleteBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a backup by identifier.

Declaration

public Task<DeleteBackupResponse> DeleteBackup(DeleteBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteBackupRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteBackupResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteBackup API.

DeleteConfiguration(DeleteConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a configuration by identifier.

Declaration

public Task<DeleteConfigurationResponse> DeleteConfiguration(DeleteConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteConfigurationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteConfigurationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteConfiguration API.

DeleteDbSystem(DeleteDbSystemRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a database system by identifier.

Declaration

public Task<DeleteDbSystemResponse> DeleteDbSystem(DeleteDbSystemRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteDbSystemRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteDbSystemResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteDbSystem API.

FailoverDbSystem(FailoverDbSystemRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Runs a failover operation. Optionally, specify the desired AD for regions with three ADs.

Declaration

public Task<FailoverDbSystemResponse> FailoverDbSystem(FailoverDbSystemRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
FailoverDbSystemRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<FailoverDbSystemResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use FailoverDbSystem API.

GetBackup(GetBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a backup by identifier.

Declaration

public Task<GetBackupResponse> GetBackup(GetBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetBackupRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetBackupResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetBackup API.

GetConfiguration(GetConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a configuration by identifier.

Declaration

public Task<GetConfigurationResponse> GetConfiguration(GetConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetConfigurationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetConfigurationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetConfiguration API.

GetConnectionDetails(GetConnectionDetailsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the database system connection details.

Declaration

public Task<GetConnectionDetailsResponse> GetConnectionDetails(GetConnectionDetailsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetConnectionDetailsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetConnectionDetailsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetConnectionDetails API.

GetDbSystem(GetDbSystemRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a database system by identifier.

Declaration

public Task<GetDbSystemResponse> GetDbSystem(GetDbSystemRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDbSystemRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetDbSystemResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetDbSystem API.

GetDefaultConfiguration(GetDefaultConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a default configuration by identifier.

Declaration

public Task<GetDefaultConfigurationResponse> GetDefaultConfiguration(GetDefaultConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDefaultConfigurationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetDefaultConfigurationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetDefaultConfiguration API.

GetPrimaryDbInstance(GetPrimaryDbInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the primary database instance node details.

Declaration

public Task<GetPrimaryDbInstanceResponse> GetPrimaryDbInstance(GetPrimaryDbInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetPrimaryDbInstanceRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetPrimaryDbInstanceResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetPrimaryDbInstance API.

GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets details of the work request with the given ID.

Declaration

public Task<GetWorkRequestResponse> GetWorkRequest(GetWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetWorkRequestRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetWorkRequestResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetWorkRequest API.

ListBackups(ListBackupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of backups.

Declaration

public Task<ListBackupsResponse> ListBackups(ListBackupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListBackupsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListBackupsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListBackups API.

ListConfigurations(ListConfigurationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of configurations.

Declaration

public Task<ListConfigurationsResponse> ListConfigurations(ListConfigurationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListConfigurationsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListConfigurationsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListConfigurations API.

ListDbSystems(ListDbSystemsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of database systems.

Declaration

public Task<ListDbSystemsResponse> ListDbSystems(ListDbSystemsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDbSystemsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListDbSystemsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDbSystems API.

ListDefaultConfigurations(ListDefaultConfigurationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of default configurations.

Declaration

public Task<ListDefaultConfigurationsResponse> ListDefaultConfigurations(ListDefaultConfigurationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDefaultConfigurationsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListDefaultConfigurationsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDefaultConfigurations API.

ListShapes(ListShapesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the list of shapes allowed in the region.

Declaration

public Task<ListShapesResponse> ListShapes(ListShapesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListShapesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListShapesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListShapes API.

ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a (paginated) list of errors for the work request with the given ID.

Declaration

public Task<ListWorkRequestErrorsResponse> ListWorkRequestErrors(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkRequestErrorsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListWorkRequestErrorsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequestErrors API.

ListWorkRequestLogs(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a (paginated) list of logs for the work request with the given ID.

Declaration

public Task<ListWorkRequestLogsResponse> ListWorkRequestLogs(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkRequestLogsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListWorkRequestLogsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequestLogs API.

ListWorkRequests(ListWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the work requests in a compartment.

Declaration

public Task<ListWorkRequestsResponse> ListWorkRequests(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkRequestsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListWorkRequestsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequests API.

PatchDbSystem(PatchDbSystemRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Modifies the database system by adding or removing database instance nodes.

Declaration

public Task<PatchDbSystemResponse> PatchDbSystem(PatchDbSystemRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchDbSystemRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchDbSystemResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchDbSystem API.

ResetMasterUserPassword(ResetMasterUserPasswordRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Resets the database system's master password.

Declaration

public Task<ResetMasterUserPasswordResponse> ResetMasterUserPassword(ResetMasterUserPasswordRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ResetMasterUserPasswordRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ResetMasterUserPasswordResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ResetMasterUserPassword API.

RestartDbInstanceInDbSystem(RestartDbInstanceInDbSystemRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Restarts the running database instance node.

Declaration

public Task<RestartDbInstanceInDbSystemResponse> RestartDbInstanceInDbSystem(RestartDbInstanceInDbSystemRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
RestartDbInstanceInDbSystemRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<RestartDbInstanceInDbSystemResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use RestartDbInstanceInDbSystem API.

RestoreDbSystem(RestoreDbSystemRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Restore the database system.

Declaration

public Task<RestoreDbSystemResponse> RestoreDbSystem(RestoreDbSystemRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
RestoreDbSystemRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<RestoreDbSystemResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use RestoreDbSystem API.

UpdateBackup(UpdateBackupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the backup.

Declaration

public Task<UpdateBackupResponse> UpdateBackup(UpdateBackupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateBackupRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateBackupResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateBackup API.

UpdateConfiguration(UpdateConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a display name or description of the configuration.

Declaration

public Task<UpdateConfigurationResponse> UpdateConfiguration(UpdateConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateConfigurationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateConfigurationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateConfiguration API.

UpdateDbSystem(UpdateDbSystemRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the database system.

Declaration

public Task<UpdateDbSystemResponse> UpdateDbSystem(UpdateDbSystemRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateDbSystemRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateDbSystemResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateDbSystem API.

UpdateDbSystemDbInstance(UpdateDbSystemDbInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the database instance node.

Declaration

public Task<UpdateDbSystemDbInstanceResponse> UpdateDbSystemDbInstance(UpdateDbSystemDbInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateDbSystemDbInstanceRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateDbSystemDbInstanceResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateDbSystemDbInstance API.

Implements

IDisposable