Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateAnnouncementSubscriptionDetails

The details for creating a new announcement subscription.

Properties

compartmentId

compartmentId: string

The OCID of the compartment where you want to create the announcement subscription.

Optional definedTags

definedTags: undefined | object

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

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 combines one or more filters that the Announcements service applies to announcements for matching purposes.

Optional freeformTags

freeformTags: undefined | 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"}}

onsTopicId

onsTopicId: string

The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription. The caller of the operation needs the ONS_TOPIC_PUBLISH permission for the targeted Notifications service topic. For more information about Notifications permissions, see Details for Notifications.

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

Functions

getDeserializedJsonObj

getJsonObj