Options
All
  • Public
  • Public/Protected
  • All
Menu

Module NotificationTopic

The properties that define a topic. For general information about topics, see Notifications Overview.

Properties

apiEndpoint

apiEndpoint: string

The endpoint for managing subscriptions or publishing messages to the topic.

compartmentId

compartmentId: string

The OCID of the compartment for the topic.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

Optional description

description: undefined | string

The description of the topic.

Optional etag

etag: undefined | string

For optimistic concurrency control. See if-match.

Optional freeformTags

freeformTags: undefined | object

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: `{\"Department\": \"Finance\"}`

lifecycleState

lifecycleState: LifecycleState

The lifecycle state of the topic.

name

name: string

The name of the topic.

timeCreated

timeCreated: Date

The time the topic was created.

topicId

topicId: string

The OCID of the topic.

Functions

getJsonObj