Package com.oracle.bmc.ons.requests

Class ListTopicsRequest.Builder

java.lang.Object

com.oracle.bmc.ons.requests.ListTopicsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListTopicsRequest,Void>

Enclosing class:

ListTopicsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListTopicsRequest	build()	Build the instance of ListTopicsRequest as configured by this builder
ListTopicsRequest	buildWithoutInvocationCallback()	Build the instance of ListTopicsRequest as configured by this builder
ListTopicsRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment.
ListTopicsRequest.Builder	copy(ListTopicsRequest o)	Copy method to populate the builder with values from the given instance.
ListTopicsRequest.Builder	id(String id)	A filter to only return resources that match the given id exactly.
ListTopicsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListTopicsRequest.Builder	lifecycleState(NotificationTopicSummary.LifecycleState lifecycleState)	Filter returned list by specified lifecycle state.
ListTopicsRequest.Builder	limit(Integer limit)	For list pagination.
ListTopicsRequest.Builder	name(String name)	A filter to only return resources that match the given name exactly.
ListTopicsRequest.Builder	opcRequestId(String opcRequestId)	The unique Oracle-assigned identifier for the request.
ListTopicsRequest.Builder	page(String page)	For list pagination.
ListTopicsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListTopicsRequest.Builder	sortBy(ListTopicsRequest.SortBy sortBy)	The field to sort by.
ListTopicsRequest.Builder	sortOrder(ListTopicsRequest.SortOrder sortOrder)	The sort order to use (ascending or descending).

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 ListTopicsRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

id

public ListTopicsRequest.Builder id(String id)

A filter to only return resources that match the given id exactly.

Parameters:

id - the value to set

Returns:

this builder instance

name

public ListTopicsRequest.Builder name(String name)

A filter to only return resources that match the given name exactly.

Parameters:

name - the value to set

Returns:

this builder instance

page

public ListTopicsRequest.Builder page(String page)

For list pagination.

The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

Parameters:

page - the value to set

Returns:

this builder instance

limit

public ListTopicsRequest.Builder limit(Integer limit)

For list pagination.

The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

Parameters:

limit - the value to set

Returns:

this builder instance

sortBy

public ListTopicsRequest.Builder sortBy(ListTopicsRequest.SortBy sortBy)

The field to sort by.

Only one field can be selected for sorting.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListTopicsRequest.Builder sortOrder(ListTopicsRequest.SortOrder sortOrder)

The sort order to use (ascending or descending).

Parameters:

sortOrder - the value to set

Returns:

this builder instance

lifecycleState

public ListTopicsRequest.Builder lifecycleState(NotificationTopicSummary.LifecycleState lifecycleState)

Filter returned list by specified lifecycle state.

This parameter is case-insensitive.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

opcRequestId

public ListTopicsRequest.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 request ID.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

public ListTopicsRequest.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 ListTopicsRequest.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 ListTopicsRequest.Builder copy(ListTopicsRequest o)

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

Specified by:

copy in interface BmcRequest.Builder<ListTopicsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListTopicsRequest build()

Build the instance of ListTopicsRequest 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<ListTopicsRequest,Void>

Returns:

instance of ListTopicsRequest

buildWithoutInvocationCallback

public ListTopicsRequest buildWithoutInvocationCallback()

Build the instance of ListTopicsRequest 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 ListTopicsRequest