BaseAnnouncement¶

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

Bases: object

Incident information that forms the basis of an announcement. Avoid entering confidential information.

Attributes

`ANNOUNCEMENT_TYPE_ACTION_RECOMMENDED`	A constant which can be used with the announcement_type property of a BaseAnnouncement.
`ANNOUNCEMENT_TYPE_ACTION_REQUIRED`	A constant which can be used with the announcement_type property of a BaseAnnouncement.
`ANNOUNCEMENT_TYPE_EMERGENCY_CHANGE`	A constant which can be used with the announcement_type property of a BaseAnnouncement.
`ANNOUNCEMENT_TYPE_EMERGENCY_MAINTENANCE`	A constant which can be used with the announcement_type property of a BaseAnnouncement.
`ANNOUNCEMENT_TYPE_EMERGENCY_MAINTENANCE_COMPLETE`	A constant which can be used with the announcement_type property of a BaseAnnouncement.
`ANNOUNCEMENT_TYPE_EMERGENCY_MAINTENANCE_EXTENDED`	A constant which can be used with the announcement_type property of a BaseAnnouncement.
`ANNOUNCEMENT_TYPE_EMERGENCY_MAINTENANCE_RESCHEDULED`	A constant which can be used with the announcement_type property of a BaseAnnouncement.
`ANNOUNCEMENT_TYPE_INFORMATION`	A constant which can be used with the announcement_type property of a BaseAnnouncement.
`ANNOUNCEMENT_TYPE_PLANNED_CHANGE`	A constant which can be used with the announcement_type property of a BaseAnnouncement.
`ANNOUNCEMENT_TYPE_PLANNED_CHANGE_COMPLETE`	A constant which can be used with the announcement_type property of a BaseAnnouncement.
`ANNOUNCEMENT_TYPE_PLANNED_CHANGE_EXTENDED`	A constant which can be used with the announcement_type property of a BaseAnnouncement.
`ANNOUNCEMENT_TYPE_PLANNED_CHANGE_RESCHEDULED`	A constant which can be used with the announcement_type property of a BaseAnnouncement.
`ANNOUNCEMENT_TYPE_PRODUCTION_EVENT_NOTIFICATION`	A constant which can be used with the announcement_type property of a BaseAnnouncement.
`ANNOUNCEMENT_TYPE_SCHEDULED_MAINTENANCE`	A constant which can be used with the announcement_type property of a BaseAnnouncement.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a BaseAnnouncement.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a BaseAnnouncement.
`PLATFORM_TYPE_IAAS`	A constant which can be used with the platform_type property of a BaseAnnouncement.
`PLATFORM_TYPE_SAAS`	A constant which can be used with the platform_type property of a BaseAnnouncement.
`TIME_ONE_TYPE_ACTION_REQUIRED_BY`	A constant which can be used with the time_one_type property of a BaseAnnouncement.
`TIME_ONE_TYPE_NEW_START_TIME`	A constant which can be used with the time_one_type property of a BaseAnnouncement.
`TIME_ONE_TYPE_ORIGINAL_END_TIME`	A constant which can be used with the time_one_type property of a BaseAnnouncement.
`TIME_ONE_TYPE_REPORT_DATE`	A constant which can be used with the time_one_type property of a BaseAnnouncement.
`TIME_ONE_TYPE_START_TIME`	A constant which can be used with the time_one_type property of a BaseAnnouncement.
`TIME_ONE_TYPE_TIME_DETECTED`	A constant which can be used with the time_one_type property of a BaseAnnouncement.
`TIME_TWO_TYPE_END_TIME`	A constant which can be used with the time_two_type property of a BaseAnnouncement.
`TIME_TWO_TYPE_NEW_END_TIME`	A constant which can be used with the time_two_type property of a BaseAnnouncement.
`affected_regions`	[Required] Gets the affected_regions of this BaseAnnouncement.
`announcement_type`	[Required] Gets the announcement_type of this BaseAnnouncement.
`environment_name`	Gets the environment_name 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.
`platform_type`	Gets the platform_type 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_type`	Gets the time_one_type 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_type`	Gets the time_two_type 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 BaseAnnouncement 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'¶: A constant which can be used with the announcement_type property of a BaseAnnouncement. This constant has a value of “ACTION_RECOMMENDED”

ANNOUNCEMENT_TYPE_ACTION_REQUIRED = 'ACTION_REQUIRED'¶: A constant which can be used with the announcement_type property of a BaseAnnouncement. This constant has a value of “ACTION_REQUIRED”

ANNOUNCEMENT_TYPE_EMERGENCY_CHANGE = 'EMERGENCY_CHANGE'¶: A constant which can be used with the announcement_type property of a BaseAnnouncement. This constant has a value of “EMERGENCY_CHANGE”

ANNOUNCEMENT_TYPE_EMERGENCY_MAINTENANCE = 'EMERGENCY_MAINTENANCE'¶: A constant which can be used with the announcement_type property of a BaseAnnouncement. This constant has a value of “EMERGENCY_MAINTENANCE”

ANNOUNCEMENT_TYPE_EMERGENCY_MAINTENANCE_COMPLETE = 'EMERGENCY_MAINTENANCE_COMPLETE'¶: A constant which can be used with the announcement_type property of a BaseAnnouncement. This constant has a value of “EMERGENCY_MAINTENANCE_COMPLETE”

ANNOUNCEMENT_TYPE_EMERGENCY_MAINTENANCE_EXTENDED = 'EMERGENCY_MAINTENANCE_EXTENDED'¶: A constant which can be used with the announcement_type property of a BaseAnnouncement. This constant has a value of “EMERGENCY_MAINTENANCE_EXTENDED”

ANNOUNCEMENT_TYPE_EMERGENCY_MAINTENANCE_RESCHEDULED = 'EMERGENCY_MAINTENANCE_RESCHEDULED'¶: A constant which can be used with the announcement_type property of a BaseAnnouncement. This constant has a value of “EMERGENCY_MAINTENANCE_RESCHEDULED”

ANNOUNCEMENT_TYPE_INFORMATION = 'INFORMATION'¶: A constant which can be used with the announcement_type property of a BaseAnnouncement. This constant has a value of “INFORMATION”

ANNOUNCEMENT_TYPE_PLANNED_CHANGE = 'PLANNED_CHANGE'¶: A constant which can be used with the announcement_type property of a BaseAnnouncement. This constant has a value of “PLANNED_CHANGE”

ANNOUNCEMENT_TYPE_PLANNED_CHANGE_COMPLETE = 'PLANNED_CHANGE_COMPLETE'¶: A constant which can be used with the announcement_type property of a BaseAnnouncement. This constant has a value of “PLANNED_CHANGE_COMPLETE”

ANNOUNCEMENT_TYPE_PLANNED_CHANGE_EXTENDED = 'PLANNED_CHANGE_EXTENDED'¶: A constant which can be used with the announcement_type property of a BaseAnnouncement. This constant has a value of “PLANNED_CHANGE_EXTENDED”

ANNOUNCEMENT_TYPE_PLANNED_CHANGE_RESCHEDULED = 'PLANNED_CHANGE_RESCHEDULED'¶: A constant which can be used with the announcement_type property of a BaseAnnouncement. This constant has a value of “PLANNED_CHANGE_RESCHEDULED”

ANNOUNCEMENT_TYPE_PRODUCTION_EVENT_NOTIFICATION = 'PRODUCTION_EVENT_NOTIFICATION'¶: A constant which can be used with the announcement_type property of a BaseAnnouncement. This constant has a value of “PRODUCTION_EVENT_NOTIFICATION”

ANNOUNCEMENT_TYPE_SCHEDULED_MAINTENANCE = 'SCHEDULED_MAINTENANCE'¶: A constant which can be used with the announcement_type property of a BaseAnnouncement. This constant has a value of “SCHEDULED_MAINTENANCE”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a BaseAnnouncement. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a BaseAnnouncement. This constant has a value of “INACTIVE”

PLATFORM_TYPE_IAAS = 'IAAS'¶: A constant which can be used with the platform_type property of a BaseAnnouncement. This constant has a value of “IAAS”

PLATFORM_TYPE_SAAS = 'SAAS'¶: A constant which can be used with the platform_type property of a BaseAnnouncement. This constant has a value of “SAAS”

TIME_ONE_TYPE_ACTION_REQUIRED_BY = 'ACTION_REQUIRED_BY'¶: A constant which can be used with the time_one_type property of a BaseAnnouncement. This constant has a value of “ACTION_REQUIRED_BY”

TIME_ONE_TYPE_NEW_START_TIME = 'NEW_START_TIME'¶: A constant which can be used with the time_one_type property of a BaseAnnouncement. This constant has a value of “NEW_START_TIME”

TIME_ONE_TYPE_ORIGINAL_END_TIME = 'ORIGINAL_END_TIME'¶: A constant which can be used with the time_one_type property of a BaseAnnouncement. This constant has a value of “ORIGINAL_END_TIME”

TIME_ONE_TYPE_REPORT_DATE = 'REPORT_DATE'¶: A constant which can be used with the time_one_type property of a BaseAnnouncement. This constant has a value of “REPORT_DATE”

TIME_ONE_TYPE_START_TIME = 'START_TIME'¶: A constant which can be used with the time_one_type property of a BaseAnnouncement. This constant has a value of “START_TIME”

TIME_ONE_TYPE_TIME_DETECTED = 'TIME_DETECTED'¶: A constant which can be used with the time_one_type property of a BaseAnnouncement. This constant has a value of “TIME_DETECTED”

TIME_TWO_TYPE_END_TIME = 'END_TIME'¶: A constant which can be used with the time_two_type property of a BaseAnnouncement. This constant has a value of “END_TIME”

TIME_TWO_TYPE_NEW_END_TIME = 'NEW_END_TIME'¶: A constant which can be used with the time_two_type property of a BaseAnnouncement. This constant has a value of “NEW_END_TIME”

__init__(**kwargs)¶

Initializes a new BaseAnnouncement object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

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 BaseAnnouncement.
type (str) – The value to assign to the type property of this BaseAnnouncement.
reference_ticket_number (str) – The value to assign to the reference_ticket_number property of this BaseAnnouncement.
summary (str) – The value to assign to the summary property of this BaseAnnouncement.
time_one_title (str) – The value to assign to the time_one_title property of this BaseAnnouncement.
time_one_type (str) – The value to assign to the time_one_type property of this BaseAnnouncement. Allowed values for this property are: “ACTION_REQUIRED_BY”, “NEW_START_TIME”, “ORIGINAL_END_TIME”, “REPORT_DATE”, “START_TIME”, “TIME_DETECTED”
time_one_value (datetime) – The value to assign to the time_one_value property of this BaseAnnouncement.
time_two_title (str) – The value to assign to the time_two_title property of this BaseAnnouncement.
time_two_type (str) – The value to assign to the time_two_type property of this BaseAnnouncement. Allowed values for this property are: “END_TIME”, “NEW_END_TIME”
time_two_value (datetime) – The value to assign to the time_two_value property of this BaseAnnouncement.
services (list[str]) – The value to assign to the services property of this BaseAnnouncement.
affected_regions (list[str]) – The value to assign to the affected_regions property of this BaseAnnouncement.
announcement_type (str) – The value to assign to the announcement_type property of this BaseAnnouncement. 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”
lifecycle_state (str) – The value to assign to the lifecycle_state property of this BaseAnnouncement. Allowed values for this property are: “ACTIVE”, “INACTIVE”
is_banner (bool) – The value to assign to the is_banner property of this BaseAnnouncement.
time_created (datetime) – The value to assign to the time_created property of this BaseAnnouncement.
time_updated (datetime) – The value to assign to the time_updated property of this BaseAnnouncement.
environment_name (str) – The value to assign to the environment_name property of this BaseAnnouncement.
platform_type (str) – The value to assign to the platform_type property of this BaseAnnouncement. Allowed values for this property are: “IAAS”, “SAAS”

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

environment_name¶

Gets the environment_name of this BaseAnnouncement. The name of the environment that this announcement pertains to.

Returns:	The environment_name 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

is_banner¶

[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

platform_type¶

Gets the platform_type of this BaseAnnouncement. The platform type that this announcement pertains to.

Allowed values for this property are: “IAAS”, “SAAS”

Returns:	The platform_type 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_type¶

Gets the time_one_type of this BaseAnnouncement. The type of a time associated with an initial time value. If the timeOneTitle attribute is present, then the timeOneTitle attribute contains a label of timeOneType in English. Example: START_TIME

Allowed values for this property are: “ACTION_REQUIRED_BY”, “NEW_START_TIME”, “ORIGINAL_END_TIME”, “REPORT_DATE”, “START_TIME”, “TIME_DETECTED”

Returns:	The time_one_type 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 denotes the time an event started, but the meaning can vary, depending on the announcement type. The timeOneType attribute describes the meaning.

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_type¶

Gets the time_two_type of this BaseAnnouncement. The type of a time associated with second time value. If the timeTwoTitle attribute is present, then the timeTwoTitle attribute contains a label of timeTwoType in English. Example: END_TIME

Allowed values for this property are: “END_TIME”, “NEW_END_TIME”

Returns:	The time_two_type 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 denotes the time an event ended, but the meaning can vary, depending on the announcement type. The timeTwoType attribute describes the meaning.

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, which is either an announcement or the summary representation of an announcement.

Returns:	The type of this BaseAnnouncement.
Return type:	str