Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListAnnouncementsRequest

example

Click here to see how to use ListAnnouncementsRequest.

Properties

Optional announcementType

announcementType: undefined | string

The type of announcement.

Optional chainId

chainId: undefined | string

A filter to return only announcements belonging to the specified announcement chain ID.

compartmentId

compartmentId: string

The OCID of the compartment.

Optional environmentName

environmentName: undefined | string

A filter to return only announcements that match a specific environment name.

Optional excludeAnnouncementTypes

excludeAnnouncementTypes: Array<string>

Exclude The type of announcement.

Optional isBanner

isBanner: undefined | false | true

Whether the announcement is displayed as a console banner.

Optional lifecycleState

lifecycleState: LifecycleState

The announcement's current lifecycle state.

Optional limit

limit: undefined | number

The maximum number of items to return in a paginated "List" call.

Optional opcRequestId

opcRequestId: undefined | string

The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the complete request ID.

Optional page

page: undefined | string

The value of the {@code opc-next-page} response header from the previous "List" call.

Optional platformType

platformType: PlatformType

A filter to return only announcements affecting a specific platform.

Optional retryConfiguration

retryConfiguration: RetryConfiguration

RetryConfiguration to be used for the request NOTE : Retries are not supported for requests that have binary or stream bodies this also affects UploadManager operations For all requests with binary/stream bodies, retry attempts are not made

Optional service

service: undefined | string

A filter to return only announcements affecting a specific service.

Optional shouldShowOnlyLatestInChain

shouldShowOnlyLatestInChain: undefined | false | true

A filter to display only the latest announcement in a chain.

Optional sortBy

sortBy: SortBy

The criteria to sort by. You can specify only one sort order.

Optional sortOrder

sortOrder: SortOrder

The sort order to use. (Sorting by {@code announcementType} orders the announcements list according to importance.)

Optional timeOneEarliestTime

timeOneEarliestTime: Date

The boundary for the earliest {@code timeOneValue} date on announcements that you want to see.

Optional timeOneLatestTime

timeOneLatestTime: Date

The boundary for the latest {@code timeOneValue} date on announcements that you want to see.