com.netflix.conductor.core.events.queue

Interface ObservableQueue

All Known Implementing Classes:

DynoObservableQueue

public interface ObservableQueue

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	ack(java.util.List<Message> messages)
default void	close() Used to close queue instance prior to remove from queues
java.lang.String	getName()
java.lang.String	getType()
java.lang.String	getURI()
rx.Observable<Message>	observe()
void	publish(java.util.List<Message> messages)
default boolean	rePublishIfNoAck() Used to determine if the queue supports unack/visibility timeout such that the messages will re-appear on the queue after a specific period and are available to be picked up again and retried.
void	setUnackTimeout(Message message, long unackTimeout) Extend the lease of the unacknowledged message for longer period.
long	size()

Method Detail

observe

rx.Observable<Message> observe()

Returns:

An observable for the given queue

getType

java.lang.String getType()

Returns:

Type of the queue

getName

java.lang.String getName()

Returns:

Name of the queue

getURI

java.lang.String getURI()

Returns:

URI identifier for the queue.

ack

java.util.List<java.lang.String> ack(java.util.List<Message> messages)

Parameters:

messages - messages to be ack'ed

Returns:

the id of the ones which could not be ack'ed

publish

void publish(java.util.List<Message> messages)

Parameters:

messages - Messages to be published

rePublishIfNoAck

default boolean rePublishIfNoAck()

Used to determine if the queue supports unack/visibility timeout such that the messages will re-appear on the queue after a specific period and are available to be picked up again and retried.

Returns:

- false if the queue message need not be re-published to the queue for retriability - true if the message must be re-published to the queue for retriability

setUnackTimeout

void setUnackTimeout(Message message,
                     long unackTimeout)

Extend the lease of the unacknowledged message for longer period.

Parameters:

message - Message for which the timeout has to be changed

unackTimeout - timeout in milliseconds for which the unack lease should be extended. (replaces the current value with this value)

size

long size()

Returns:

Size of the queue - no. messages pending. Note: Depending upon the implementation, this can be an approximation

close

default void close()

Used to close queue instance prior to remove from queues