com.oracle.bmc.queue.requests

Class ListQueuesRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<Void>

com.oracle.bmc.queue.requests.ListQueuesRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210201")
public class ListQueuesRequest
extends BmcRequest<Void>

Example: Click here to see how to use ListQueuesRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListQueuesRequest.Builder
static class	ListQueuesRequest.SortBy The field to sort by.

Constructor Summary

Constructors

Constructor and Description
ListQueuesRequest()

Method Summary

Modifier and Type	Method and Description
static ListQueuesRequest.Builder	builder() Return a new builder for this request object.
boolean	equals(Object o) Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
String	getCompartmentId() The OCID of the compartment in which to list resources.
String	getDisplayName() A filter to return only resources that match the entire display name given.
String	getId() The unique queue identifier.
Queue.LifecycleState	getLifecycleState() A filter to return only resources their lifecycleState matches the given lifecycleState.
Integer	getLimit() For list pagination.
String	getOpcRequestId() Unique Oracle-assigned identifier for the request.
String	getPage() For list pagination.
ListQueuesRequest.SortBy	getSortBy() The field to sort by.
SortOrder	getSortOrder() The sort order to use, either ‘asc’ or ‘desc’.
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListQueuesRequest.Builder	toBuilder() Return an instance of ListQueuesRequest.Builder that allows you to modify request properties.
String	toString()

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListQueuesRequest

public ListQueuesRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

The OCID of the compartment in which to list resources.

getLifecycleState

public Queue.LifecycleState getLifecycleState()

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

getDisplayName

public String getDisplayName()

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

getId

public String getId()

The unique queue identifier.

getLimit

public Integer getLimit()

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.

getPage

public String getPage()

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.

getSortOrder

public SortOrder getSortOrder()

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

getSortBy

public ListQueuesRequest.SortBy getSortBy()

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.

getOpcRequestId

public String getOpcRequestId()

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

toBuilder

public ListQueuesRequest.Builder toBuilder()

Return an instance of ListQueuesRequest.Builder that allows you to modify request properties.

Returns:

instance of ListQueuesRequest.Builder that allows you to modify request properties.

builder

public static ListQueuesRequest.Builder builder()

Return a new builder for this request object.

Returns:

builder for the request object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.

Overrides:

equals in class BmcRequest<Void>

hashCode

public int hashCode()

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to generate a hash.

Overrides:

hashCode in class BmcRequest<Void>