Class GetMessagesRequest

Inheritance

object

GetMessagesRequest

Implements

IOciRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.QueueService.Requests

Assembly: OCI.DotNetSDK.Queue.dll

Syntax

public class GetMessagesRequest : IOciRequest

Examples

Click here to see an example of how to use GetMessages request.

Properties

ChannelFilter

Declaration

[HttpConverter(TargetEnum.Query, "channelFilter")]
public string ChannelFilter { get; set; }

Property Value

Type	Description
string	Optional parameter to filter the channels.

Limit

Declaration

[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }

Property Value

Type	Description
int?	The limit parameter controls how many messages is returned at-most.

OpcRequestId

Declaration

[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }

Property Value

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

QueueId

Declaration

[Required(ErrorMessage = "QueueId is required.")]
[HttpConverter(TargetEnum.Path, "queueId")]
public string QueueId { get; set; }

Property Value

Type	Description
string	The unique queue identifier.

Remarks

Required

TimeoutInSeconds

Declaration

[HttpConverter(TargetEnum.Query, "timeoutInSeconds")]
public int? TimeoutInSeconds { get; set; }

Property Value

Type Description

Type	Description
int?	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.

int?

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.

VisibilityInSeconds

Declaration

[HttpConverter(TargetEnum.Query, "visibilityInSeconds")]
public int? VisibilityInSeconds { get; set; }

Property Value

Type Description

Type	Description
int?	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.

int?

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.

Implements

IOciRequest