org.jclouds.azure.storage.options
Class ListOptions

java.lang.Object
  extended by org.jclouds.http.options.BaseHttpRequestOptions
      extended by org.jclouds.azure.storage.options.ListOptions
All Implemented Interfaces:
HttpRequestOptions
Direct Known Subclasses:
ListBlobsOptions

public class ListOptions
extends BaseHttpRequestOptions

Options used to control paginated results (aka list commands).

Author:
Adrian Cole
See Also:

Nested Class Summary
static class ListOptions.Builder
           
 
Field Summary
static ListOptions NONE
           
 
Fields inherited from class org.jclouds.http.options.BaseHttpRequestOptions
formParameters, headers, matrixParameters, pathSuffix, payload, queryParameters
 
Constructor Summary
ListOptions()
           
 
Method Summary
 boolean getIncludeMetadata()
           
 String getMarker()
           
 Integer getMaxResults()
           
 String getPrefix()
           
 ListOptions includeMetadata()
          Include this parameter to specify that the container's metadata be returned as part of the response body.
 ListOptions marker(String marker)
          A string value that identifies the portion of the list to be returned with the next list operation.
 ListOptions maxResults(int maxresults)
          Specifies the maximum number of containers to return.
 ListOptions prefix(String prefix)
          Filters the results to return only objects whose name begins with the specified prefix.
 
Methods inherited from class org.jclouds.http.options.BaseHttpRequestOptions
buildFormParameters, buildMatrixParameters, buildPathSuffix, buildQueryParameters, buildRequestHeaders, buildStringPayload, equals, getFirstFormOrNull, getFirstHeaderOrNull, getFirstMatrixOrNull, 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

includeMetadata

public ListOptions includeMetadata()
Include this parameter to specify that the container's metadata be returned as part of the response body. Note that metadata requested with this parameter must be stored in accordance with the naming restrictions imposed by the 2009-09-19 version of the Blob service. Beginning with this version, all metadata names must adhere to the naming conventions for C# identifiers.


getIncludeMetadata

public boolean getIncludeMetadata()

prefix

public ListOptions prefix(String prefix)
Filters the results to return only objects whose name begins with the specified prefix.


getPrefix

public String getPrefix()

marker

public ListOptions marker(String marker)
A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items.

The marker value is opaque to the client.


getMarker

public String getMarker()

maxResults

public ListOptions maxResults(int maxresults)
Specifies the maximum number of containers to return. If maxresults is not specified, the server will return up to 5,000 items. If the parameter is set to a value greater than 5,000, the server will return a Bad Request (400) error


getMaxResults

public Integer getMaxResults()


Copyright © 2009-2011 jclouds. All Rights Reserved.