Constructor Detail

• StreamMessagesOptions.Builder

  public StreamMessagesOptions.Builder()

Method Detail

• queryParameters

  public static StreamMessagesOptions queryParameters(com.google.common.collect.Multimap<String,String> queryParams)

  See Also:

  PaginationOptions.queryParameters(Multimap)

• marker

  public static StreamMessagesOptions marker(String marker)

  Specifies an opaque string that the client can use to request the next batch of messages. The marker parameter communicates to the server which messages the client has already received. If you do not specify a value, the API returns all messages at the head of the queue (up to the limit).

  Clients should make no assumptions about the format or length of the marker. Furthermore, clients should assume that there is no relationship between markers and message IDs.

• limit

  public static StreamMessagesOptions limit(int limit)

  When more messages are available than can be returned in a single request, the client can pick up the next batch of messages by simply using the StremOptions returned from the previous call in MessageStream#nextStreamOptions(). Specifies up to 10 messages (the default value) to return. If you do not specify a value for the limit parameter, the default value of 10 is used.

• echo

  public static StreamMessagesOptions echo(boolean echo)

  The echo parameter determines whether the API returns a client's own messages, as determined by the clientId (UUID) portion of the client. If you do not specify a value, echo uses the default value of false. If you are experimenting with the API, you might want to set echo=true in order to see the messages that you posted.

• includeClaimed

  public static StreamMessagesOptions includeClaimed(boolean includeClaimed)

  The includeClaimed parameter determines whether the API returns claimed messages.