ListAnnouncementsRequest (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.requests.BmcRequest<Void>
- - com.oracle.bmc.announcementsservice.requests.ListAnnouncementsRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 0.0.1")
public class ListAnnouncementsRequest
extends BmcRequest<Void>

Example: Click here to see how to use ListAnnouncementsRequest.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ListAnnouncementsRequest.Builder`
`static class`	`ListAnnouncementsRequest.LifecycleState` The announcement’s current lifecycle state.
`static class`	`ListAnnouncementsRequest.PlatformType` A filter to return only announcements affecting a specific platform.
`static class`	`ListAnnouncementsRequest.SortBy` The criteria to sort by.
`static class`	`ListAnnouncementsRequest.SortOrder` The sort order to use.

Constructor Summary

Constructors
Constructor and Description

ListAnnouncementsRequest()

Constructors
Constructor and Description
`ListAnnouncementsRequest()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ListAnnouncementsRequest.Builder`	`builder()` Return a new builder for this request object.
`boolean`	`equals(Object o)` Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
`String`	`getAnnouncementType()` The type of announcement.
`String`	`getChainId()` A filter to return only announcements belonging to the specified announcement chain ID.
`String`	`getCompartmentId()` The OCID of the compartment.
`String`	`getEnvironmentName()` A filter to return only announcements that match a specific environment name.
`List<String>`	`getExcludeAnnouncementTypes()` Exclude The type of announcement.
`Boolean`	`getIsBanner()` Whether the announcement is displayed as a console banner.
`ListAnnouncementsRequest.LifecycleState`	`getLifecycleState()` The announcement’s current lifecycle state.
`Integer`	`getLimit()` The maximum number of items to return in a paginated “List” call.
`String`	`getOpcRequestId()` The unique Oracle-assigned identifier for the request.
`String`	`getPage()` The value of the `opc-next-page` response header from the previous “List” call.
`ListAnnouncementsRequest.PlatformType`	`getPlatformType()` A filter to return only announcements affecting a specific platform.
`String`	`getService()` A filter to return only announcements affecting a specific service.
`Boolean`	`getShouldShowOnlyLatestInChain()` A filter to display only the latest announcement in a chain.
`ListAnnouncementsRequest.SortBy`	`getSortBy()` The criteria to sort by.
`ListAnnouncementsRequest.SortOrder`	`getSortOrder()` The sort order to use.
`Date`	`getTimeOneEarliestTime()` The boundary for the earliest `timeOneValue` date on announcements that you want to see.
`Date`	`getTimeOneLatestTime()` The boundary for the latest `timeOneValue` date on announcements that you want to see.
`int`	`hashCode()` Uses getInvocationCallback and getRetryConfiguration to generate a hash.
`ListAnnouncementsRequest.Builder`	`toBuilder()` Return an instance of `ListAnnouncementsRequest.Builder` that allows you to modify request properties.
`String`	`toString()`

Methods inherited from class com.oracle.bmc.requests.BmcRequest
getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ListAnnouncementsRequest
```
public ListAnnouncementsRequest()
```
- Method Detail
  - getCompartmentId
```
public String getCompartmentId()
```
    The OCID of the compartment.
  - getLimit
```
public Integer getLimit()
```
    The maximum number of items to return in a paginated “List” call.
  - getPage
```
public String getPage()
```
    The value of the opc-next-page response header from the previous “List” call.
  - getAnnouncementType
```
public String getAnnouncementType()
```
    The type of announcement.
  - getLifecycleState
```
public ListAnnouncementsRequest.LifecycleState getLifecycleState()
```
    The announcement’s current lifecycle state.
  - getIsBanner
```
public Boolean getIsBanner()
```
    Whether the announcement is displayed as a console banner.
  - getSortBy
```
public ListAnnouncementsRequest.SortBy getSortBy()
```
    The criteria to sort by. You can specify only one sort order.
  - getSortOrder
```
public ListAnnouncementsRequest.SortOrder getSortOrder()
```
    The sort order to use. (Sorting by announcementType orders the announcements list according to importance.)
  - getTimeOneEarliestTime
```
public Date getTimeOneEarliestTime()
```
    The boundary for the earliest timeOneValue date on announcements that you want to see.
  - getTimeOneLatestTime
```
public Date getTimeOneLatestTime()
```
    The boundary for the latest timeOneValue date on announcements that you want to see.
  - getEnvironmentName
```
public String getEnvironmentName()
```
    A filter to return only announcements that match a specific environment name.
  - getService
```
public String getService()
```
    A filter to return only announcements affecting a specific service.
  - getPlatformType
```
public ListAnnouncementsRequest.PlatformType getPlatformType()
```
    A filter to return only announcements affecting a specific platform.
  - getExcludeAnnouncementTypes
```
public List<String> getExcludeAnnouncementTypes()
```
    Exclude The type of announcement.
  - getShouldShowOnlyLatestInChain
```
public Boolean getShouldShowOnlyLatestInChain()
```
    A filter to display only the latest announcement in a chain.
  - getChainId
```
public String getChainId()
```
    A filter to return only announcements belonging to the specified announcement chain ID.
  - getOpcRequestId
```
public String getOpcRequestId()
```
    The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the complete request ID.
  - toBuilder
```
public ListAnnouncementsRequest.Builder toBuilder()
```
    Return an instance of ListAnnouncementsRequest.Builder that allows you to modify request properties.
    
    Returns:
    
    instance of ListAnnouncementsRequest.Builder that allows you to modify request properties.
  - builder
```
public static ListAnnouncementsRequest.Builder builder()
```
    Return a new builder for this request object.
    
    Returns:
    
    builder for the request object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Description copied from class: BmcRequest
    
    Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
    
    Overrides:
    
    equals in class BmcRequest<Void>
  - hashCode
```
public int hashCode()
```
    Description copied from class: BmcRequest
    
    Uses getInvocationCallback and getRetryConfiguration to generate a hash.
    
    Overrides:
    
    hashCode in class BmcRequest<Void>

Class ListAnnouncementsRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.requests.BmcRequest

Methods inherited from class java.lang.Object

Constructor Detail

ListAnnouncementsRequest

Method Detail

getCompartmentId

getLimit

getPage

getAnnouncementType

getLifecycleState

getIsBanner

getSortBy

getSortOrder

getTimeOneEarliestTime

getTimeOneLatestTime

getEnvironmentName

getService

getPlatformType

getExcludeAnnouncementTypes

getShouldShowOnlyLatestInChain

getChainId

getOpcRequestId

toBuilder

builder

toString

equals

hashCode