Package org.jclouds.openstack.nova.v2_0.options

Class ListOptions

java.lang.Object

org.jclouds.http.options.BaseHttpRequestOptions

org.jclouds.openstack.v2_0.options.PaginationOptions

org.jclouds.openstack.nova.v2_0.options.ListOptions

All Implemented Interfaces:

HttpRequestOptions

public class ListOptions
extends PaginationOptions

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

See Also:

• PaginationOptions

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListOptions.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final ListOptions	NONE

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

formParameters, headers, pathSuffix, payload, queryParameters

Constructor Summary

Constructors

Constructor	Description
ListOptions()

Method Summary

Modifier and Type	Method	Description
ListOptions	changesSince(Date changesSince)	Checks for any changes since the given date.
ListOptions	limit(int limit)	To reduce load on the service, list operations will return a maximum of 1,000 items at a time.
ListOptions	marker(String marker)	The marker parameter is the ID of the last item in the previous list.
ListOptions	withDetails()	Provides detailed results for list operations.

Methods inherited from class org.jclouds.openstack.v2_0.options.PaginationOptions

queryParameters

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 Details

NONE

public static final ListOptions NONE

Constructor Details

ListOptions

public ListOptions()

Method Details

withDetails

public ListOptions withDetails()

Provides detailed results for list operations.

limit

public ListOptions 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=0invalid input: '&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:

limit in class PaginationOptions

marker

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

Overrides:

marker in class PaginationOptions

changesSince

public ListOptions changesSince(Date changesSince)

Checks for any changes since the given date.

Overrides:

changesSince in class PaginationOptions