PaginationOptions (Apache jclouds 2.4.0 API)

java.lang.Object
- org.jclouds.http.options.BaseHttpRequestOptions
- - org.jclouds.openstack.v2_0.options.PaginationOptions

All Implemented Interfaces:

HttpRequestOptions

Direct Known Subclasses:

ListImageOptions, ListOptions, ListQueuesOptions, StreamMessagesOptions
```
public class PaginationOptions
extends BaseHttpRequestOptions
```
Options used to control paginated results (aka list commands).

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class PaginationOptions.Builder

Field Summary
- Fields inherited from class org.jclouds.http.options.BaseHttpRequestOptions
  formParameters, headers, pathSuffix, payload, queryParameters

Constructor Summary

Constructors
Constructor Description

PaginationOptions()

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`PaginationOptions`	`changesSince(Date changesSince)`	Deprecated. The `changes-since` query does not apply to all OpenStack APIs.
`PaginationOptions`	`limit(int limit)`	To reduce load on the service, list operations will return a maximum of 1,000 items at a time.
`PaginationOptions`	`marker(String marker)`	The marker parameter is the ID of the last item in the previous list.
`PaginationOptions`	`queryParameters(com.google.common.collect.Multimap<String,String> queryParams)`	Many OpenStack interfaces take different params for pagination.

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

- Constructor Detail
  - PaginationOptions
```
public PaginationOptions()
```
- Method Detail
  - queryParameters
```
public PaginationOptions 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.
  - changesSince
```
@Deprecated
public PaginationOptions changesSince(Date changesSince)
```
    Deprecated.
    The changes-since query does not apply to all OpenStack APIs. Please refer to the OpenStack Nova ListOptions.changesSince(Date) and Glance ListImageOptions.changesSince(Date). To be removed in jclouds 2.0.
    
    Only return objects changed since a specified time.
  - marker
```
public PaginationOptions marker(String marker)
```
    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.
  - limit
```
public PaginationOptions limit(int limit)
```
    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.