Package com.oracle.bmc.announcementsservice.requests

Class ListAnnouncementsRequest.Builder

java.lang.Object

com.oracle.bmc.announcementsservice.requests.ListAnnouncementsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListAnnouncementsRequest,Void>

Enclosing class:

ListAnnouncementsRequest

public static class ListAnnouncementsRequest.Builder
extends Object
implements BmcRequest.Builder<ListAnnouncementsRequest,Void>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListAnnouncementsRequest.Builder	announcementType(String announcementType)	The type of announcement.
ListAnnouncementsRequest	build()	Build the instance of ListAnnouncementsRequest as configured by this builder
ListAnnouncementsRequest	buildWithoutInvocationCallback()	Build the instance of ListAnnouncementsRequest as configured by this builder
ListAnnouncementsRequest.Builder	chainId(String chainId)	A filter to return only announcements belonging to the specified announcement chain ID.
ListAnnouncementsRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment.
ListAnnouncementsRequest.Builder	copy(ListAnnouncementsRequest o)	Copy method to populate the builder with values from the given instance.
ListAnnouncementsRequest.Builder	environmentName(String environmentName)	A filter to return only announcements that match a specific environment name.
ListAnnouncementsRequest.Builder	excludeAnnouncementTypes(String singularValue)	Singular setter.
ListAnnouncementsRequest.Builder	excludeAnnouncementTypes(List<String> excludeAnnouncementTypes)	Exclude The type of announcement.
ListAnnouncementsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListAnnouncementsRequest.Builder	isBanner(Boolean isBanner)	Whether the announcement is displayed as a console banner.
ListAnnouncementsRequest.Builder	lifecycleState(ListAnnouncementsRequest.LifecycleState lifecycleState)	The announcement’s current lifecycle state.
ListAnnouncementsRequest.Builder	limit(Integer limit)	The maximum number of items to return in a paginated “List” call.
ListAnnouncementsRequest.Builder	opcRequestId(String opcRequestId)	The unique Oracle-assigned identifier for the request.
ListAnnouncementsRequest.Builder	page(String page)	The value of the opc-next-page response header from the previous “List” call.
ListAnnouncementsRequest.Builder	platformType(ListAnnouncementsRequest.PlatformType platformType)	A filter to return only announcements affecting a specific platform.
ListAnnouncementsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListAnnouncementsRequest.Builder	service(String service)	A filter to return only announcements affecting a specific service.
ListAnnouncementsRequest.Builder	shouldShowOnlyLatestInChain(Boolean shouldShowOnlyLatestInChain)	A filter to display only the latest announcement in a chain.
ListAnnouncementsRequest.Builder	sortBy(ListAnnouncementsRequest.SortBy sortBy)	The criteria to sort by.
ListAnnouncementsRequest.Builder	sortOrder(ListAnnouncementsRequest.SortOrder sortOrder)	The sort order to use.
ListAnnouncementsRequest.Builder	timeOneEarliestTime(Date timeOneEarliestTime)	The boundary for the earliest timeOneValue date on announcements that you want to see.
ListAnnouncementsRequest.Builder	timeOneLatestTime(Date timeOneLatestTime)	The boundary for the latest timeOneValue date on announcements that you want to see.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder

body$

Constructor Detail

Builder

public Builder()

Method Detail

compartmentId

public ListAnnouncementsRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

limit

public ListAnnouncementsRequest.Builder limit(Integer limit)

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

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListAnnouncementsRequest.Builder page(String page)

The value of the opc-next-page response header from the previous “List” call.

Parameters:

page - the value to set

Returns:

this builder instance

announcementType

public ListAnnouncementsRequest.Builder announcementType(String announcementType)

The type of announcement.

Parameters:

announcementType - the value to set

Returns:

this builder instance

lifecycleState

public ListAnnouncementsRequest.Builder lifecycleState(ListAnnouncementsRequest.LifecycleState lifecycleState)

The announcement’s current lifecycle state.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

isBanner

public ListAnnouncementsRequest.Builder isBanner(Boolean isBanner)

Whether the announcement is displayed as a console banner.

Parameters:

isBanner - the value to set

Returns:

this builder instance

sortBy

public ListAnnouncementsRequest.Builder sortBy(ListAnnouncementsRequest.SortBy sortBy)

The criteria to sort by.

You can specify only one sort order.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListAnnouncementsRequest.Builder sortOrder(ListAnnouncementsRequest.SortOrder sortOrder)

The sort order to use.

(Sorting by announcementType orders the announcements list according to importance.)

Parameters:

sortOrder - the value to set

Returns:

this builder instance

timeOneEarliestTime

public ListAnnouncementsRequest.Builder timeOneEarliestTime(Date timeOneEarliestTime)

The boundary for the earliest timeOneValue date on announcements that you want to see.

Parameters:

timeOneEarliestTime - the value to set

Returns:

this builder instance

timeOneLatestTime

public ListAnnouncementsRequest.Builder timeOneLatestTime(Date timeOneLatestTime)

The boundary for the latest timeOneValue date on announcements that you want to see.

Parameters:

timeOneLatestTime - the value to set

Returns:

this builder instance

environmentName

public ListAnnouncementsRequest.Builder environmentName(String environmentName)

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

Parameters:

environmentName - the value to set

Returns:

this builder instance

service

public ListAnnouncementsRequest.Builder service(String service)

A filter to return only announcements affecting a specific service.

Parameters:

service - the value to set

Returns:

this builder instance

platformType

public ListAnnouncementsRequest.Builder platformType(ListAnnouncementsRequest.PlatformType platformType)

A filter to return only announcements affecting a specific platform.

Parameters:

platformType - the value to set

Returns:

this builder instance

excludeAnnouncementTypes

public ListAnnouncementsRequest.Builder excludeAnnouncementTypes(List<String> excludeAnnouncementTypes)

Exclude The type of announcement.

Parameters:

excludeAnnouncementTypes - the value to set

Returns:

this builder instance

excludeAnnouncementTypes

public ListAnnouncementsRequest.Builder excludeAnnouncementTypes(String singularValue)

Singular setter.

Exclude The type of announcement.

Parameters:

singularValue - the singular value to set

Returns:

this builder instance

shouldShowOnlyLatestInChain

public ListAnnouncementsRequest.Builder shouldShowOnlyLatestInChain(Boolean shouldShowOnlyLatestInChain)

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

Parameters:

shouldShowOnlyLatestInChain - the value to set

Returns:

this builder instance

chainId

public ListAnnouncementsRequest.Builder chainId(String chainId)

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

Parameters:

chainId - the value to set

Returns:

this builder instance

opcRequestId

public ListAnnouncementsRequest.Builder opcRequestId(String opcRequestId)

The unique Oracle-assigned identifier for the request.

If you need to contact Oracle about a particular request, please provide the complete request ID.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

public ListAnnouncementsRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)

Set the invocation callback for the request to be built.

Parameters:

invocationCallback - the invocation callback to be set for the request

Returns:

this builder instance

retryConfiguration

public ListAnnouncementsRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)

Set the retry configuration for the request to be built.

Parameters:

retryConfiguration - the retry configuration to be used for the request

Returns:

this builder instance

copy

public ListAnnouncementsRequest.Builder copy(ListAnnouncementsRequest o)

Copy method to populate the builder with values from the given instance.

Specified by:

copy in interface BmcRequest.Builder<ListAnnouncementsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListAnnouncementsRequest build()

Build the instance of ListAnnouncementsRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<ListAnnouncementsRequest,Void>

Returns:

instance of ListAnnouncementsRequest

buildWithoutInvocationCallback

public ListAnnouncementsRequest buildWithoutInvocationCallback()

Build the instance of ListAnnouncementsRequest as configured by this builder

Note that this method does not take calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method build() does

Returns:

instance of ListAnnouncementsRequest