Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotificationDataPlaneClient

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

  • NotificationDataPlaneClient

Constructors

constructor

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

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

targetService

targetService: string = "NotificationDataPlane"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://notification.{region}.{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

changeSubscriptionCompartment

close

  • close(): void

createSubscription

  • Creates a subscription for the specified topic and sends a subscription confirmation URL to the endpoint. The subscription remains in "Pending" status until it has been confirmed. For information about confirming subscriptions, see To confirm a subscription.

    Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateSubscription API.

    Parameters

    Returns Promise<CreateSubscriptionResponse>

    CreateSubscriptionResponse

createWaiters

  • Creates a new NotificationDataPlaneWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns NotificationDataPlaneWaiter

    The service waiters.

deleteSubscription

  • Deletes the specified subscription.

    Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteSubscription API.

    Parameters

    Returns Promise<DeleteSubscriptionResponse>

    DeleteSubscriptionResponse

getConfirmSubscription

  • Gets the confirmation details for the specified subscription.

    Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetConfirmSubscription API.

    Parameters

    Returns Promise<GetConfirmSubscriptionResponse>

    GetConfirmSubscriptionResponse

getSubscription

  • Gets the specified subscription's configuration information.

    Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetSubscription API.

    Parameters

    Returns Promise<GetSubscriptionResponse>

    GetSubscriptionResponse

getUnsubscription

  • Unsubscribes the subscription from the topic.

    Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetUnsubscription API.

    Parameters

    Returns Promise<GetUnsubscriptionResponse>

    GetUnsubscriptionResponse

getWaiters

listAllSubscriptions

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

    Parameters

    Returns AsyncIterableIterator<SubscriptionSummary>

listAllSubscriptionsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListSubscriptionsResponse>

listSubscriptions

  • Lists the subscriptions in the specified compartment or topic.

    Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSubscriptions API.

    Parameters

    Returns Promise<ListSubscriptionsResponse>

    ListSubscriptionsResponse

listSubscriptionsRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<SubscriptionSummary>

listSubscriptionsResponseIterator

publishMessage

  • Publishes a message to the specified topic.

    The topic endpoint is required for this operation. To get the topic endpoint, use {@link #getTopic(GetTopicRequest) getTopic} and review the `apiEndpoint` value in the response (NotificationTopic).

    Limits information follows.

    Message size limit per request: 64KB.

    Message delivery rate limit per endpoint: 60 messages per minute for HTTP-based protocols, 10 messages per minute for the `EMAIL` protocol. HTTP-based protocols use URL endpoints that begin with \"http:\" or \"https:\".

    Transactions Per Minute (TPM) per-tenancy limit for this operation: 60 per topic. (This TPM limit represents messages per minute.)

    For more information about publishing messages, see [Publishing Messages](https://docs.cloud.oracle.com/iaas/Content/Notification/Tasks/publishingmessages.htm). For steps to request a limit increase, see [Requesting a Service Limit Increase](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/servicelimits.htm#three).

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use PublishMessage API.

    Parameters

    Returns Promise<PublishMessageResponse>

    PublishMessageResponse

resendSubscriptionConfirmation

  • Resends the confirmation details for the specified subscription.

    Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ResendSubscriptionConfirmation API.

    Parameters

    Returns Promise<ResendSubscriptionConfirmationResponse>

    ResendSubscriptionConfirmationResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateSubscription

  • Updates the specified subscription's configuration.

    Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateSubscription API.

    Parameters

    Returns Promise<UpdateSubscriptionResponse>

    UpdateSubscriptionResponse