com.oracle.bmc.queue.requests

Class GetMessagesRequest

java.lang.Object

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

com.oracle.bmc.queue.requests.GetMessagesRequest

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

Example: Click here to see how to use GetMessagesRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetMessagesRequest.Builder

Constructor Summary

Constructors

Constructor and Description
GetMessagesRequest()

Method Summary

Modifier and Type	Method and Description
static GetMessagesRequest.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	getChannelFilter() Optional parameter to filter the channels.
Integer	getLimit() The limit parameter controls how many messages is returned at-most.
String	getOpcRequestId() Unique Oracle-assigned identifier for the request.
String	getQueueId() The unique queue identifier.
Integer	getTimeoutInSeconds() If the timeoutInSeconds parameter isn’t set or it is set to a value greater than 0, the request is using the long-polling mode and will only return when a message is available for consumption (it does not wait for limit messages but still only returns at-most limit messages) or after timeoutInSeconds seconds (in which case it will return an empty response), whichever comes first.
Integer	getVisibilityInSeconds() If the visibilityInSeconds parameter is set, messages will be hidden for visibilityInSeconds seconds and won’t be consumable by other consumers during that time.
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
GetMessagesRequest.Builder	toBuilder() Return an instance of GetMessagesRequest.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

GetMessagesRequest

public GetMessagesRequest()

Method Detail

getQueueId

public String getQueueId()

The unique queue identifier.

getVisibilityInSeconds

public Integer getVisibilityInSeconds()

If the visibilityInSeconds parameter is set, messages will be hidden for visibilityInSeconds seconds and won’t be consumable by other consumers during that time. If it isn’t set it defaults to the value set at the queue level.

Using a visibilityInSeconds value of 0 effectively acts as a peek functionality. Messages retrieved that way aren't meant to be deleted because they will most likely be delivered to another consumer as their visibility won't change, but will still increase the delivery count by one.

getTimeoutInSeconds

public Integer getTimeoutInSeconds()

If the timeoutInSeconds parameter isn’t set or it is set to a value greater than 0, the request is using the long-polling mode and will only return when a message is available for consumption (it does not wait for limit messages but still only returns at-most limit messages) or after timeoutInSeconds seconds (in which case it will return an empty response), whichever comes first.

If the parameter is set to 0, the request is using the short-polling mode and immediately returns whether messages have been retrieved or not. In same rare-cases a long-polling request could be interrupted (returned with empty response) before the end of the timeout.

getLimit

public Integer getLimit()

The limit parameter controls how many messages is returned at-most.

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.

getChannelFilter

public String getChannelFilter()

Optional parameter to filter the channels.

toBuilder

public GetMessagesRequest.Builder toBuilder()

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

Returns:

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

builder

public static GetMessagesRequest.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>