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>

Method Summary

Modifier and Type	Method and Description
ListAnnouncementsRequest.Builder	announcementType(String announcementType) The type of announcement.
ListAnnouncementsRequest	build() Build the instance of ListAnnouncementsRequest as configured by this builder
ListAnnouncementsRequest	buildWithoutInvocationCallback()
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(List<String> excludeAnnouncementTypes) Exclude The type of announcement.
ListAnnouncementsRequest.Builder	excludeAnnouncementTypes(String singularValue) Singular setter.
ListAnnouncementsRequest.Builder	invocationCallback(Consumer<javax.ws.rs.client.Invocation.Builder> 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	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.
String	toString()

Methods inherited from class java.lang.Object

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

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

body$

Method Detail

excludeAnnouncementTypes

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

Exclude The type of announcement.

Returns:

this builder instance

excludeAnnouncementTypes

public ListAnnouncementsRequest.Builder excludeAnnouncementTypes(String singularValue)

Singular setter. Exclude The type of announcement.

Returns:

this builder instance

invocationCallback

public ListAnnouncementsRequest.Builder invocationCallback(Consumer<javax.ws.rs.client.Invocation.Builder> 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.util.internal.Consumer) 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

compartmentId

public ListAnnouncementsRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment.

Returns:

this.

limit

public ListAnnouncementsRequest.Builder limit(Integer limit)

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

Returns:

this.

page

public ListAnnouncementsRequest.Builder page(String page)

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

Returns:

this.

announcementType

public ListAnnouncementsRequest.Builder announcementType(String announcementType)

The type of announcement.

Returns:

this.

lifecycleState

public ListAnnouncementsRequest.Builder lifecycleState(ListAnnouncementsRequest.LifecycleState lifecycleState)

The announcement’s current lifecycle state.

Returns:

this.

isBanner

public ListAnnouncementsRequest.Builder isBanner(Boolean isBanner)

Whether the announcement is displayed as a console banner.

Returns:

this.

sortBy

public ListAnnouncementsRequest.Builder sortBy(ListAnnouncementsRequest.SortBy sortBy)

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

Returns:

this.

sortOrder

public ListAnnouncementsRequest.Builder sortOrder(ListAnnouncementsRequest.SortOrder sortOrder)

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

Returns:

this.

timeOneEarliestTime

public ListAnnouncementsRequest.Builder timeOneEarliestTime(Date timeOneEarliestTime)

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

Returns:

this.

timeOneLatestTime

public ListAnnouncementsRequest.Builder timeOneLatestTime(Date timeOneLatestTime)

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

Returns:

this.

environmentName

public ListAnnouncementsRequest.Builder environmentName(String environmentName)

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

Returns:

this.

service

public ListAnnouncementsRequest.Builder service(String service)

A filter to return only announcements affecting a specific service.

Returns:

this.

platformType

public ListAnnouncementsRequest.Builder platformType(ListAnnouncementsRequest.PlatformType platformType)

A filter to return only announcements affecting a specific platform.

Returns:

this.

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.

Returns:

this.

buildWithoutInvocationCallback

public ListAnnouncementsRequest buildWithoutInvocationCallback()

toString

public String toString()

Overrides:

toString in class Object