Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MysqlaasClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • MysqlaasClient

Constructors

constructor

  • new MysqlaasClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): MysqlaasClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

_waiters: MysqlaasWaiter

targetService

targetService: string = "Mysqlaas"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://mysql.{region}.ocp.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

close

  • close(): void

createConfiguration

createWaiters

  • Creates a new MysqlaasWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns MysqlaasWaiter

    The service waiters.

deleteConfiguration

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteConfiguration API.

    Parameters

    Returns Promise<DeleteConfigurationResponse>

    DeleteConfigurationResponse

getConfiguration

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetConfiguration API.

    Parameters

    Returns Promise<GetConfigurationResponse>

    GetConfigurationResponse

getWaiters

listAllConfigurations

  • NOTE: This function is deprecated in favor of listConfigurationsRecordIterator function. Creates a new async iterator which will iterate over the models.ConfigurationSummary objects contained in responses from the listConfigurations operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ConfigurationSummary>

listAllConfigurationsResponses

  • NOTE: This function is deprecated in favor of listConfigurationsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listConfigurations operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListConfigurationsResponse>

listConfigurations

  • Lists the Configurations available when creating a DB System.

    This may include DEFAULT configurations per Shape and CUSTOM configurations.

    The default sort order is a multi-part sort by: - shapeName, ascending - DEFAULT-before-CUSTOM - displayName ascending

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListConfigurations API.

    Parameters

    Returns Promise<ListConfigurationsResponse>

    ListConfigurationsResponse

listConfigurationsRecordIterator

  • Creates a new async iterator which will iterate over the models.ConfigurationSummary objects contained in responses from the listConfigurations operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ConfigurationSummary>

listConfigurationsResponseIterator

listShapes

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListShapes API.

    Parameters

    Returns Promise<ListShapesResponse>

    ListShapesResponse

listVersions

  • Get a list of supported and available MySQL database major versions.

    The list is sorted by version family.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListVersions API.

    Parameters

    Returns Promise<ListVersionsResponse>

    ListVersionsResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateConfiguration

  • Updates the Configuration details. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateConfiguration API.

    Parameters

    Returns Promise<UpdateConfigurationResponse>

    UpdateConfigurationResponse