Package com.rabbitmq.client.amqp

Interface ConsumerBuilder.StreamOptions

Enclosing interface:

ConsumerBuilder

public static interface ConsumerBuilder.StreamOptions

Options for a consumer consuming from a stream.

See Also:

• Streams
• Stream Consumers

Method Summary

Modifier and Type	Method	Description
ConsumerBuilder	builder()	Return the consumer builder.
ConsumerBuilder.StreamFilterOptions	filter()	Options for AMQP filter expressions.
ConsumerBuilder.StreamOptions	filterMatchUnfiltered(boolean matchUnfiltered)	Whether messages without a filter value should be sent.
ConsumerBuilder.StreamOptions	filterValues(String... values)	Filter values for stream filtering.
ConsumerBuilder.StreamOptions	offset(long offset)	The offset to start consuming from.
ConsumerBuilder.StreamOptions	offset(ConsumerBuilder.StreamOffsetSpecification specification)	The offset to start consuming from.
ConsumerBuilder.StreamOptions	offset(String interval)	The offset to start consuming from as an interval string value.
ConsumerBuilder.StreamOptions	offset(Instant timestamp)	A point in time to start consuming from.

Method Details

offset

ConsumerBuilder.StreamOptions offset(long offset)

The offset to start consuming from.

Parameters:

offset - offset

Returns:

stream options

offset

ConsumerBuilder.StreamOptions offset(Instant timestamp)

A point in time to start consuming from.

Be aware consumers can receive messages published a bit before the specified timestamp.

Parameters:

timestamp - the timestamp

Returns:

stream options

offset

ConsumerBuilder.StreamOptions offset(ConsumerBuilder.StreamOffsetSpecification specification)

The offset to start consuming from.

Parameters:

specification - offset specification

Returns:

stream options

See Also:

• ConsumerBuilder.StreamOffsetSpecification

offset

ConsumerBuilder.StreamOptions offset(String interval)

The offset to start consuming from as an interval string value.

Valid units are Y, M, D, h, m, s. Examples: 7D (7 days), 12h (12 hours).

Parameters:

interval - the interval

Returns:

stream options

See Also:

• Interval Syntax

filterValues

ConsumerBuilder.StreamOptions filterValues(String... values)

Filter values for stream filtering.

This a different filtering mechanism from AMQP filter expressions. Both mechanisms can be used together.

Parameters:

values - filter values

Returns:

stream options

See Also:

• Stream Filtering
• filter()

filterMatchUnfiltered

ConsumerBuilder.StreamOptions filterMatchUnfiltered(boolean matchUnfiltered)

Whether messages without a filter value should be sent.

Default is false (messages without a filter value are not sent).

This a different filtering mechanism from AMQP filter expressions. Both mechanisms can be used together.

Parameters:

matchUnfiltered - true to send messages without a filter value

Returns:

stream options

See Also:

• filter()

filter

ConsumerBuilder.StreamFilterOptions filter()

Options for AMQP filter expressions.

Requires RabbitMQ 4.1 or more.

This a different filtering mechanism from stream filtering. Both mechanisms can be used together.

Returns:

the filter options

See Also:

• filterValues(String...)
• filterMatchUnfiltered(boolean)

builder

ConsumerBuilder builder()

Return the consumer builder.

Returns:

the consumer builder