ListOptions (Apache jclouds 2.4.0 API)

This project has retired. For details please refer to its Attic page.

ListOptions (Apache jclouds 2.4.0 API)

java.lang.Object
- org.jclouds.http.options.BaseHttpRequestOptions
- - org.jclouds.atmos.options.ListOptions

All Implemented Interfaces:

HttpRequestOptions
```
public class ListOptions
extends BaseHttpRequestOptions
```
Options used to control paginated results (aka list commands).

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ListOptions.Builder

Field Summary

Fields
Modifier and Type Field Description

static ListOptions NONE
- Fields inherited from class org.jclouds.http.options.BaseHttpRequestOptions
  formParameters, headers, pathSuffix, payload, queryParameters

Constructor Summary

Constructors
Constructor Description

ListOptions()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Integer`	`getLimit()`
`String`	`getToken()`
`ListOptions`	`includeMeta()`	the maximum number of items that should be returned.
`ListOptions`	`limit(int maxresults)`	the maximum number of items that should be returned.
`boolean`	`metaIncluded()`
`ListOptions`	`token(String token)`	specifies the position to resume listing

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 ListOptions NONE
```
- Constructor Detail
  - ListOptions
```
public ListOptions()
```
- Method Detail
  - token
```
public ListOptions token(String token)
```
    specifies the position to resume listing
    note this is an opaque value and should not be interpreted.
  - getToken
```
public String getToken()
```
  - limit
```
public ListOptions limit(int maxresults)
```
    the maximum number of items that should be returned. If this is not specified, there is no limit.
  - includeMeta
```
public ListOptions includeMeta()
```
    the maximum number of items that should be returned. If this is not specified, there is no limit.
  - metaIncluded
```
public boolean metaIncluded()
```
  - getLimit
```
public Integer getLimit()
```