org.jclouds.openstack.swift.options

Class ListContainerOptions

java.lang.Object

org.jclouds.http.options.BaseHttpRequestOptions

org.jclouds.openstack.swift.options.ListContainerOptions

All Implemented Interfaces:

org.jclouds.http.options.HttpRequestOptions

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

Contains options supported in the REST API for the GET container operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListContainerOptions.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static ListContainerOptions	NONE

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

formParameters, headers, pathSuffix, payload, queryParameters

Constructor Summary

Constructors

Constructor and Description
ListContainerOptions()

Method Summary

Methods

Modifier and Type	Method and Description
ListContainerOptions	afterMarker(String marker) Indicates where to begin listing the account's containers.
String	getMarker()
int	getMaxResults()
String	getPath()
String	getPrefix()
ListContainerOptions	maxResults(int limit) The maximum number of containers that will be included in the response body.
ListContainerOptions	underPath(String path) For a string value X, return the Object names nested in the pseudo path.
ListContainerOptions	withPrefix(String prefix) For a string value X, causes the results to be limited to Object names beginning with the substring X.

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 ListContainerOptions NONE

Constructor Detail

ListContainerOptions

public ListContainerOptions()

Method Detail

afterMarker

public ListContainerOptions afterMarker(String marker)

Indicates where to begin listing the account's containers. The list will only include containers whose names occur lexicographically after the marker. This is convenient for pagination: To get the next page of results use the last container name of the current page as the marker.

getMarker

public String getMarker()

maxResults

public ListContainerOptions maxResults(int limit)

The maximum number of containers that will be included in the response body. The server might return fewer than this many containers, but will not return more.

getMaxResults

public int getMaxResults()

withPrefix

public ListContainerOptions withPrefix(String prefix)

For a string value X, causes the results to be limited to Object names beginning with the substring X.

getPrefix

public String getPrefix()

underPath

public ListContainerOptions underPath(String path)

For a string value X, return the Object names nested in the pseudo path.

Users will be able to simulate a hierarchical structure in Cloud Files by following a few guidelines. Object names must contain the forward slash character / as a path element separator and also create directory marker Objects, then they will be able to traverse this nested structure with the new path query parameter.

To take advantage of this feature, the directory marker Objects must also be created to represent the appropriate directories. The following additional Objects need to be created. A good convention would be to create these as zero or one byte files with a Content-Type of application/directory

getPath

public String getPath()