Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ChannelsClient

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

  • ChannelsClient

Constructors

constructor

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

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: ChannelsWaiter

targetService

targetService: string = "Channels"

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

createChannel

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

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateChannel API.

    Parameters

    Returns Promise<CreateChannelResponse>

    CreateChannelResponse

createWaiters

  • Creates a new ChannelsWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns ChannelsWaiter

    The service waiters.

deleteChannel

  • Deletes the specified Channel. 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 DeleteChannel API.

    Parameters

    Returns Promise<DeleteChannelResponse>

    DeleteChannelResponse

getChannel

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

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetChannel API.

    Parameters

    Returns Promise<GetChannelResponse>

    GetChannelResponse

getWaiters

listAllChannels

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

    Parameters

    Returns AsyncIterableIterator<ChannelSummary>

listAllChannelsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListChannelsResponse>

listChannels

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

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListChannels API.

    Parameters

    Returns Promise<ListChannelsResponse>

    ListChannelsResponse

listChannelsRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<ChannelSummary>

listChannelsResponseIterator

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

    Parameters

    Returns AsyncIterableIterator<ListChannelsResponse>

resetChannel

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

    throws

    OciError when an error occurs

    example

    Click here to see how to use ResetChannel API.

    Parameters

    Returns Promise<ResetChannelResponse>

    ResetChannelResponse

resumeChannel

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

    throws

    OciError when an error occurs

    example

    Click here to see how to use ResumeChannel API.

    Parameters

    Returns Promise<ResumeChannelResponse>

    ResumeChannelResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateChannel

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

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateChannel API.

    Parameters

    Returns Promise<UpdateChannelResponse>

    UpdateChannelResponse