Package com.oracle.bmc.queue.requests

Class GetMessagesRequest.Builder

java.lang.Object

com.oracle.bmc.queue.requests.GetMessagesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<GetMessagesRequest,Void>

Enclosing class:

GetMessagesRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetMessagesRequest	build()	Build the instance of GetMessagesRequest as configured by this builder
GetMessagesRequest	buildWithoutInvocationCallback()	Build the instance of GetMessagesRequest as configured by this builder
GetMessagesRequest.Builder	channelFilter(String channelFilter)	Optional parameter to filter the channels.
GetMessagesRequest.Builder	copy(GetMessagesRequest o)	Copy method to populate the builder with values from the given instance.
GetMessagesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
GetMessagesRequest.Builder	limit(Integer limit)	The limit parameter controls how many messages is returned at-most.
GetMessagesRequest.Builder	opcRequestId(String opcRequestId)	Unique Oracle-assigned identifier for the request.
GetMessagesRequest.Builder	queueId(String queueId)	The unique queue identifier.
GetMessagesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
GetMessagesRequest.Builder	timeoutInSeconds(Integer timeoutInSeconds)	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.
GetMessagesRequest.Builder	visibilityInSeconds(Integer visibilityInSeconds)	If the visibilityInSeconds parameter is set, messages will be hidden for visibilityInSeconds seconds and won’t be consumable by other consumers during that time.

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

queueId

public GetMessagesRequest.Builder queueId(String queueId)

The unique queue identifier.

Parameters:

queueId - the value to set

Returns:

this builder instance

visibilityInSeconds

public GetMessagesRequest.Builder visibilityInSeconds(Integer visibilityInSeconds)

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.

Parameters:

visibilityInSeconds - the value to set

Returns:

this builder instance

timeoutInSeconds

public GetMessagesRequest.Builder timeoutInSeconds(Integer timeoutInSeconds)

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.

Parameters:

timeoutInSeconds - the value to set

Returns:

this builder instance

limit

public GetMessagesRequest.Builder limit(Integer limit)

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

Parameters:

limit - the value to set

Returns:

this builder instance

opcRequestId

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

channelFilter

public GetMessagesRequest.Builder channelFilter(String channelFilter)

Optional parameter to filter the channels.

Parameters:

channelFilter - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<GetMessagesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public GetMessagesRequest build()

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

Returns:

instance of GetMessagesRequest

buildWithoutInvocationCallback

public GetMessagesRequest buildWithoutInvocationCallback()

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