Class MysqlaasClient

Service client instance for Mysqlaas.

Inheritance

object

ClientBase

RegionalClientBase

MysqlaasClient

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 MysqlaasClient : RegionalClientBase, IDisposable

Constructors

MysqlaasClient(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 MysqlaasClient(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 MysqlaasPaginators Paginators { get; }

Property Value

Type	Description
MysqlaasPaginators

Waiters

Declaration

public MysqlaasWaiters Waiters { get; }

Property Value

Type	Description
MysqlaasWaiters

Methods

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.

DeleteConfiguration(DeleteConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a Configuration. The Configuration must not be in use by any DB Systems.

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.

GetConfiguration(GetConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get the full details of the specified Configuration, including the list of MySQL Variables and their values.

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.

ListConfigurations(ListConfigurationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the Configurations available when creating a DB System. <br/> This may include DEFAULT configurations per Shape and CUSTOM configurations. <br/> The default sort order is a multi-part sort by:

shapeName, ascending
DEFAULT-before-CUSTOM
displayName ascending

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.

ListShapes(ListShapesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of the shapes you can use to create a new MySQL DB System. The shape determines the resources allocated to the DB System: CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes.

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.

ListVersions(ListVersionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a list of supported and available MySQL database major versions. <br/> The list is sorted by version family.

Declaration

public Task<ListVersionsResponse> ListVersions(ListVersionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateConfiguration(UpdateConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the Configuration details.

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.

Implements

IDisposable