org.jclouds.azureblob.options
Class ListBlobsOptions

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

public class ListBlobsOptions
extends org.jclouds.azure.storage.options.ListOptions

Contains options supported in the REST API for the List Blobs operation.

Usage

The recommended way to instantiate a ListBlobsOptions object is to statically import ListBlobsOptions.* and invoke a static creation method followed by an instance mutator (if needed):

import static org.jclouds.azureblob.options.ListBlobsOptions.Builder.* import org.jclouds.azureblob.AzureBlobClient;

AzureBlobClient connection = // get connection Set blobs = connection.listBlobs("containerName", delimiter("/")); *

See Also:

Nested Class Summary
static class ListBlobsOptions.Builder
           
 
Field Summary
 
Fields inherited from class org.jclouds.azure.storage.options.ListOptions
NONE
 
Fields inherited from class org.jclouds.http.options.BaseHttpRequestOptions
formParameters, headers, pathSuffix, payload, queryParameters
 
Constructor Summary
ListBlobsOptions()
           
 
Method Summary
 ListBlobsOptions delimiter(String delimiter)
          When the request includes this parameter, the operation returns a BlobPrefix element in the response body that acts as a placeholder for all blobs whose names begin with the same substring up to the appearance of the delimiter character.
 String getDelimiter()
           
 ListBlobsOptions includeMetadata()
          
 ListBlobsOptions marker(String marker)
          
 ListBlobsOptions maxResults(int maxresults)
          
 ListBlobsOptions prefix(String prefix)
          
 
Methods inherited from class org.jclouds.azure.storage.options.ListOptions
getIncludeMetadata, getMarker, getMaxResults, getPrefix
 
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
 

Constructor Detail

ListBlobsOptions

public ListBlobsOptions()
Method Detail

delimiter

public ListBlobsOptions delimiter(String delimiter)
When the request includes this parameter, the operation returns a BlobPrefix element in the response body that acts as a placeholder for all blobs whose names begin with the same substring up to the appearance of the delimiter character.

Parameters:
delimiter - a single character or a string.

getDelimiter

public String getDelimiter()

includeMetadata

public ListBlobsOptions includeMetadata()

Overrides:
includeMetadata in class org.jclouds.azure.storage.options.ListOptions

marker

public ListBlobsOptions marker(String marker)

Overrides:
marker in class org.jclouds.azure.storage.options.ListOptions

maxResults

public ListBlobsOptions maxResults(int maxresults)

Overrides:
maxResults in class org.jclouds.azure.storage.options.ListOptions

prefix

public ListBlobsOptions prefix(String prefix)

Overrides:
prefix in class org.jclouds.azure.storage.options.ListOptions


Copyright © 2009-2014 The Apache Software Foundation. All Rights Reserved.