com.netflix.ribbon

Interface RibbonRequest<T>

public interface RibbonRequest<T>

Request that provides blocking and non-blocking APIs to fetch the content.

Method Summary

Modifier and Type	Method and Description
T	execute() Blocking API that returns a single (or last element if there is a sequence of objects from the execution) element
rx.Observable<T>	observe() Non blocking API that returns an Observable while the execution is started asynchronously.
java.util.concurrent.Future<T>	queue() Non blocking API that returns a Future, where its Future.get() method is blocking and returns a single (or last element if there is a sequence of objects from the execution) element
rx.Observable<T>	toObservable() Non blocking API that returns an Observable.
RequestWithMetaData<T>	withMetadata() Create a decorated RequestWithMetaData where you can call its similar blocking or non blocking APIs to get RibbonResponse, which in turn contains returned object(s) and some meta data from Hystrix execution.

Method Detail

execute

T execute()

Blocking API that returns a single (or last element if there is a sequence of objects from the execution) element

queue

java.util.concurrent.Future<T> queue()

Non blocking API that returns a Future, where its Future.get() method is blocking and returns a single (or last element if there is a sequence of objects from the execution) element

observe

rx.Observable<T> observe()

Non blocking API that returns an Observable while the execution is started asynchronously. Subscribing to the returned Observable is guaranteed to get the complete sequence from the beginning, which might be replayed by the framework. Use this API for "fire and forget".

toObservable

rx.Observable<T> toObservable()

Non blocking API that returns an Observable. The execution is not started until the returned Observable is subscribed to.

withMetadata

RequestWithMetaData<T> withMetadata()

Create a decorated RequestWithMetaData where you can call its similar blocking or non blocking APIs to get RibbonResponse, which in turn contains returned object(s) and some meta data from Hystrix execution.