org.jclouds.openstack.options
Class BaseListOptions

java.lang.Object
  extended by org.jclouds.http.options.BaseHttpRequestOptions
      extended by org.jclouds.openstack.options.BaseListOptions
All Implemented Interfaces:
HttpRequestOptions
Direct Known Subclasses:
ListOptions, ListOptions

public class BaseListOptions
extends BaseHttpRequestOptions

Options used to control paginated results (aka list commands).

Author:
Adrian Cole
See Also:

Nested Class Summary
static class BaseListOptions.Builder
           
 
Field Summary
static BaseListOptions NONE
           
 
Fields inherited from class org.jclouds.http.options.BaseHttpRequestOptions
formParameters, headers, matrixParameters, pathSuffix, payload, queryParameters
 
Constructor Summary
BaseListOptions()
           
 
Method Summary
 BaseListOptions changesSince(Date ifModifiedSince)
          Only return objects changed since this time.
 BaseListOptions maxResults(int limit)
          To reduce load on the service, list operations will return a maximum of 1,000 items at a time.
 BaseListOptions startAt(long offset)
          Indicates where to begin listing.
 
Methods inherited from class org.jclouds.http.options.BaseHttpRequestOptions
buildFormParameters, buildMatrixParameters, buildPathSuffix, buildQueryParameters, buildRequestHeaders, buildStringPayload, equals, getFirstFormOrNull, getFirstHeaderOrNull, getFirstMatrixOrNull, 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 BaseListOptions NONE
Constructor Detail

BaseListOptions

public BaseListOptions()
Method Detail

changesSince

public BaseListOptions changesSince(Date ifModifiedSince)
Only return objects changed since this time.


startAt

public BaseListOptions startAt(long offset)
Indicates where to begin listing. The list will only include objects that occur after the offset. This is convenient for pagination: To get the next page of results use the last result number of the current page + current page offset as the offset.


maxResults

public BaseListOptions maxResults(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.



Copyright © 2009-2011 jclouds. All Rights Reserved.