org.jclouds.blobstore.options
Class ListContainerOptions

java.lang.Object
  extended by org.jclouds.blobstore.options.ListOptions
      extended by 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",inDirectory("home/users").maxResults(1000));

Author:
Adrian Cole

Nested Class Summary
static class ListContainerOptions.Builder
           
static class ListContainerOptions.ImmutableListContainerOptions
           
 
Nested classes/interfaces inherited from class org.jclouds.blobstore.options.ListOptions
ListOptions.ImmutableListOptions
 
Field Summary
static ListContainerOptions.ImmutableListContainerOptions NONE
           
 
Constructor Summary
ListContainerOptions()
           
 
Method Summary
 ListContainerOptions afterMarker(String marker)
          Place to continue a listing at.
 ListContainerOptions clone()
           
 String getDir()
           
 ListContainerOptions inDirectory(String dir)
          This will list the contents of a virtual or real directory path.
 boolean isDetailed()
           
 boolean isRecursive()
           
 ListContainerOptions maxResults(int maxKeys)
          The maximum number of values you'd like to see in the response body.
 ListContainerOptions 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
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

NONE

public static final ListContainerOptions.ImmutableListContainerOptions NONE
Constructor Detail

ListContainerOptions

public ListContainerOptions()
Method Detail

getDir

public String getDir()

isRecursive

public boolean isRecursive()

isDetailed

public boolean isDetailed()

inDirectory

public ListContainerOptions inDirectory(String dir)
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 lexigraphic lists.

Overrides:
afterMarker in class ListOptions

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 class ListOptions

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.


clone

public ListContainerOptions clone()
Overrides:
clone in class ListOptions

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2009-2011 jclouds. All Rights Reserved.