Package com.oracle.bmc.queue.requests

Class ListQueuesRequest.Builder

java.lang.Object

com.oracle.bmc.queue.requests.ListQueuesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListQueuesRequest,Void>

Enclosing class:

ListQueuesRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListQueuesRequest	build()	Build the instance of ListQueuesRequest as configured by this builder
ListQueuesRequest	buildWithoutInvocationCallback()	Build the instance of ListQueuesRequest as configured by this builder
ListQueuesRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment in which to list resources.
ListQueuesRequest.Builder	copy(ListQueuesRequest o)	Copy method to populate the builder with values from the given instance.
ListQueuesRequest.Builder	displayName(String displayName)	A filter to return only resources that match the entire display name given.
ListQueuesRequest.Builder	id(String id)	The unique queue identifier.
ListQueuesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListQueuesRequest.Builder	lifecycleState(Queue.LifecycleState lifecycleState)	A filter to return only resources their lifecycleState matches the given lifecycleState.
ListQueuesRequest.Builder	limit(Integer limit)	For list pagination.
ListQueuesRequest.Builder	opcRequestId(String opcRequestId)	Unique Oracle-assigned identifier for the request.
ListQueuesRequest.Builder	page(String page)	For list pagination.
ListQueuesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListQueuesRequest.Builder	sortBy(ListQueuesRequest.SortBy sortBy)	The field to sort by.
ListQueuesRequest.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

compartmentId

public ListQueuesRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment in which to list resources.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

lifecycleState

public ListQueuesRequest.Builder lifecycleState(Queue.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 ListQueuesRequest.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 ListQueuesRequest.Builder id(String id)

The unique queue identifier.

Parameters:

id - the value to set

Returns:

this builder instance

limit

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

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

Specified by:

copy in interface BmcRequest.Builder<ListQueuesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListQueuesRequest build()

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

Returns:

instance of ListQueuesRequest

buildWithoutInvocationCallback

public ListQueuesRequest buildWithoutInvocationCallback()

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