Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace AnnouncementSubscription

A subscription with the Announcements service to receive selected announcements in the format and delivery mechanisms supported by a corresponding topic endpoint configured in the Oracle Cloud Infrastructure Notifications service.

Properties

compartmentId

compartmentId: string

The OCID of the compartment that contains the announcement subscription.

definedTags

definedTags: object

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

Type declaration

  • [key: string]: object
    • [key: string]: any

Optional description

description: undefined | string

A description of the announcement subscription. Avoid entering confidential information.

displayName

displayName: string

A user-friendly name for the announcement subscription. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Optional filterGroups

filterGroups: undefined | object

A list of filter groups for the announcement subscription. A filter group is a combination of multiple filters applied to announcements for matching purposes.

freeformTags

freeformTags: object

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}

Type declaration

  • [key: string]: string

id

id: string

The OCID of the announcement subscription.

Optional lifecycleDetails

lifecycleDetails: undefined | string

A message describing the current lifecycle state in more detail. For example, details might provide required or recommended actions for a resource in a Failed state.

lifecycleState

lifecycleState: LifecycleState

The current lifecycle state of the announcement subscription.

onsTopicId

onsTopicId: string

The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription.

Optional preferredLanguage

preferredLanguage: undefined | string

(For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the x-obmcs-human-language format. For example fr-FR.

Optional preferredTimeZone

preferredTimeZone: undefined | string

The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles

Optional systemTags

systemTags: undefined | object

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}}

timeCreated

timeCreated: Date

The date and time that the announcement subscription was created, expressed in RFC 3339 timestamp format.

Optional timeUpdated

timeUpdated: Date

The date and time that the announcement subscription was updated, expressed in RFC 3339 timestamp format.

Functions

getDeserializedJsonObj

getJsonObj