Package com.oracle.bmc.queue.requests

Class ListConsumerGroupsRequest.Builder

java.lang.Object

com.oracle.bmc.queue.requests.ListConsumerGroupsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListConsumerGroupsRequest,Void>

Enclosing class:

ListConsumerGroupsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListConsumerGroupsRequest	build()	Build the instance of ListConsumerGroupsRequest as configured by this builder
ListConsumerGroupsRequest	buildWithoutInvocationCallback()	Build the instance of ListConsumerGroupsRequest as configured by this builder
ListConsumerGroupsRequest.Builder	copy(ListConsumerGroupsRequest o)	Copy method to populate the builder with values from the given instance.
ListConsumerGroupsRequest.Builder	displayName(String displayName)	A filter to return only resources that match the entire display name given.
ListConsumerGroupsRequest.Builder	id(String id)	The unique consumer group identifier.
ListConsumerGroupsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListConsumerGroupsRequest.Builder	lifecycleState(ConsumerGroup.LifecycleState lifecycleState)	A filter to return only resources their lifecycleState matches the given lifecycleState.
ListConsumerGroupsRequest.Builder	limit(Integer limit)	For list pagination.
ListConsumerGroupsRequest.Builder	opcRequestId(String opcRequestId)	Unique Oracle-assigned identifier for the request.
ListConsumerGroupsRequest.Builder	page(String page)	For list pagination.
ListConsumerGroupsRequest.Builder	queueId(String queueId)	The unique queue identifier.
ListConsumerGroupsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListConsumerGroupsRequest.Builder	sortBy(ListConsumerGroupsRequest.SortBy sortBy)	The field to sort by.
ListConsumerGroupsRequest.Builder	sortOrder(SortOrder sortOrder)	The sort order to use, either ‘asc’ or ‘desc’.

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

lifecycleState

public ListConsumerGroupsRequest.Builder lifecycleState(ConsumerGroup.LifecycleState lifecycleState)

A filter to return only resources their lifecycleState matches the given lifecycleState.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

displayName

public ListConsumerGroupsRequest.Builder displayName(String displayName)

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

Parameters:

displayName - the value to set

Returns:

this builder instance

id

public ListConsumerGroupsRequest.Builder id(String id)

The unique consumer group identifier.

Parameters:

id - the value to set

Returns:

this builder instance

queueId

public ListConsumerGroupsRequest.Builder queueId(String queueId)

The unique queue identifier.

Parameters:

queueId - the value to set

Returns:

this builder instance

limit

public ListConsumerGroupsRequest.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

page

public ListConsumerGroupsRequest.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

sortOrder

public ListConsumerGroupsRequest.Builder sortOrder(SortOrder sortOrder)

The sort order to use, either ‘asc’ or ‘desc’.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListConsumerGroupsRequest.Builder sortBy(ListConsumerGroupsRequest.SortBy sortBy)

The field to sort by.

Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListConsumerGroupsRequest.Builder opcRequestId(String opcRequestId)

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

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

Specified by:

copy in interface BmcRequest.Builder<ListConsumerGroupsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListConsumerGroupsRequest build()

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

Returns:

instance of ListConsumerGroupsRequest

buildWithoutInvocationCallback

public ListConsumerGroupsRequest buildWithoutInvocationCallback()

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