Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Announcement

A message about an impactful operational event.

Properties

Optional additionalInformation

additionalInformation: undefined | string

Additional information about the event, expressed by using Markdown language and included in the details view of an announcement. Additional information might include remediation steps or answers to frequently asked questions. Avoid entering confidential information.

affectedRegions

affectedRegions: Array<string>

Impacted regions.

Optional affectedResources

affectedResources: Array<AffectedResource>

The list of resources, if any, affected by the event described in the announcement.

announcementType

announcementType: AnnouncementType

The type of announcement. An announcement's type signals its severity.

Optional chainId

chainId: undefined | string

The sequence of connected announcements, or announcement chain, that this announcement belongs to. Related announcements share the same chain ID.

Optional description

description: undefined | string

A detailed explanation of the event, expressed by using Markdown language. Avoid entering confidential information.

Optional environmentName

environmentName: undefined | string

The name of the environment that this announcement pertains to.

id

id: string

The OCID of the announcement.

isBanner

isBanner: boolean

Whether the announcement is displayed as a banner in the console.

lifecycleState

lifecycleState: LifecycleState

The current lifecycle state of the announcement.

Optional platformType

platformType: PlatformType

The platform type that this announcement pertains to.

referenceTicketNumber

referenceTicketNumber: string

The reference Jira ticket number.

services

services: Array<string>

Impacted Oracle Cloud Infrastructure services.

summary

summary: string

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.

Optional timeCreated

timeCreated: Date

The date and time the announcement was created, expressed in RFC 3339 timestamp format. Example: {@code 2019-01-01T17:43:01.389+0000}

Optional timeOneTitle

timeOneTitle: undefined | string

The label associated with an initial time value. Example: {@code Time Started}

Optional timeOneType

timeOneType: TimeOneType

The type of a time associated with an initial time value. If the {@code timeOneTitle} attribute is present, then the {@code timeOneTitle} attribute contains a label of {@code timeOneType} in English. Example: {@code START_TIME}

Optional timeOneValue

timeOneValue: Date

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 {@code timeOneType} attribute describes the meaning.

Optional timeTwoTitle

timeTwoTitle: undefined | string

The label associated with a second time value. Example: {@code Time Ended}

Optional timeTwoType

timeTwoType: TimeTwoType

The type of a time associated with second time value. If the {@code timeTwoTitle} attribute is present, then the {@code timeTwoTitle} attribute contains a label of {@code timeTwoType} in English. Example: {@code END_TIME}

Optional timeTwoValue

timeTwoValue: Date

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 {@code timeTwoType} attribute describes the meaning.

Optional timeUpdated

timeUpdated: Date

The date and time the announcement was last updated, expressed in RFC 3339 timestamp format. Example: {@code 2019-01-01T17:43:01.389+0000}

Const type

type: string = "Announcement"

Methods

getDeserializedJsonObj

getJsonObj