org.jclouds.rackspace.cloudidentity.v2_0.options
Class PaginationOptions

java.lang.Object
  extended by org.jclouds.http.options.BaseHttpRequestOptions
      extended by org.jclouds.rackspace.cloudidentity.v2_0.options.PaginationOptions
All Implemented Interfaces:
org.jclouds.http.options.HttpRequestOptions

public class PaginationOptions
extends org.jclouds.http.options.BaseHttpRequestOptions

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

Author:
Everett Toews

Nested Class Summary
static class PaginationOptions.Builder
           
 
Field Summary
 
Fields inherited from class org.jclouds.http.options.BaseHttpRequestOptions
formParameters, headers, pathSuffix, payload, queryParameters
 
Constructor Summary
PaginationOptions()
           
 
Method Summary
 PaginationOptions limit(int limit)
          Limit is the restriction on the maximum number of items for that type that can be returned.
 PaginationOptions name(String nameFilter)
          Name is a filter on the result set.
 PaginationOptions offset(int offset)
          Offset is the starting point for the return data.
 PaginationOptions queryParameters(com.google.common.collect.Multimap<String,String> queryParams)
           
 
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)

offset

public PaginationOptions offset(int offset)
Offset is the starting point for the return data. Offset must be a multiple of the limit (or zero).


limit

public PaginationOptions limit(int limit)
Limit is the restriction on the maximum number of items for that type that can be returned.

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


name

public PaginationOptions name(String nameFilter)
Name is a filter on the result set.



Copyright © 2009-2013 The Apache Software Foundation. All Rights Reserved.