Package org.jclouds.azureblob.options
Class ListBlobsOptions
- java.lang.Object
-
- org.jclouds.http.options.BaseHttpRequestOptions
-
- org.jclouds.azure.storage.options.ListOptions
-
- org.jclouds.azureblob.options.ListBlobsOptions
-
- All Implemented Interfaces:
HttpRequestOptions
public class ListBlobsOptions extends 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("/")); *
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description 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
Constructors Constructor Description ListBlobsOptions()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListBlobsOptions
delimiter(String delimiter)
When the request includes this parameter, the operation returns aBlobPrefix
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()
Set<String>
getInclude()
ListBlobsOptions
include(Set<ListBlobsInclude> datasets)
ListBlobsOptions
includeMetadata()
Include this parameter to specify that the container's metadata be returned as part of the response body.ListBlobsOptions
marker(String marker)
A string value that identifies the portion of the list to be returned with the next list operation.ListBlobsOptions
maxResults(int maxresults)
Specifies the maximum number of containers to return.ListBlobsOptions
prefix(String prefix)
Filters the results to return only objects whose name begins with the specified 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
-
-
-
-
Method Detail
-
delimiter
public ListBlobsOptions delimiter(String delimiter)
When the request includes this parameter, the operation returns aBlobPrefix
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()
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.- Overrides:
includeMetadata
in classListOptions
-
marker
public ListBlobsOptions 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.- Overrides:
marker
in classListOptions
-
maxResults
public ListBlobsOptions 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- Overrides:
maxResults
in classListOptions
-
prefix
public ListBlobsOptions prefix(String prefix)
Filters the results to return only objects whose name begins with the specified prefix.- Overrides:
prefix
in classListOptions
-
include
public ListBlobsOptions include(Set<ListBlobsInclude> datasets)
-
-