Package org.jclouds.openstack.marconi.v1.options

Class StreamMessagesOptions

java.lang.Object

org.jclouds.http.options.BaseHttpRequestOptions

org.jclouds.openstack.v2_0.options.PaginationOptions

org.jclouds.openstack.marconi.v1.options.StreamMessagesOptions

All Implemented Interfaces:

HttpRequestOptions

public class StreamMessagesOptions
extends PaginationOptions

Options used to control the messages returned in the response.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StreamMessagesOptions.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static StreamMessagesOptions	NONE

Fields inherited from class org.jclouds.http.options.BaseHttpRequestOptions

formParameters, headers, pathSuffix, payload, queryParameters

Constructor Summary

Constructors

Constructor	Description
StreamMessagesOptions()

Method Summary

Modifier and Type	Method	Description
StreamMessagesOptions	echo(boolean echo)
String	getMarker()
StreamMessagesOptions	includeClaimed(boolean includeClaimed)
StreamMessagesOptions	limit(int limit)	To reduce load on the service, list operations will return a maximum of 1,000 items at a time.
StreamMessagesOptions	marker(String marker)	The marker parameter is the ID of the last item in the previous list.
StreamMessagesOptions	queryParameters(com.google.common.collect.Multimap<String,String> queryParams)	Many OpenStack interfaces take different params for pagination.

Methods inherited from class org.jclouds.openstack.v2_0.options.PaginationOptions

changesSince

Methods inherited from class org.jclouds.http.options.BaseHttpRequestOptions

buildFormParameters, buildPathSuffix, buildQueryParameters, buildRequestHeaders, buildStringPayload, equals, getFirstFormOrNull, getFirstHeaderOrNull, getFirstQueryOrNull, hashCode, replaceHeader, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NONE

public static final StreamMessagesOptions NONE

Constructor Detail

StreamMessagesOptions

public StreamMessagesOptions()

Method Detail

queryParameters

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

Many OpenStack interfaces take different params for pagination. Using queryParams allows you to make use of them all if necessary.

Overrides:

queryParameters in class PaginationOptions

marker

public StreamMessagesOptions marker(String marker)

Description copied from class: PaginationOptions

The marker parameter is the ID of the last item in the previous list. Items are sorted by create time in descending order. When a create time is not available they are sorted by ID.

Overrides:

marker in class PaginationOptions

See Also:

StreamMessagesOptions.Builder.marker(String)

limit

public StreamMessagesOptions limit(int limit)

Description copied from class: PaginationOptions

To reduce load on the service, list operations will return a maximum of 1,000 items at a time. To navigate the collection, the parameters limit and offset can be set in the URI (e.g.?limit=0&offset=0). If an offset is given beyond the end of a list an empty list will be returned.

Note that list operations never return itemNotFound (404) faults.

Overrides:

limit in class PaginationOptions

See Also:

StreamMessagesOptions.Builder.limit(int)

echo

public StreamMessagesOptions echo(boolean echo)

See Also:

StreamMessagesOptions.Builder.echo(boolean)

includeClaimed

public StreamMessagesOptions includeClaimed(boolean includeClaimed)

See Also:

StreamMessagesOptions.Builder.includeClaimed(boolean)

getMarker

public String getMarker()

Returns:

The String representation of the marker for these StreamMessagesOptions.