AnnouncementSummary¶
-
class
oci.announcements_service.models.
AnnouncementSummary
(**kwargs)¶ Bases:
oci.announcements_service.models.base_announcement.BaseAnnouncement
Summary representation of an announcement.
Attributes
ANNOUNCEMENT_TYPE_ACTION_RECOMMENDED
str(object=’’) -> str ANNOUNCEMENT_TYPE_ACTION_REQUIRED
str(object=’’) -> str ANNOUNCEMENT_TYPE_EMERGENCY_CHANGE
str(object=’’) -> str ANNOUNCEMENT_TYPE_EMERGENCY_MAINTENANCE
str(object=’’) -> str ANNOUNCEMENT_TYPE_EMERGENCY_MAINTENANCE_COMPLETE
str(object=’’) -> str ANNOUNCEMENT_TYPE_EMERGENCY_MAINTENANCE_EXTENDED
str(object=’’) -> str ANNOUNCEMENT_TYPE_EMERGENCY_MAINTENANCE_RESCHEDULED
str(object=’’) -> str ANNOUNCEMENT_TYPE_INFORMATION
str(object=’’) -> str ANNOUNCEMENT_TYPE_PLANNED_CHANGE
str(object=’’) -> str ANNOUNCEMENT_TYPE_PLANNED_CHANGE_COMPLETE
str(object=’’) -> str ANNOUNCEMENT_TYPE_PLANNED_CHANGE_EXTENDED
str(object=’’) -> str ANNOUNCEMENT_TYPE_PLANNED_CHANGE_RESCHEDULED
str(object=’’) -> str ANNOUNCEMENT_TYPE_PRODUCTION_EVENT_NOTIFICATION
str(object=’’) -> str ANNOUNCEMENT_TYPE_SCHEDULED_MAINTENANCE
str(object=’’) -> str LIFECYCLE_STATE_ACTIVE
str(object=’’) -> str LIFECYCLE_STATE_INACTIVE
str(object=’’) -> str affected_regions
[Required] Gets the affected_regions of this BaseAnnouncement. announcement_type
[Required] Gets the announcement_type of this BaseAnnouncement. id
[Required] Gets the id of this BaseAnnouncement. is_banner
[Required] Gets the is_banner of this BaseAnnouncement. lifecycle_state
[Required] Gets the lifecycle_state of this BaseAnnouncement. reference_ticket_number
[Required] Gets the reference_ticket_number of this BaseAnnouncement. services
[Required] Gets the services of this BaseAnnouncement. summary
[Required] Gets the summary of this BaseAnnouncement. time_created
Gets the time_created of this BaseAnnouncement. time_one_title
Gets the time_one_title of this BaseAnnouncement. time_one_value
Gets the time_one_value of this BaseAnnouncement. time_two_title
Gets the time_two_title of this BaseAnnouncement. time_two_value
Gets the time_two_value of this BaseAnnouncement. time_updated
Gets the time_updated of this BaseAnnouncement. type
[Required] Gets the type of this BaseAnnouncement. Methods
__init__
(**kwargs)Initializes a new AnnouncementSummary object with values from keyword arguments. get_subtype
(object_dictionary)Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype. -
ANNOUNCEMENT_TYPE_ACTION_RECOMMENDED
= 'ACTION_RECOMMENDED'¶
-
ANNOUNCEMENT_TYPE_ACTION_REQUIRED
= 'ACTION_REQUIRED'¶
-
ANNOUNCEMENT_TYPE_EMERGENCY_CHANGE
= 'EMERGENCY_CHANGE'¶
-
ANNOUNCEMENT_TYPE_EMERGENCY_MAINTENANCE
= 'EMERGENCY_MAINTENANCE'¶
-
ANNOUNCEMENT_TYPE_EMERGENCY_MAINTENANCE_COMPLETE
= 'EMERGENCY_MAINTENANCE_COMPLETE'¶
-
ANNOUNCEMENT_TYPE_EMERGENCY_MAINTENANCE_EXTENDED
= 'EMERGENCY_MAINTENANCE_EXTENDED'¶
-
ANNOUNCEMENT_TYPE_EMERGENCY_MAINTENANCE_RESCHEDULED
= 'EMERGENCY_MAINTENANCE_RESCHEDULED'¶
-
ANNOUNCEMENT_TYPE_INFORMATION
= 'INFORMATION'¶
-
ANNOUNCEMENT_TYPE_PLANNED_CHANGE
= 'PLANNED_CHANGE'¶
-
ANNOUNCEMENT_TYPE_PLANNED_CHANGE_COMPLETE
= 'PLANNED_CHANGE_COMPLETE'¶
-
ANNOUNCEMENT_TYPE_PLANNED_CHANGE_EXTENDED
= 'PLANNED_CHANGE_EXTENDED'¶
-
ANNOUNCEMENT_TYPE_PLANNED_CHANGE_RESCHEDULED
= 'PLANNED_CHANGE_RESCHEDULED'¶
-
ANNOUNCEMENT_TYPE_PRODUCTION_EVENT_NOTIFICATION
= 'PRODUCTION_EVENT_NOTIFICATION'¶
-
ANNOUNCEMENT_TYPE_SCHEDULED_MAINTENANCE
= 'SCHEDULED_MAINTENANCE'¶
-
LIFECYCLE_STATE_ACTIVE
= 'ACTIVE'¶
-
LIFECYCLE_STATE_INACTIVE
= 'INACTIVE'¶
-
__init__
(**kwargs)¶ Initializes a new AnnouncementSummary object with values from keyword arguments. The default value of the
type
attribute of this class isAnnouncementSummary
and it should not be changed. 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 AnnouncementSummary.
- type (str) – The value to assign to the type property of this AnnouncementSummary.
- reference_ticket_number (str) – The value to assign to the reference_ticket_number property of this AnnouncementSummary.
- summary (str) – The value to assign to the summary property of this AnnouncementSummary.
- time_one_title (str) – The value to assign to the time_one_title property of this AnnouncementSummary.
- time_one_value (datetime) – The value to assign to the time_one_value property of this AnnouncementSummary.
- time_two_title (str) – The value to assign to the time_two_title property of this AnnouncementSummary.
- time_two_value (datetime) – The value to assign to the time_two_value property of this AnnouncementSummary.
- services (list[str]) – The value to assign to the services property of this AnnouncementSummary.
- affected_regions (list[str]) – The value to assign to the affected_regions property of this AnnouncementSummary.
- announcement_type (str) – The value to assign to the announcement_type property of this AnnouncementSummary. Allowed values for this property are: “ACTION_RECOMMENDED”, “ACTION_REQUIRED”, “EMERGENCY_CHANGE”, “EMERGENCY_MAINTENANCE”, “EMERGENCY_MAINTENANCE_COMPLETE”, “EMERGENCY_MAINTENANCE_EXTENDED”, “EMERGENCY_MAINTENANCE_RESCHEDULED”, “INFORMATION”, “PLANNED_CHANGE”, “PLANNED_CHANGE_COMPLETE”, “PLANNED_CHANGE_EXTENDED”, “PLANNED_CHANGE_RESCHEDULED”, “PRODUCTION_EVENT_NOTIFICATION”, “SCHEDULED_MAINTENANCE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- lifecycle_state (str) – The value to assign to the lifecycle_state property of this AnnouncementSummary. Allowed values for this property are: “ACTIVE”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- is_banner (bool) – The value to assign to the is_banner property of this AnnouncementSummary.
- time_created (datetime) – The value to assign to the time_created property of this AnnouncementSummary.
- time_updated (datetime) – The value to assign to the time_updated property of this AnnouncementSummary.
-
affected_regions
¶ [Required] Gets the affected_regions of this BaseAnnouncement. Impacted regions.
Returns: The affected_regions of this BaseAnnouncement. Return type: list[str]
-
announcement_type
¶ [Required] Gets the announcement_type of this BaseAnnouncement. The type of announcement. An announcement’s type signals its severity.
Allowed values for this property are: “ACTION_RECOMMENDED”, “ACTION_REQUIRED”, “EMERGENCY_CHANGE”, “EMERGENCY_MAINTENANCE”, “EMERGENCY_MAINTENANCE_COMPLETE”, “EMERGENCY_MAINTENANCE_EXTENDED”, “EMERGENCY_MAINTENANCE_RESCHEDULED”, “INFORMATION”, “PLANNED_CHANGE”, “PLANNED_CHANGE_COMPLETE”, “PLANNED_CHANGE_EXTENDED”, “PLANNED_CHANGE_RESCHEDULED”, “PRODUCTION_EVENT_NOTIFICATION”, “SCHEDULED_MAINTENANCE”
Returns: The announcement_type of this BaseAnnouncement. Return type: str
-
static
get_subtype
(object_dictionary)¶ Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
-
id
¶ [Required] Gets the id of this BaseAnnouncement. The OCID of the announcement.
Returns: The id of this BaseAnnouncement. Return type: str
[Required] Gets the is_banner of this BaseAnnouncement. Whether the announcement is displayed as a banner in the console.
Returns: The is_banner of this BaseAnnouncement. Return type: bool
-
lifecycle_state
¶ [Required] Gets the lifecycle_state of this BaseAnnouncement. The current lifecycle state of the announcement.
Allowed values for this property are: “ACTIVE”, “INACTIVE”
Returns: The lifecycle_state of this BaseAnnouncement. Return type: str
-
reference_ticket_number
¶ [Required] Gets the reference_ticket_number of this BaseAnnouncement. The reference Jira ticket number.
Returns: The reference_ticket_number of this BaseAnnouncement. Return type: str
-
services
¶ [Required] Gets the services of this BaseAnnouncement. Impacted Oracle Cloud Infrastructure services.
Returns: The services of this BaseAnnouncement. Return type: list[str]
-
summary
¶ [Required] Gets the summary of this BaseAnnouncement. A summary of the issue. A summary might appear in the console banner view of the announcement or in an email subject line. Avoid entering confidential information.
Returns: The summary of this BaseAnnouncement. Return type: str
-
time_created
¶ Gets the time_created of this BaseAnnouncement. The date and time the announcement was created, expressed in RFC 3339 timestamp format. Example: 2019-01-01T17:43:01.389+0000
Returns: The time_created of this BaseAnnouncement. Return type: datetime
-
time_one_title
¶ Gets the time_one_title of this BaseAnnouncement. The label associated with an initial time value. Example: Time Started
Returns: The time_one_title of this BaseAnnouncement. Return type: str
-
time_one_value
¶ Gets the time_one_value of this BaseAnnouncement. The actual value of the first time value for the event. Typically, this is the time an event started, but the meaning can vary, depending on the announcement type.
Returns: The time_one_value of this BaseAnnouncement. Return type: datetime
-
time_two_title
¶ Gets the time_two_title of this BaseAnnouncement. The label associated with a second time value. Example: Time Ended
Returns: The time_two_title of this BaseAnnouncement. Return type: str
-
time_two_value
¶ Gets the time_two_value of this BaseAnnouncement. The actual value of the second time value. Typically, this is the time an event ended, but the meaning can vary, depending on the announcement type.
Returns: The time_two_value of this BaseAnnouncement. Return type: datetime
-
time_updated
¶ Gets the time_updated of this BaseAnnouncement. The date and time the announcement was last updated, expressed in RFC 3339 timestamp format. Example: 2019-01-01T17:43:01.389+0000
Returns: The time_updated of this BaseAnnouncement. Return type: datetime
-
type
¶ [Required] Gets the type of this BaseAnnouncement. The entity type.
Returns: The type of this BaseAnnouncement. Return type: str
-