org.jclouds.cloudservers.options

Class ListOptions

java.lang.Object

org.jclouds.http.options.BaseHttpRequestOptions

org.jclouds.openstack.options.BaseListOptions

org.jclouds.cloudservers.options.ListOptions

All Implemented Interfaces:

HttpRequestOptions

public class ListOptions
extends BaseListOptions

Options used to control the amount of detail in the request.

Author:

Adrian Cole

See Also:

BaseListOptions,

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListOptions.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static ListOptions	NONE

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

formParameters, headers, pathSuffix, payload, queryParameters

Constructor Summary

Constructors

Constructor and Description
ListOptions()

Method Summary

Methods

Modifier and Type	Method and Description
ListOptions	changesSince(Date ifModifiedSince) Only return objects changed since this time.
ListOptions	maxResults(int limit) To reduce load on the service, list operations will return a maximum of 1,000 items at a time.
ListOptions	startAt(long offset) Indicates where to begin listing.
ListOptions	withDetails() unless used, only the name and id will be returned per row.

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

withDetails

public ListOptions withDetails()

unless used, only the name and id will be returned per row.

Returns:

changesSince

public ListOptions changesSince(Date ifModifiedSince)

Only return objects changed since this time.

Overrides:

changesSince in class BaseListOptions

maxResults

public ListOptions 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.

Overrides:

maxResults in class BaseListOptions

startAt

public ListOptions 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.

Overrides:

startAt in class BaseListOptions