CreateAnnouncementSubscriptionDetails¶

class oci.announcements_service.models.CreateAnnouncementSubscriptionDetails(**kwargs)¶

Bases: object

The details for creating a new announcement subscription.

Methods

__init__(**kwargs) Initializes a new CreateAnnouncementSubscriptionDetails object with values from keyword arguments.

Attributes

`compartment_id`	[Required] Gets the compartment_id of this CreateAnnouncementSubscriptionDetails.
`defined_tags`	Gets the defined_tags of this CreateAnnouncementSubscriptionDetails.
`description`	Gets the description of this CreateAnnouncementSubscriptionDetails.
`display_name`	[Required] Gets the display_name of this CreateAnnouncementSubscriptionDetails.
`filter_groups`	Gets the filter_groups of this CreateAnnouncementSubscriptionDetails.
`freeform_tags`	Gets the freeform_tags of this CreateAnnouncementSubscriptionDetails.
`ons_topic_id`	[Required] Gets the ons_topic_id of this CreateAnnouncementSubscriptionDetails.
`preferred_language`	Gets the preferred_language of this CreateAnnouncementSubscriptionDetails.
`preferred_time_zone`	Gets the preferred_time_zone of this CreateAnnouncementSubscriptionDetails.

__init__(**kwargs)¶

Initializes a new CreateAnnouncementSubscriptionDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

display_name (str) – The value to assign to the display_name property of this CreateAnnouncementSubscriptionDetails.
description (str) – The value to assign to the description property of this CreateAnnouncementSubscriptionDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateAnnouncementSubscriptionDetails.
ons_topic_id (str) – The value to assign to the ons_topic_id property of this CreateAnnouncementSubscriptionDetails.
filter_groups (dict(str, FilterGroupDetails)) – The value to assign to the filter_groups property of this CreateAnnouncementSubscriptionDetails.
preferred_language (str) – The value to assign to the preferred_language property of this CreateAnnouncementSubscriptionDetails.
preferred_time_zone (str) – The value to assign to the preferred_time_zone property of this CreateAnnouncementSubscriptionDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateAnnouncementSubscriptionDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateAnnouncementSubscriptionDetails.

compartment_id¶

[Required] Gets the compartment_id of this CreateAnnouncementSubscriptionDetails. The OCID of the compartment where you want to create the announcement subscription.

Returns:	The compartment_id of this CreateAnnouncementSubscriptionDetails.
Return type:	str

defined_tags¶

Gets the defined_tags of this CreateAnnouncementSubscriptionDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this CreateAnnouncementSubscriptionDetails.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this CreateAnnouncementSubscriptionDetails. A description of the announcement subscription. Avoid entering confidential information.

Returns:	The description of this CreateAnnouncementSubscriptionDetails.
Return type:	str

display_name¶

[Required] Gets the display_name of this CreateAnnouncementSubscriptionDetails. A user-friendly name for the announcement subscription. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:	The display_name of this CreateAnnouncementSubscriptionDetails.
Return type:	str

filter_groups¶

Gets the filter_groups of this CreateAnnouncementSubscriptionDetails. 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.

Returns:	The filter_groups of this CreateAnnouncementSubscriptionDetails.
Return type:	dict(str, FilterGroupDetails)

freeform_tags¶

Gets the freeform_tags of this CreateAnnouncementSubscriptionDetails. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this CreateAnnouncementSubscriptionDetails.
Return type:	dict(str, str)

ons_topic_id¶

[Required] Gets the ons_topic_id of this CreateAnnouncementSubscriptionDetails. 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.

Returns:	The ons_topic_id of this CreateAnnouncementSubscriptionDetails.
Return type:	str

preferred_language¶

Gets the preferred_language of this CreateAnnouncementSubscriptionDetails. (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.

Returns:	The preferred_language of this CreateAnnouncementSubscriptionDetails.
Return type:	str

preferred_time_zone¶

Gets the preferred_time_zone of this CreateAnnouncementSubscriptionDetails. 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

Returns:	The preferred_time_zone of this CreateAnnouncementSubscriptionDetails.
Return type:	str