AnnouncementSubscription¶
-
class
oci.announcements_service.models.
AnnouncementSubscription
(**kwargs)¶ Bases:
object
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.
Attributes
LIFECYCLE_STATE_ACTIVE
A constant which can be used with the lifecycle_state property of a AnnouncementSubscription. LIFECYCLE_STATE_DELETED
A constant which can be used with the lifecycle_state property of a AnnouncementSubscription. LIFECYCLE_STATE_FAILED
A constant which can be used with the lifecycle_state property of a AnnouncementSubscription. compartment_id
[Required] Gets the compartment_id of this AnnouncementSubscription. defined_tags
[Required] Gets the defined_tags of this AnnouncementSubscription. description
Gets the description of this AnnouncementSubscription. display_name
[Required] Gets the display_name of this AnnouncementSubscription. filter_groups
Gets the filter_groups of this AnnouncementSubscription. freeform_tags
[Required] Gets the freeform_tags of this AnnouncementSubscription. id
[Required] Gets the id of this AnnouncementSubscription. lifecycle_details
Gets the lifecycle_details of this AnnouncementSubscription. lifecycle_state
[Required] Gets the lifecycle_state of this AnnouncementSubscription. ons_topic_id
[Required] Gets the ons_topic_id of this AnnouncementSubscription. system_tags
Gets the system_tags of this AnnouncementSubscription. time_created
[Required] Gets the time_created of this AnnouncementSubscription. time_updated
Gets the time_updated of this AnnouncementSubscription. Methods
__init__
(**kwargs)Initializes a new AnnouncementSubscription object with values from keyword arguments. -
LIFECYCLE_STATE_ACTIVE
= 'ACTIVE'¶ A constant which can be used with the lifecycle_state property of a AnnouncementSubscription. This constant has a value of “ACTIVE”
-
LIFECYCLE_STATE_DELETED
= 'DELETED'¶ A constant which can be used with the lifecycle_state property of a AnnouncementSubscription. This constant has a value of “DELETED”
-
LIFECYCLE_STATE_FAILED
= 'FAILED'¶ A constant which can be used with the lifecycle_state property of a AnnouncementSubscription. This constant has a value of “FAILED”
-
__init__
(**kwargs)¶ Initializes a new AnnouncementSubscription object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
Parameters: - id (str) – The value to assign to the id property of this AnnouncementSubscription.
- display_name (str) – The value to assign to the display_name property of this AnnouncementSubscription.
- description (str) – The value to assign to the description property of this AnnouncementSubscription.
- compartment_id (str) – The value to assign to the compartment_id property of this AnnouncementSubscription.
- time_created (datetime) – The value to assign to the time_created property of this AnnouncementSubscription.
- time_updated (datetime) – The value to assign to the time_updated property of this AnnouncementSubscription.
- lifecycle_state (str) – The value to assign to the lifecycle_state property of this AnnouncementSubscription. Allowed values for this property are: “ACTIVE”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- lifecycle_details (str) – The value to assign to the lifecycle_details property of this AnnouncementSubscription.
- ons_topic_id (str) – The value to assign to the ons_topic_id property of this AnnouncementSubscription.
- filter_groups (dict(str, FilterGroup)) – The value to assign to the filter_groups property of this AnnouncementSubscription.
- freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this AnnouncementSubscription.
- defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this AnnouncementSubscription.
- system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this AnnouncementSubscription.
-
compartment_id
¶ [Required] Gets the compartment_id of this AnnouncementSubscription. The OCID of the compartment that contains the announcement subscription.
Returns: The compartment_id of this AnnouncementSubscription. Return type: str
[Required] Gets the defined_tags of this AnnouncementSubscription. 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 AnnouncementSubscription. Return type: dict(str, dict(str, object))
-
description
¶ Gets the description of this AnnouncementSubscription. A description of the announcement subscription. Avoid entering confidential information.
Returns: The description of this AnnouncementSubscription. Return type: str
-
display_name
¶ [Required] Gets the display_name of this AnnouncementSubscription. 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 AnnouncementSubscription. Return type: str
-
filter_groups
¶ Gets the filter_groups of this AnnouncementSubscription. A list of filter groups for the announcement subscription. A filter group is a combination of multiple filters applied to announcements for matching purposes.
Returns: The filter_groups of this AnnouncementSubscription. Return type: dict(str, FilterGroup)
[Required] Gets the freeform_tags of this AnnouncementSubscription. 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 AnnouncementSubscription. Return type: dict(str, str)
-
id
¶ [Required] Gets the id of this AnnouncementSubscription. The OCID of the announcement subscription.
Returns: The id of this AnnouncementSubscription. Return type: str
-
lifecycle_details
¶ Gets the lifecycle_details of this AnnouncementSubscription. 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.
Returns: The lifecycle_details of this AnnouncementSubscription. Return type: str
-
lifecycle_state
¶ [Required] Gets the lifecycle_state of this AnnouncementSubscription. The current lifecycle state of the announcement subscription.
Allowed values for this property are: “ACTIVE”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
Returns: The lifecycle_state of this AnnouncementSubscription. Return type: str
-
ons_topic_id
¶ [Required] Gets the ons_topic_id of this AnnouncementSubscription. The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription.
Returns: The ons_topic_id of this AnnouncementSubscription. Return type: str
Gets the system_tags of this AnnouncementSubscription. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
Returns: The system_tags of this AnnouncementSubscription. Return type: dict(str, dict(str, object))
-