Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GetMessagesRequest

example

Click here to see how to use GetMessagesRequest.

Hierarchy

Properties

Optional channelFilter

channelFilter: undefined | string

Optional parameter to filter the channels.

Optional limit

limit: undefined | number

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

Optional opcRequestId

opcRequestId: undefined | string

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

queueId

queueId: string

The unique queue identifier.

Optional retryConfiguration

retryConfiguration: RetryConfiguration

RetryConfiguration to be used for the request NOTE : Retries are not supported for requests that have binary or stream bodies this also affects UploadManager operations For all requests with binary/stream bodies, retry attempts are not made

Optional timeoutInSeconds

timeoutInSeconds: undefined | number

If the {@code 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 {@code 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.

Optional visibilityInSeconds

visibilityInSeconds: undefined | number

If the {@code visibilityInSeconds} parameter is set, messages will be hidden for {@code 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 {@code 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.