Package org.jclouds.blobstore.options
Class ListContainerOptions
- java.lang.Object
-
- org.jclouds.blobstore.options.ListOptions
-
- org.jclouds.blobstore.options.ListContainerOptions
-
- All Implemented Interfaces:
Cloneable
- Direct Known Subclasses:
ListContainerOptions.ImmutableListContainerOptions
public class ListContainerOptions extends ListOptions implements Cloneable
Contains options supported in the list container operation.Usage
The recommended way to instantiate a ListOptions object is to statically import ListContainerOptions.* and invoke a static creation method followed by an instance mutator (if needed):import static org.jclouds.blobstore.options.ListContainerOptions.Builder.* BlobStore connection = // get connection Future
> list = connection.list("container",prefix("home/users").maxResults(1000));
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ListContainerOptions.Builder
static class
ListContainerOptions.ImmutableListContainerOptions
-
Nested classes/interfaces inherited from class org.jclouds.blobstore.options.ListOptions
ListOptions.ImmutableListOptions
-
-
Field Summary
Fields Modifier and Type Field Description static ListContainerOptions.ImmutableListContainerOptions
NONE
-
Constructor Summary
Constructors Constructor Description ListContainerOptions()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ListContainerOptions
afterMarker(String marker)
Place to continue a listing at.ListContainerOptions
clone()
ListContainerOptions
delimiter(String delimiterString)
specify the delimiter to be used when listingboolean
equals(Object obj)
String
getDelimiter()
String
getDir()
Deprecated.superseded by ListContainerOptions.getPrefix and ListContainerOptions.getDelimiter.String
getPrefix()
int
hashCode()
ListContainerOptions
inDirectory(String dir)
Deprecated.superseded by ListContainerOptions.prefix and ListContainerOptions.delimiter.boolean
isDetailed()
boolean
isRecursive()
ListContainerOptions
maxResults(int maxKeys)
The maximum number of values you'd like to see in the response body.ListContainerOptions
prefix(String prefix)
Only list keys that start with the supplied prefixListContainerOptions
recursive()
return a listing of all objects inside the store, recursively.String
toString()
ListContainerOptions
withDetails()
populate each result with detailed such as metadata even if it incurs extra requests to the service.-
Methods inherited from class org.jclouds.blobstore.options.ListOptions
getMarker, getMaxResults
-
-
-
-
Field Detail
-
NONE
public static final ListContainerOptions.ImmutableListContainerOptions NONE
-
-
Method Detail
-
getDir
@Deprecated public String getDir()
Deprecated.superseded by ListContainerOptions.getPrefix and ListContainerOptions.getDelimiter.
-
getDelimiter
public String getDelimiter()
-
isRecursive
public boolean isRecursive()
-
isDetailed
public boolean isDetailed()
-
getPrefix
public String getPrefix()
-
inDirectory
@Deprecated public ListContainerOptions inDirectory(String dir)
Deprecated.superseded by ListContainerOptions.prefix and ListContainerOptions.delimiter.This will list the contents of a virtual or real directory path.
-
afterMarker
public ListContainerOptions afterMarker(String marker)
Place to continue a listing at. This must be the value returned from the last list object, as not all blobstores use lexicographic lists.- Overrides:
afterMarker
in classListOptions
-
maxResults
public ListContainerOptions maxResults(int maxKeys)
The maximum number of values you'd like to see in the response body. The server might return fewer than this many values, but will not return more.- Overrides:
maxResults
in classListOptions
-
recursive
public ListContainerOptions recursive()
return a listing of all objects inside the store, recursively.
-
withDetails
public ListContainerOptions withDetails()
populate each result with detailed such as metadata even if it incurs extra requests to the service.
-
prefix
public ListContainerOptions prefix(String prefix)
Only list keys that start with the supplied prefix
-
delimiter
public ListContainerOptions delimiter(String delimiterString)
specify the delimiter to be used when listing
-
clone
public ListContainerOptions clone()
- Overrides:
clone
in classListOptions
-
-