/** * MySQL Database Service API * The API for the MySQL Database Service * OpenAPI spec version: 20190415 * Contact: mysql-cloud-dev_ww_grp@oracle.com * * NOTE: This class is auto generated by OracleSDKGenerator. * Do not edit the class manually. * * Copyright (c) 2020, 2026, Oracle and/or its affiliates. All rights reserved. * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. */ import common = require("oci-common"); import * as requests from "./request"; import * as model from "./model"; import * as responses from "./response"; import { ChannelsWaiter } from "./channels-waiter"; import { DbBackupsWaiter } from "./dbbackups-waiter"; import { DbSystemWaiter } from "./dbsystem-waiter"; import { MysqlaasWaiter } from "./mysqlaas-waiter"; import { ReplicasWaiter } from "./replicas-waiter"; import { WorkRequestsWaiter } from "./workrequests-waiter"; declare const Breaker: any; export declare enum ChannelsApiKeys { } /** * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user. */ export declare class ChannelsClient { protected static serviceEndpointTemplate: string; protected static endpointServiceName: string; protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined; protected "_endpoint": string; protected "_defaultHeaders": any; protected "_waiters": ChannelsWaiter; protected "_clientConfiguration": common.ClientConfiguration; protected _circuitBreaker: typeof Breaker | null; protected _httpOptions: any; protected _bodyDuplexMode: any; targetService: string; protected _regionId: string; protected "_region": common.Region; protected _lastSetRegionOrRegionId: string; protected _httpClient: common.HttpClient; protected _authProvider: common.AuthenticationDetailsProvider | undefined; constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration); /** * Get the endpoint that is being used to call (ex, https://www.example.com). */ get endpoint(): string; /** * Sets the endpoint to call (ex, https://www.example.com). * @param endpoint The endpoint of the service. */ set endpoint(endpoint: string); get logger(): import("oci-common/lib/log").Logger; /** * 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" * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template */ set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean); /** * Sets the region to call (ex, Region.US_PHOENIX_1). * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint. * @param region The region of the service. */ set region(region: common.Region); /** * 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}. * @param regionId The public region ID. */ set regionId(regionId: string); /** * Creates a new ChannelsWaiter for resources for this service. * * @param config The waiter configuration for termination and delay strategy * @return The service waiters. */ createWaiters(config?: common.WaiterConfiguration): ChannelsWaiter; /** * Gets the waiters available for resources for this service. * * @return The service waiters. */ getWaiters(): ChannelsWaiter; /** * Shutdown the circuit breaker used by the client when it is no longer needed */ shutdownCircuitBreaker(): void; /** * Close the provider if possible which in turn shuts down any associated circuit breaker */ closeProvider(): void; /** * Close the client once it is no longer needed */ close(): void; /** * Creates a Channel to establish replication from a source to a target. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param CreateChannelRequest * @return CreateChannelResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/CreateChannel.ts.html |here} to see how to use CreateChannel API. */ createChannel(createChannelRequest: requests.CreateChannelRequest): Promise; /** * Deletes the specified Channel. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param DeleteChannelRequest * @return DeleteChannelResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/DeleteChannel.ts.html |here} to see how to use DeleteChannel API. */ deleteChannel(deleteChannelRequest: requests.DeleteChannelRequest): Promise; /** * Initiates an asynchronous request to collect the current status of the specified Channel. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GenerateChannelStatusRequest * @return GenerateChannelStatusResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/GenerateChannelStatus.ts.html |here} to see how to use GenerateChannelStatus API. */ generateChannelStatus(generateChannelStatusRequest: requests.GenerateChannelStatusRequest): Promise; /** * Gets the full details of the specified Channel, including the user-specified * configuration parameters (passwords are omitted), as well as information about * the state of the Channel, its sources and targets. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetChannelRequest * @return GetChannelResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/GetChannel.ts.html |here} to see how to use GetChannel API. */ getChannel(getChannelRequest: requests.GetChannelRequest): Promise; /** * Returns the most up-to-date status of the specified Channel. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetChannelStatusRequest * @return GetChannelStatusResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/GetChannelStatus.ts.html |here} to see how to use GetChannelStatus API. */ getChannelStatus(getChannelStatusRequest: requests.GetChannelStatusRequest): Promise; /** * Lists all the Channels that match the specified filters. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListChannelsRequest * @return ListChannelsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/ListChannels.ts.html |here} to see how to use ListChannels API. */ listChannels(listChannelsRequest: requests.ListChannelsRequest): Promise; /** * NOTE: This function is deprecated in favor of listChannelsRecordIterator function. * Creates a new async iterator which will iterate over the models.ChannelSummary objects * contained in responses from the listChannels operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllChannels(request: requests.ListChannelsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listChannelsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listChannels operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllChannelsResponses(request: requests.ListChannelsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.ChannelSummary objects * contained in responses from the listChannels operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listChannelsRecordIterator(request: requests.ListChannelsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listChannels operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listChannelsResponseIterator(request: requests.ListChannelsRequest): AsyncIterableIterator; /** * Resets the specified Channel by purging its cached information, leaving the Channel * as if it had just been created. This operation is only accepted in Inactive Channels. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ResetChannelRequest * @return ResetChannelResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/ResetChannel.ts.html |here} to see how to use ResetChannel API. */ resetChannel(resetChannelRequest: requests.ResetChannelRequest): Promise; /** * Resumes an enabled Channel that has become Inactive due to an error. The resume operation * requires that the error that cause the Channel to become Inactive has already been fixed, * otherwise the operation may fail. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ResumeChannelRequest * @return ResumeChannelResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/ResumeChannel.ts.html |here} to see how to use ResumeChannel API. */ resumeChannel(resumeChannelRequest: requests.ResumeChannelRequest): Promise; /** * Updates the properties of the specified Channel. * If the Channel is Active the Update operation will asynchronously apply the new configuration * parameters to the Channel and the Channel may become temporarily unavailable. Otherwise, the * new configuration will be applied the next time the Channel becomes Active. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param UpdateChannelRequest * @return UpdateChannelResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/UpdateChannel.ts.html |here} to see how to use UpdateChannel API. */ updateChannel(updateChannelRequest: requests.UpdateChannelRequest): Promise; } export declare enum DbBackupsApiKeys { } /** * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user. */ export declare class DbBackupsClient { protected static serviceEndpointTemplate: string; protected static endpointServiceName: string; protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined; protected "_endpoint": string; protected "_defaultHeaders": any; protected "_waiters": DbBackupsWaiter; protected "_clientConfiguration": common.ClientConfiguration; protected _circuitBreaker: typeof Breaker | null; protected _httpOptions: any; protected _bodyDuplexMode: any; targetService: string; protected _regionId: string; protected "_region": common.Region; protected _lastSetRegionOrRegionId: string; protected _httpClient: common.HttpClient; protected _authProvider: common.AuthenticationDetailsProvider | undefined; constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration); /** * Get the endpoint that is being used to call (ex, https://www.example.com). */ get endpoint(): string; /** * Sets the endpoint to call (ex, https://www.example.com). * @param endpoint The endpoint of the service. */ set endpoint(endpoint: string); get logger(): import("oci-common/lib/log").Logger; /** * 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" * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template */ set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean); /** * Sets the region to call (ex, Region.US_PHOENIX_1). * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint. * @param region The region of the service. */ set region(region: common.Region); /** * 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}. * @param regionId The public region ID. */ set regionId(regionId: string); /** * Creates a new DbBackupsWaiter for resources for this service. * * @param config The waiter configuration for termination and delay strategy * @return The service waiters. */ createWaiters(config?: common.WaiterConfiguration): DbBackupsWaiter; /** * Gets the waiters available for resources for this service. * * @return The service waiters. */ getWaiters(): DbBackupsWaiter; /** * Shutdown the circuit breaker used by the client when it is no longer needed */ shutdownCircuitBreaker(): void; /** * Close the provider if possible which in turn shuts down any associated circuit breaker */ closeProvider(): void; /** * Close the client once it is no longer needed */ close(): void; /** * Cancels the scheduled deletion of a backup and moves it to ACTIVE state. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param CancelBackupDeletionRequest * @return CancelBackupDeletionResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/CancelBackupDeletion.ts.html |here} to see how to use CancelBackupDeletion API. */ cancelBackupDeletion(cancelBackupDeletionRequest: requests.CancelBackupDeletionRequest): Promise; /** * Moves a DB System Backup into a different compartment. * When provided, If-Match is checked against ETag values of the Backup. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangeBackupCompartmentRequest * @return ChangeBackupCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/ChangeBackupCompartment.ts.html |here} to see how to use ChangeBackupCompartment API. */ changeBackupCompartment(changeBackupCompartmentRequest: requests.ChangeBackupCompartmentRequest): Promise; /** * Creates a copy of a DB system backup available in the specified source region. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param CopyBackupRequest * @return CopyBackupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/CopyBackup.ts.html |here} to see how to use CopyBackup API. */ copyBackup(copyBackupRequest: requests.CopyBackupRequest): Promise; /** * Create a backup of a DB System. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param CreateBackupRequest * @return CreateBackupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/CreateBackup.ts.html |here} to see how to use CreateBackup API. */ createBackup(createBackupRequest: requests.CreateBackupRequest): Promise; /** * Delete a Backup. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param DeleteBackupRequest * @return DeleteBackupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/DeleteBackup.ts.html |here} to see how to use DeleteBackup API. */ deleteBackup(deleteBackupRequest: requests.DeleteBackupRequest): Promise; /** * Export logical data from a DB system backup to an Object Storage bucket. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ExportBackupRequest * @return ExportBackupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/ExportBackup.ts.html |here} to see how to use ExportBackup API. */ exportBackup(exportBackupRequest: requests.ExportBackupRequest): Promise; /** * Get information about the specified Backup * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetBackupRequest * @return GetBackupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/GetBackup.ts.html |here} to see how to use GetBackup API. */ getBackup(getBackupRequest: requests.GetBackupRequest): Promise; /** * Get a list of DB System backups. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListBackupsRequest * @return ListBackupsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/ListBackups.ts.html |here} to see how to use ListBackups API. */ listBackups(listBackupsRequest: requests.ListBackupsRequest): Promise; /** * NOTE: This function is deprecated in favor of listBackupsRecordIterator function. * Creates a new async iterator which will iterate over the models.BackupSummary objects * contained in responses from the listBackups operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllBackups(request: requests.ListBackupsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listBackupsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listBackups operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllBackupsResponses(request: requests.ListBackupsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.BackupSummary objects * contained in responses from the listBackups operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listBackupsRecordIterator(request: requests.ListBackupsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listBackups operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listBackupsResponseIterator(request: requests.ListBackupsRequest): AsyncIterableIterator; /** * Update the metadata of a Backup. Metadata such as the displayName or description * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param UpdateBackupRequest * @return UpdateBackupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/UpdateBackup.ts.html |here} to see how to use UpdateBackup API. */ updateBackup(updateBackupRequest: requests.UpdateBackupRequest): Promise; /** * Request to validate the backup by checking the data consistency. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ValidateBackupRequest * @return ValidateBackupResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/ValidateBackup.ts.html |here} to see how to use ValidateBackup API. */ validateBackup(validateBackupRequest: requests.ValidateBackupRequest): Promise; } export declare enum DbSystemApiKeys { } /** * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user. */ export declare class DbSystemClient { protected static serviceEndpointTemplate: string; protected static endpointServiceName: string; protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined; protected "_endpoint": string; protected "_defaultHeaders": any; protected "_waiters": DbSystemWaiter; protected "_clientConfiguration": common.ClientConfiguration; protected _circuitBreaker: typeof Breaker | null; protected _httpOptions: any; protected _bodyDuplexMode: any; targetService: string; protected _regionId: string; protected "_region": common.Region; protected _lastSetRegionOrRegionId: string; protected _httpClient: common.HttpClient; protected _authProvider: common.AuthenticationDetailsProvider | undefined; constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration); /** * Get the endpoint that is being used to call (ex, https://www.example.com). */ get endpoint(): string; /** * Sets the endpoint to call (ex, https://www.example.com). * @param endpoint The endpoint of the service. */ set endpoint(endpoint: string); get logger(): import("oci-common/lib/log").Logger; /** * 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" * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template */ set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean); /** * Sets the region to call (ex, Region.US_PHOENIX_1). * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint. * @param region The region of the service. */ set region(region: common.Region); /** * 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}. * @param regionId The public region ID. */ set regionId(regionId: string); /** * Creates a new DbSystemWaiter for resources for this service. * * @param config The waiter configuration for termination and delay strategy * @return The service waiters. */ createWaiters(config?: common.WaiterConfiguration): DbSystemWaiter; /** * Gets the waiters available for resources for this service. * * @return The service waiters. */ getWaiters(): DbSystemWaiter; /** * Shutdown the circuit breaker used by the client when it is no longer needed */ shutdownCircuitBreaker(): void; /** * Close the provider if possible which in turn shuts down any associated circuit breaker */ closeProvider(): void; /** * Close the client once it is no longer needed */ close(): void; /** * Adds a HeatWave cluster to the DB System. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param AddHeatWaveClusterRequest * @return AddHeatWaveClusterResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/AddHeatWaveCluster.ts.html |here} to see how to use AddHeatWaveCluster API. */ addHeatWaveCluster(addHeatWaveClusterRequest: requests.AddHeatWaveClusterRequest): Promise; /** * Update the chosen subset of MySQL instances based on their role. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ControlledUpdateDbSystemRequest * @return ControlledUpdateDbSystemResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/ControlledUpdateDbSystem.ts.html |here} to see how to use ControlledUpdateDbSystem API. */ controlledUpdateDbSystem(controlledUpdateDbSystemRequest: requests.ControlledUpdateDbSystemRequest): Promise; /** * Creates and launches a DB System. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param CreateDbSystemRequest * @return CreateDbSystemResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/CreateDbSystem.ts.html |here} to see how to use CreateDbSystem API. */ createDbSystem(createDbSystemRequest: requests.CreateDbSystemRequest): Promise; /** * Delete a DB System, including terminating, detaching, * removing, finalizing and otherwise deleting all related resources. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param DeleteDbSystemRequest * @return DeleteDbSystemResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/DeleteDbSystem.ts.html |here} to see how to use DeleteDbSystem API. */ deleteDbSystem(deleteDbSystemRequest: requests.DeleteDbSystemRequest): Promise; /** * Deletes the HeatWave cluster including terminating, detaching, removing, finalizing and * otherwise deleting all related resources. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param DeleteHeatWaveClusterRequest * @return DeleteHeatWaveClusterResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/DeleteHeatWaveCluster.ts.html |here} to see how to use DeleteHeatWaveCluster API. */ deleteHeatWaveCluster(deleteHeatWaveClusterRequest: requests.DeleteHeatWaveClusterRequest): Promise; /** * Initiates an asynchronous request to collect the current status of the specified DB System, * including the status of any attached Channels (if requested). * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GenerateDbSystemStatusRequest * @return GenerateDbSystemStatusResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/GenerateDbSystemStatus.ts.html |here} to see how to use GenerateDbSystemStatus API. */ generateDbSystemStatus(generateDbSystemStatusRequest: requests.GenerateDbSystemStatusRequest): Promise; /** * Sends a request to estimate the memory footprints of user tables when loaded to HeatWave cluster memory. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GenerateHeatWaveClusterMemoryEstimateRequest * @return GenerateHeatWaveClusterMemoryEstimateResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/GenerateHeatWaveClusterMemoryEstimate.ts.html |here} to see how to use GenerateHeatWaveClusterMemoryEstimate API. */ generateHeatWaveClusterMemoryEstimate(generateHeatWaveClusterMemoryEstimateRequest: requests.GenerateHeatWaveClusterMemoryEstimateRequest): Promise; /** * Get information about the specified DB System. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetDbSystemRequest * @return GetDbSystemResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/GetDbSystem.ts.html |here} to see how to use GetDbSystem API. */ getDbSystem(getDbSystemRequest: requests.GetDbSystemRequest): Promise; /** * Returns the most up-to-date status of the specified DB System, * including the status of any requested Channels. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetDbSystemStatusRequest * @return GetDbSystemStatusResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/GetDbSystemStatus.ts.html |here} to see how to use GetDbSystemStatus API. */ getDbSystemStatus(getDbSystemStatusRequest: requests.GetDbSystemStatusRequest): Promise; /** * Gets information about the HeatWave cluster. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetHeatWaveClusterRequest * @return GetHeatWaveClusterResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/GetHeatWaveCluster.ts.html |here} to see how to use GetHeatWaveCluster API. */ getHeatWaveCluster(getHeatWaveClusterRequest: requests.GetHeatWaveClusterRequest): Promise; /** * Gets the most recent HeatWave cluster memory estimate that can be used to determine a suitable * HeatWave cluster size. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetHeatWaveClusterMemoryEstimateRequest * @return GetHeatWaveClusterMemoryEstimateResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/GetHeatWaveClusterMemoryEstimate.ts.html |here} to see how to use GetHeatWaveClusterMemoryEstimate API. */ getHeatWaveClusterMemoryEstimate(getHeatWaveClusterMemoryEstimateRequest: requests.GetHeatWaveClusterMemoryEstimateRequest): Promise; /** * Get a list of DB Systems in the specified compartment. * The default sort order is by timeUpdated, descending. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListDbSystemsRequest * @return ListDbSystemsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/ListDbSystems.ts.html |here} to see how to use ListDbSystems API. */ listDbSystems(listDbSystemsRequest: requests.ListDbSystemsRequest): Promise; /** * NOTE: This function is deprecated in favor of listDbSystemsRecordIterator function. * Creates a new async iterator which will iterate over the models.DbSystemSummary objects * contained in responses from the listDbSystems operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllDbSystems(request: requests.ListDbSystemsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listDbSystemsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listDbSystems operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllDbSystemsResponses(request: requests.ListDbSystemsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.DbSystemSummary objects * contained in responses from the listDbSystems operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listDbSystemsRecordIterator(request: requests.ListDbSystemsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listDbSystems operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listDbSystemsResponseIterator(request: requests.ListDbSystemsRequest): AsyncIterableIterator; /** * List all the maintenance events. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListMaintenanceEventsRequest * @return ListMaintenanceEventsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/ListMaintenanceEvents.ts.html |here} to see how to use ListMaintenanceEvents API. */ listMaintenanceEvents(listMaintenanceEventsRequest: requests.ListMaintenanceEventsRequest): Promise; /** * NOTE: This function is deprecated in favor of listMaintenanceEventsRecordIterator function. * Creates a new async iterator which will iterate over the models.MaintenanceEvent objects * contained in responses from the listMaintenanceEvents operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllMaintenanceEvents(request: requests.ListMaintenanceEventsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listMaintenanceEventsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listMaintenanceEvents operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllMaintenanceEventsResponses(request: requests.ListMaintenanceEventsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.MaintenanceEvent objects * contained in responses from the listMaintenanceEvents operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listMaintenanceEventsRecordIterator(request: requests.ListMaintenanceEventsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listMaintenanceEvents operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listMaintenanceEventsResponseIterator(request: requests.ListMaintenanceEventsRequest): AsyncIterableIterator; /** * Restarts the specified DB System. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param RestartDbSystemRequest * @return RestartDbSystemResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/RestartDbSystem.ts.html |here} to see how to use RestartDbSystem API. */ restartDbSystem(restartDbSystemRequest: requests.RestartDbSystemRequest): Promise; /** * Restarts the HeatWave cluster. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param RestartHeatWaveClusterRequest * @return RestartHeatWaveClusterResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/RestartHeatWaveCluster.ts.html |here} to see how to use RestartHeatWaveCluster API. */ restartHeatWaveCluster(restartHeatWaveClusterRequest: requests.RestartHeatWaveClusterRequest): Promise; /** * Start the specified DB System. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param StartDbSystemRequest * @return StartDbSystemResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/StartDbSystem.ts.html |here} to see how to use StartDbSystem API. */ startDbSystem(startDbSystemRequest: requests.StartDbSystemRequest): Promise; /** * Starts the HeatWave cluster. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param StartHeatWaveClusterRequest * @return StartHeatWaveClusterResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/StartHeatWaveCluster.ts.html |here} to see how to use StartHeatWaveCluster API. */ startHeatWaveCluster(startHeatWaveClusterRequest: requests.StartHeatWaveClusterRequest): Promise; /** * Stops the specified DB System. *

A stopped DB System is not billed. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param StopDbSystemRequest * @return StopDbSystemResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/StopDbSystem.ts.html |here} to see how to use StopDbSystem API. */ stopDbSystem(stopDbSystemRequest: requests.StopDbSystemRequest): Promise; /** * Stops the HeatWave cluster. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param StopHeatWaveClusterRequest * @return StopHeatWaveClusterResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/StopHeatWaveCluster.ts.html |here} to see how to use StopHeatWaveCluster API. */ stopHeatWaveCluster(stopHeatWaveClusterRequest: requests.StopHeatWaveClusterRequest): Promise; /** * Update the configuration of a DB System. *

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. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param UpdateDbSystemRequest * @return UpdateDbSystemResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/UpdateDbSystem.ts.html |here} to see how to use UpdateDbSystem API. */ updateDbSystem(updateDbSystemRequest: requests.UpdateDbSystemRequest): Promise; /** * Updates the HeatWave cluster. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param UpdateHeatWaveClusterRequest * @return UpdateHeatWaveClusterResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/UpdateHeatWaveCluster.ts.html |here} to see how to use UpdateHeatWaveCluster API. */ updateHeatWaveCluster(updateHeatWaveClusterRequest: requests.UpdateHeatWaveClusterRequest): Promise; } export declare enum MysqlaasApiKeys { } /** * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user. */ export declare class MysqlaasClient { protected static serviceEndpointTemplate: string; protected static endpointServiceName: string; protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined; protected "_endpoint": string; protected "_defaultHeaders": any; protected "_waiters": MysqlaasWaiter; protected "_clientConfiguration": common.ClientConfiguration; protected _circuitBreaker: typeof Breaker | null; protected _httpOptions: any; protected _bodyDuplexMode: any; targetService: string; protected _regionId: string; protected "_region": common.Region; protected _lastSetRegionOrRegionId: string; protected _httpClient: common.HttpClient; protected _authProvider: common.AuthenticationDetailsProvider | undefined; constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration); /** * Get the endpoint that is being used to call (ex, https://www.example.com). */ get endpoint(): string; /** * Sets the endpoint to call (ex, https://www.example.com). * @param endpoint The endpoint of the service. */ set endpoint(endpoint: string); get logger(): import("oci-common/lib/log").Logger; /** * 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" * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template */ set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean); /** * Sets the region to call (ex, Region.US_PHOENIX_1). * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint. * @param region The region of the service. */ set region(region: common.Region); /** * 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}. * @param regionId The public region ID. */ set regionId(regionId: string); /** * Creates a new MysqlaasWaiter for resources for this service. * * @param config The waiter configuration for termination and delay strategy * @return The service waiters. */ createWaiters(config?: common.WaiterConfiguration): MysqlaasWaiter; /** * Gets the waiters available for resources for this service. * * @return The service waiters. */ getWaiters(): MysqlaasWaiter; /** * Shutdown the circuit breaker used by the client when it is no longer needed */ shutdownCircuitBreaker(): void; /** * Close the provider if possible which in turn shuts down any associated circuit breaker */ closeProvider(): void; /** * Close the client once it is no longer needed */ close(): void; /** * Creates a new Configuration. * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateConfigurationRequest * @return CreateConfigurationResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/CreateConfiguration.ts.html |here} to see how to use CreateConfiguration API. */ createConfiguration(createConfigurationRequest: requests.CreateConfigurationRequest): Promise; /** * 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. * @param DeleteConfigurationRequest * @return DeleteConfigurationResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/DeleteConfiguration.ts.html |here} to see how to use DeleteConfiguration API. */ deleteConfiguration(deleteConfigurationRequest: requests.DeleteConfigurationRequest): Promise; /** * 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. * @param GetConfigurationRequest * @return GetConfigurationResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/GetConfiguration.ts.html |here} to see how to use GetConfiguration API. */ getConfiguration(getConfigurationRequest: requests.GetConfigurationRequest): Promise; /** * 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. * @param ListConfigurationsRequest * @return ListConfigurationsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/ListConfigurations.ts.html |here} to see how to use ListConfigurations API. */ listConfigurations(listConfigurationsRequest: requests.ListConfigurationsRequest): Promise; /** * 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. * * @param request a request which can be sent to the service operation */ listAllConfigurations(request: requests.ListConfigurationsRequest): AsyncIterableIterator; /** * 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. * * @param request a request which can be sent to the service operation */ listAllConfigurationsResponses(request: requests.ListConfigurationsRequest): AsyncIterableIterator; /** * 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. * * @param request a request which can be sent to the service operation */ listConfigurationsRecordIterator(request: requests.ListConfigurationsRequest): AsyncIterableIterator; /** * 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. * * @param request a request which can be sent to the service operation */ listConfigurationsResponseIterator(request: requests.ListConfigurationsRequest): AsyncIterableIterator; /** * 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. * @param ListShapesRequest * @return ListShapesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/ListShapes.ts.html |here} to see how to use ListShapes API. */ listShapes(listShapesRequest: requests.ListShapesRequest): Promise; /** * 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. * @param ListVersionsRequest * @return ListVersionsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/ListVersions.ts.html |here} to see how to use ListVersions API. */ listVersions(listVersionsRequest: requests.ListVersionsRequest): Promise; /** * Updates the Configuration details. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param UpdateConfigurationRequest * @return UpdateConfigurationResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/UpdateConfiguration.ts.html |here} to see how to use UpdateConfiguration API. */ updateConfiguration(updateConfigurationRequest: requests.UpdateConfigurationRequest): Promise; } export declare enum ReplicasApiKeys { } /** * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user. */ export declare class ReplicasClient { protected static serviceEndpointTemplate: string; protected static endpointServiceName: string; protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined; protected "_endpoint": string; protected "_defaultHeaders": any; protected "_waiters": ReplicasWaiter; protected "_clientConfiguration": common.ClientConfiguration; protected _circuitBreaker: typeof Breaker | null; protected _httpOptions: any; protected _bodyDuplexMode: any; targetService: string; protected _regionId: string; protected "_region": common.Region; protected _lastSetRegionOrRegionId: string; protected _httpClient: common.HttpClient; protected _authProvider: common.AuthenticationDetailsProvider | undefined; constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration); /** * Get the endpoint that is being used to call (ex, https://www.example.com). */ get endpoint(): string; /** * Sets the endpoint to call (ex, https://www.example.com). * @param endpoint The endpoint of the service. */ set endpoint(endpoint: string); get logger(): import("oci-common/lib/log").Logger; /** * 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" * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template */ set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean); /** * Sets the region to call (ex, Region.US_PHOENIX_1). * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint. * @param region The region of the service. */ set region(region: common.Region); /** * 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}. * @param regionId The public region ID. */ set regionId(regionId: string); /** * Creates a new ReplicasWaiter for resources for this service. * * @param config The waiter configuration for termination and delay strategy * @return The service waiters. */ createWaiters(config?: common.WaiterConfiguration): ReplicasWaiter; /** * Gets the waiters available for resources for this service. * * @return The service waiters. */ getWaiters(): ReplicasWaiter; /** * Shutdown the circuit breaker used by the client when it is no longer needed */ shutdownCircuitBreaker(): void; /** * Close the provider if possible which in turn shuts down any associated circuit breaker */ closeProvider(): void; /** * Close the client once it is no longer needed */ close(): void; /** * Creates a DB System read replica. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param CreateReplicaRequest * @return CreateReplicaResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/CreateReplica.ts.html |here} to see how to use CreateReplica API. */ createReplica(createReplicaRequest: requests.CreateReplicaRequest): Promise; /** * Deletes the specified read replica. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param DeleteReplicaRequest * @return DeleteReplicaResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/DeleteReplica.ts.html |here} to see how to use DeleteReplica API. */ deleteReplica(deleteReplicaRequest: requests.DeleteReplicaRequest): Promise; /** * Gets the full details of the specified read replica. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetReplicaRequest * @return GetReplicaResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/GetReplica.ts.html |here} to see how to use GetReplica API. */ getReplica(getReplicaRequest: requests.GetReplicaRequest): Promise; /** * Lists all the read replicas that match the specified filters. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListReplicasRequest * @return ListReplicasResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/ListReplicas.ts.html |here} to see how to use ListReplicas API. */ listReplicas(listReplicasRequest: requests.ListReplicasRequest): Promise; /** * NOTE: This function is deprecated in favor of listReplicasRecordIterator function. * Creates a new async iterator which will iterate over the models.ReplicaSummary objects * contained in responses from the listReplicas operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllReplicas(request: requests.ListReplicasRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listReplicasResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listReplicas operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllReplicasResponses(request: requests.ListReplicasRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.ReplicaSummary objects * contained in responses from the listReplicas operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listReplicasRecordIterator(request: requests.ListReplicasRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listReplicas operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listReplicasResponseIterator(request: requests.ListReplicasRequest): AsyncIterableIterator; /** * Updates the properties of the specified read replica. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param UpdateReplicaRequest * @return UpdateReplicaResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/UpdateReplica.ts.html |here} to see how to use UpdateReplica API. */ updateReplica(updateReplicaRequest: requests.UpdateReplicaRequest): Promise; } export declare enum WorkRequestsApiKeys { } /** * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user. */ export declare class WorkRequestsClient { protected static serviceEndpointTemplate: string; protected static endpointServiceName: string; protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined; protected "_endpoint": string; protected "_defaultHeaders": any; protected "_waiters": WorkRequestsWaiter; protected "_clientConfiguration": common.ClientConfiguration; protected _circuitBreaker: typeof Breaker | null; protected _httpOptions: any; protected _bodyDuplexMode: any; targetService: string; protected _regionId: string; protected "_region": common.Region; protected _lastSetRegionOrRegionId: string; protected _httpClient: common.HttpClient; protected _authProvider: common.AuthenticationDetailsProvider | undefined; constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration); /** * Get the endpoint that is being used to call (ex, https://www.example.com). */ get endpoint(): string; /** * Sets the endpoint to call (ex, https://www.example.com). * @param endpoint The endpoint of the service. */ set endpoint(endpoint: string); get logger(): import("oci-common/lib/log").Logger; /** * 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" * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template */ set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean); /** * Sets the region to call (ex, Region.US_PHOENIX_1). * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint. * @param region The region of the service. */ set region(region: common.Region); /** * 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}. * @param regionId The public region ID. */ set regionId(regionId: string); /** * Creates a new WorkRequestsWaiter for resources for this service. * * @param config The waiter configuration for termination and delay strategy * @return The service waiters. */ createWaiters(config?: common.WaiterConfiguration): WorkRequestsWaiter; /** * Gets the waiters available for resources for this service. * * @return The service waiters. */ getWaiters(): WorkRequestsWaiter; /** * Shutdown the circuit breaker used by the client when it is no longer needed */ shutdownCircuitBreaker(): void; /** * Close the provider if possible which in turn shuts down any associated circuit breaker */ closeProvider(): void; /** * Close the client once it is no longer needed */ close(): void; /** * Cancels a work request. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param CancelWorkRequestRequest * @return CancelWorkRequestResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/CancelWorkRequest.ts.html |here} to see how to use CancelWorkRequest API. */ cancelWorkRequest(cancelWorkRequestRequest: requests.CancelWorkRequestRequest): Promise; /** * Gets the status of the work request with the given ID. * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetWorkRequestRequest * @return GetWorkRequestResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API. */ getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise; /** * Return a (paginated) list of errors for a given work request. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListWorkRequestErrorsRequest * @return ListWorkRequestErrorsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API. */ listWorkRequestErrors(listWorkRequestErrorsRequest: requests.ListWorkRequestErrorsRequest): Promise; /** * NOTE: This function is deprecated in favor of listWorkRequestErrorsRecordIterator function. * Creates a new async iterator which will iterate over the models.WorkRequestError objects * contained in responses from the listWorkRequestErrors operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllWorkRequestErrors(request: requests.ListWorkRequestErrorsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listWorkRequestErrorsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listWorkRequestErrors operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllWorkRequestErrorsResponses(request: requests.ListWorkRequestErrorsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.WorkRequestError objects * contained in responses from the listWorkRequestErrors operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listWorkRequestErrorsRecordIterator(request: requests.ListWorkRequestErrorsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listWorkRequestErrors operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listWorkRequestErrorsResponseIterator(request: requests.ListWorkRequestErrorsRequest): AsyncIterableIterator; /** * Return a (paginated) list of logs for a given work request. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListWorkRequestLogsRequest * @return ListWorkRequestLogsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API. */ listWorkRequestLogs(listWorkRequestLogsRequest: requests.ListWorkRequestLogsRequest): Promise; /** * NOTE: This function is deprecated in favor of listWorkRequestLogsRecordIterator function. * Creates a new async iterator which will iterate over the models.WorkRequestLogEntry objects * contained in responses from the listWorkRequestLogs operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllWorkRequestLogs(request: requests.ListWorkRequestLogsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listWorkRequestLogsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listWorkRequestLogs operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllWorkRequestLogsResponses(request: requests.ListWorkRequestLogsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.WorkRequestLogEntry objects * contained in responses from the listWorkRequestLogs operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listWorkRequestLogsRecordIterator(request: requests.ListWorkRequestLogsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listWorkRequestLogs operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listWorkRequestLogsResponseIterator(request: requests.ListWorkRequestLogsRequest): AsyncIterableIterator; /** * Lists the work requests in a specified compartment. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListWorkRequestsRequest * @return ListWorkRequestsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/mysql/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API. */ listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise; /** * NOTE: This function is deprecated in favor of listWorkRequestsRecordIterator function. * Creates a new async iterator which will iterate over the models.WorkRequestSummary objects * contained in responses from the listWorkRequests operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllWorkRequests(request: requests.ListWorkRequestsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listWorkRequestsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listWorkRequests operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllWorkRequestsResponses(request: requests.ListWorkRequestsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.WorkRequestSummary objects * contained in responses from the listWorkRequests operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listWorkRequestsRecordIterator(request: requests.ListWorkRequestsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listWorkRequests operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listWorkRequestsResponseIterator(request: requests.ListWorkRequestsRequest): AsyncIterableIterator; } export {};