Class DbSystemClient

Service client instance for DbSystem.

Inheritance

object

ClientBase

RegionalClientBase

DbSystemClient

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.MysqlService

Assembly: OCI.DotNetSDK.Mysql.dll

Syntax

public class DbSystemClient : RegionalClientBase, IDisposable

Constructors

DbSystemClient(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 DbSystemClient(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 DbSystemPaginators Paginators { get; }

Property Value

Type	Description
DbSystemPaginators

Waiters

Declaration

public DbSystemWaiters Waiters { get; }

Property Value

Type	Description
DbSystemWaiters

Methods

AddHeatWaveCluster(AddHeatWaveClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Adds a HeatWave cluster to the DB System.

Declaration

public Task<AddHeatWaveClusterResponse> AddHeatWaveCluster(AddHeatWaveClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
AddHeatWaveClusterRequest	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<AddHeatWaveClusterResponse>	A response object containing details about the completed operation

Examples

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

CreateDbSystem(CreateDbSystemRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates and launches a DB 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.

DeleteDbSystem(DeleteDbSystemRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a DB System, including terminating, detaching, removing, finalizing and otherwise deleting all related resources.

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.

DeleteHeatWaveCluster(DeleteHeatWaveClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the HeatWave cluster including terminating, detaching, removing, finalizing and otherwise deleting all related resources.

Declaration

public Task<DeleteHeatWaveClusterResponse> DeleteHeatWaveCluster(DeleteHeatWaveClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteHeatWaveClusterRequest	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<DeleteHeatWaveClusterResponse>	A response object containing details about the completed operation

Examples

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

GenerateHeatWaveClusterMemoryEstimate(GenerateHeatWaveClusterMemoryEstimateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Sends a request to estimate the memory footprints of user tables when loaded to HeatWave cluster memory.

Declaration

public Task<GenerateHeatWaveClusterMemoryEstimateResponse> GenerateHeatWaveClusterMemoryEstimate(GenerateHeatWaveClusterMemoryEstimateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GenerateHeatWaveClusterMemoryEstimateRequest	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<GenerateHeatWaveClusterMemoryEstimateResponse>	A response object containing details about the completed operation

Examples

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

GetDbSystem(GetDbSystemRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get information about the specified DB System.

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.

GetHeatWaveCluster(GetHeatWaveClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about the HeatWave cluster.

Declaration

public Task<GetHeatWaveClusterResponse> GetHeatWaveCluster(GetHeatWaveClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetHeatWaveClusterRequest	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<GetHeatWaveClusterResponse>	A response object containing details about the completed operation

Examples

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

GetHeatWaveClusterMemoryEstimate(GetHeatWaveClusterMemoryEstimateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the most recent HeatWave cluster memory estimate that can be used to determine a suitable HeatWave cluster size.

Declaration

public Task<GetHeatWaveClusterMemoryEstimateResponse> GetHeatWaveClusterMemoryEstimate(GetHeatWaveClusterMemoryEstimateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetHeatWaveClusterMemoryEstimateRequest	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<GetHeatWaveClusterMemoryEstimateResponse>	A response object containing details about the completed operation

Examples

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

ListDbSystems(ListDbSystemsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a list of DB Systems in the specified compartment. The default sort order is by timeUpdated, descending.

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.

RestartDbSystem(RestartDbSystemRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Restarts the specified DB System.

Declaration

public Task<RestartDbSystemResponse> RestartDbSystem(RestartDbSystemRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
RestartDbSystemRequest	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<RestartDbSystemResponse>	A response object containing details about the completed operation

Examples

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

RestartHeatWaveCluster(RestartHeatWaveClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Restarts the HeatWave cluster.

Declaration

public Task<RestartHeatWaveClusterResponse> RestartHeatWaveCluster(RestartHeatWaveClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
RestartHeatWaveClusterRequest	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<RestartHeatWaveClusterResponse>	A response object containing details about the completed operation

Examples

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

StartDbSystem(StartDbSystemRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Start the specified DB System.

Declaration

public Task<StartDbSystemResponse> StartDbSystem(StartDbSystemRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
StartDbSystemRequest	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<StartDbSystemResponse>	A response object containing details about the completed operation

Examples

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

StartHeatWaveCluster(StartHeatWaveClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Starts the HeatWave cluster.

Declaration

public Task<StartHeatWaveClusterResponse> StartHeatWaveCluster(StartHeatWaveClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
StartHeatWaveClusterRequest	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<StartHeatWaveClusterResponse>	A response object containing details about the completed operation

Examples

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

StopDbSystem(StopDbSystemRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Stops the specified DB System. <br/> A stopped DB System is not billed.

Declaration

public Task<StopDbSystemResponse> StopDbSystem(StopDbSystemRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
StopDbSystemRequest	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<StopDbSystemResponse>	A response object containing details about the completed operation

Examples

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

StopHeatWaveCluster(StopHeatWaveClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Stops the HeatWave cluster.

Declaration

public Task<StopHeatWaveClusterResponse> StopHeatWaveCluster(StopHeatWaveClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
StopHeatWaveClusterRequest	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<StopHeatWaveClusterResponse>	A response object containing details about the completed operation

Examples

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

UpdateDbSystem(UpdateDbSystemRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update the configuration of a DB System. <br/> Updating different fields in the DB System will have different results on the uptime of the DB System. For example, changing the displayName of a DB System will take effect immediately, but changing the shape of a DB System is an asynchronous operation that involves provisioning new Compute resources, pausing the DB System and migrating storage before making the DB System available again.

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.

UpdateHeatWaveCluster(UpdateHeatWaveClusterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the HeatWave cluster.

Declaration

public Task<UpdateHeatWaveClusterResponse> UpdateHeatWaveCluster(UpdateHeatWaveClusterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateHeatWaveClusterRequest	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<UpdateHeatWaveClusterResponse>	A response object containing details about the completed operation

Examples

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

Implements

IDisposable