Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotificationControlPlaneClient

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

  • NotificationControlPlaneClient

Constructors

constructor

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 = ""

targetService

targetService: string = "NotificationControlPlane"

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

changeTopicCompartment

close

  • close(): void

createTopic

  • Creates a topic in the specified compartment. For general information about topics, see Managing Topics and Subscriptions.

    For the purposes of access control, you must provide the OCID of the compartment where you want the topic to reside. For information about access control and compartments, see [Overview of the IAM Service](https://docs.cloud.oracle.com/Content/Identity/Concepts/overview.htm).

    You must specify a display name for the topic.

    All Oracle Cloud Infrastructure resources, including topics, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console. For more information, see [Resource Identifiers](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).

    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 CreateTopic API.

    Parameters

    Returns Promise<CreateTopicResponse>

    CreateTopicResponse

deleteTopic

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

    Parameters

    Returns Promise<DeleteTopicResponse>

    DeleteTopicResponse

getTopic

  • Gets the specified topic's configuration information.

    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 GetTopic API.

    Parameters

    Returns Promise<GetTopicResponse>

    GetTopicResponse

listAllTopics

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

    Parameters

    Returns AsyncIterableIterator<NotificationTopicSummary>

listAllTopicsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListTopicsResponse>

listTopics

  • Lists topics in the specified compartment.

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

    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 ListTopics API.

    Parameters

    Returns Promise<ListTopicsResponse>

    ListTopicsResponse

listTopicsRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<NotificationTopicSummary>

listTopicsResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listTopics operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListTopicsResponse>

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateTopic

  • Updates the specified topic'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 UpdateTopic API.

    Parameters

    Returns Promise<UpdateTopicResponse>

    UpdateTopicResponse