ListBlobsOptions (Microsoft Azure SDK for Media Services 0.9.8 API)

java.lang.Object
- com.microsoft.windowsazure.services.blob.models.BlobServiceOptions
- - com.microsoft.windowsazure.services.blob.models.ListBlobsOptions

```
public class ListBlobsOptions
extends BlobServiceOptions
```
Represents the options that may be set on a com.microsoft.windowsazure.services.blob.BlobContract#listBlobs(String, ListBlobsOptions) request. These options include a server response timeout for the request, a prefix for blobs to match, a marker to continue a list operation, a maximum number of results to return with one list operation, a delimiter for structuring virtual blob hierarchies, and whether to include blob metadata, blob snapshots, and uncommitted blobs in the results.

Constructor Summary

Constructors
Constructor and Description

ListBlobsOptions()

Constructors
Constructor and Description
`ListBlobsOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getDelimiter()` Gets the value of the delimiter to use for grouping virtual blob hierarchy set in this `ListBlobsOptions` instance.
`String`	`getMarker()` Gets the marker value set in this `ListBlobsOptions` instance.
`int`	`getMaxResults()` Gets the value of the maximum number of results to return set in this `ListBlobsOptions` instance.
`String`	`getPrefix()` Gets the prefix filter associated with this `ListBlobsOptions` instance.
`boolean`	`isIncludeMetadata()` Gets the value of a flag indicating whether to include blob metadata with a response set in this `ListBlobsOptions` instance.
`boolean`	`isIncludeSnapshots()` Gets the value of a flag indicating whether to include blob snapshots with a response set in this `ListBlobsOptions` instance.
`boolean`	`isIncludeUncommittedBlobs()` Gets the value of a flag indicating whether to include uncommitted blobs with a response set in this `ListBlobsOptions` instance.
`ListBlobsOptions`	`setDelimiter(String delimiter)` Sets the value of the optional delimiter to use for grouping in a virtual blob hierarchy.
`ListBlobsOptions`	`setIncludeMetadata(boolean includeMetadata)` Sets the value of an optional flag indicating whether to include blob metadata with a response.
`ListBlobsOptions`	`setIncludeSnapshots(boolean includeSnapshots)` Sets the value of an optional flag indicating whether to include blob snapshots with a response.
`ListBlobsOptions`	`setIncludeUncommittedBlobs(boolean includeUncommittedBlobs)` Sets the value of an optional flag indicating whether to include uncommitted blobs with a response.
`ListBlobsOptions`	`setMarker(String marker)` Sets the optional marker value to use in a request.
`ListBlobsOptions`	`setMaxResults(int maxResults)` Sets the optional maximum number of results to return for a request.
`ListBlobsOptions`	`setPrefix(String prefix)` Sets the optional blob name prefix filter value to use in a request.
`ListBlobsOptions`	`setTimeout(Integer timeout)` Sets the optional server request timeout value associated with this `ListBlobsOptions` instance.

Methods inherited from class com.microsoft.windowsazure.services.blob.models.BlobServiceOptions
getTimeout

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ListBlobsOptions
```
public ListBlobsOptions()
```
- Method Detail
  - setTimeout
```
public ListBlobsOptions setTimeout(Integer timeout)
```
    Sets the optional server request timeout value associated with this ListBlobsOptions instance.
    The timeout value only affects calls made on methods where this ListBlobsOptions instance is passed as a parameter.
    
    Overrides:
    
    setTimeout in class BlobServiceOptions
    
    Parameters:
    
    timeout - The server request timeout value to set in milliseconds.
    
    Returns:
    
    A reference to this ListBlobsOptions instance.
  - getPrefix
```
public String getPrefix()
```
    Gets the prefix filter associated with this ListBlobsOptions instance. This value is used to return only blobs beginning with the prefix from the container in methods where this ListBlobsOptions instance is passed as a parameter.
    
    Returns:
    
    A String containing the prefix used to filter the blob names returned, if any.
  - setPrefix
```
public ListBlobsOptions setPrefix(String prefix)
```
    Sets the optional blob name prefix filter value to use in a request. If this value is set, the server will return only blob names that match the prefix value in the response.
    The prefix value only affects calls made on methods where this ListBlobsOptions instance is passed as a parameter.
    
    Parameters:
    
    prefix - A String containing a prefix to use to filter the blob names returned.
  - getMarker
```
public String getMarker()
```
    Gets the marker value set in this ListBlobsOptions instance. If this value is set, the server will return blob names beginning at the specified marker in the response.
    
    Returns:
    
    A String containing the marker value to use to specify the beginning of the request results, if any.
  - setMarker
```
public ListBlobsOptions setMarker(String marker)
```
    Sets the optional marker value to use in a request. If this value is set, the server will return blob names beginning at the specified marker in the response. Leave this value unset for an initial request.
    The List Blobs operation returns a marker value in a NextMarker element if the blob list returned is not complete. The marker value may then be used in a subsequent call to request the next set of blob list items. The marker value is opaque to the client.
    Use the getNextMarker method on a ListBlobsResult instance to get the marker value to set on a ListBlobsOptions instance using a call to this method. Pass the ListBlobsOptions instance as a parameter to a com.microsoft.windowsazure.services.blob.BlobContract#listBlobs(String, ListBlobsOptions) call to get the next portion of the blob list.
    The marker value only affects calls made on methods where this ListBlobsOptions instance is passed as a parameter.
    
    Parameters:
    
    marker - A String containing the marker value to use to specify the beginning of the request results.
    
    Returns:
    
    A reference to this ListBlobsOptions instance.
  - getMaxResults
```
public int getMaxResults()
```
    Gets the value of the maximum number of results to return set in this ListBlobsOptions instance.
    
    Returns:
    
    The maximum number of results to return. If the value is zero, the server will return up to 5,000 items.
  - setMaxResults
```
public ListBlobsOptions setMaxResults(int maxResults)
```
    Sets the optional maximum number of results to return for a request. If this value is set, the server will return up to this number of blob and blob prefix results in the response. If a value is not specified, or a value greater than 5,000 is specified, the server will return up to 5,000 items.
    If there are more blobs and blob prefixes that can be returned than this maximum, the server returns a marker value in a NextMarker element in the response. The marker value may then be used in a subsequent call to request the next set of blob list items. The marker value is opaque to the client.
    Use the getNextMarker method on a ListBlobsResult instance to get the marker value to set on a ListBlobsOptions instance using a call to setMarker(String). Pass the ListBlobsOptions instance as a parameter to a com.microsoft.windowsazure.services.blob.BlobContract#listBlobs(String, ListBlobsOptions) call to get the next portion of the blob list.
    The maxResults value only affects calls made on methods where this ListBlobsOptions instance is passed as a parameter.
    
    Parameters:
    
    maxResults - The maximum number of results to return.
    
    Returns:
    
    A reference to this ListBlobsOptions instance.
  - getDelimiter
```
public String getDelimiter()
```
    Gets the value of the delimiter to use for grouping virtual blob hierarchy set in this ListBlobsOptions instance.
    
    Returns:
    
    A String containing the delimiter value, if any.
  - setDelimiter
```
public ListBlobsOptions setDelimiter(String delimiter)
```
    Sets the value of the optional delimiter to use for grouping in a virtual blob hierarchy.
    When the request includes this optional parameter, the operation returns a blob prefix in a BlobPrefix element in the response that acts as a placeholder for all blobs whose names begin with the same substring up to the appearance of the delimiter character. The delimiter may be a single character or a string.
    The delimiter parameter enables the caller to traverse the blob namespace by using a user-configured delimiter. In this way, you can traverse a virtual hierarchy of blobs as though it were a file system. The delimiter is a string that may be one or more characters long. When the request includes this parameter, the operation response includes one BlobPrefix element for each set of blobs whose names begin with a common substring up to the first appearance of the delimiter string that comes after any prefix specified for the request. The value of the BlobPrefix element is substring+delimiter, where substring is the common substring that begins one or more blob names, and delimiter is the value of the delimiter parameter.
    The BlobPrefix elements in the response are accessed with the ListBlobsResult.getBlobPrefixes() method. You can use each value in the list returned to make a list blobs request for the blobs that begin with that blob prefix value, by specifying the value as the prefix option with a call to the setPrefix method on a ListBlobsOptions instance passed as a parameter to the request.
    Note that each blob prefix returned in the response counts toward the maximum number of blob results, just as each blob does.
    Note that if a delimiter is set, you cannot include snapshots. A request that includes both returns an InvalidQueryParameter error (HTTP status code 400 - Bad Request), which causes a ServiceException to be thrown.
    The delimiter value only affects calls made on methods where this ListBlobsOptions instance is passed as a parameter.
    
    Parameters:
    
    delimiter - A String containing the delimiter value to use for grouping virtual blob hierarchy.
    
    Returns:
    
    A reference to this ListBlobsOptions instance.
  - isIncludeMetadata
```
public boolean isIncludeMetadata()
```
    Gets the value of a flag indicating whether to include blob metadata with a response set in this ListBlobsOptions instance.
    
    Returns:
    
    A value of true to include blob metadata with a response, otherwise, false.
  - setIncludeMetadata
```
public ListBlobsOptions setIncludeMetadata(boolean includeMetadata)
```
    Sets the value of an optional flag indicating whether to include blob metadata with a response.
    
    Parameters:
    
    includeMetadata - Set a value of true to include blob metadata with a response, otherwise, false.
    
    Returns:
    
    A reference to this ListBlobsOptions instance.
  - isIncludeSnapshots
```
public boolean isIncludeSnapshots()
```
    Gets the value of a flag indicating whether to include blob snapshots with a response set in this ListBlobsOptions instance.
    
    Returns:
    
    A value of true to include blob metadata with a response, otherwise, false.
  - setIncludeSnapshots
```
public ListBlobsOptions setIncludeSnapshots(boolean includeSnapshots)
```
    Sets the value of an optional flag indicating whether to include blob snapshots with a response.
    Note that if this flag is set, you cannot set a delimiter. A request that includes both returns an InvalidQueryParameter error (HTTP status code 400 - Bad Request), which causes a ServiceException to be thrown.
    
    Parameters:
    
    includeSnapshots - Set a value of true to include blob metadata with a response, otherwise, false.
    
    Returns:
    
    A reference to this ListBlobsOptions instance.
  - isIncludeUncommittedBlobs
```
public boolean isIncludeUncommittedBlobs()
```
    Gets the value of a flag indicating whether to include uncommitted blobs with a response set in this ListBlobsOptions instance.
    
    Returns:
    
    A value of true to include uncommitted blobs with a response, otherwise, false.
  - setIncludeUncommittedBlobs
```
public ListBlobsOptions setIncludeUncommittedBlobs(boolean includeUncommittedBlobs)
```
    Sets the value of an optional flag indicating whether to include uncommitted blobs with a response. Uncommitted blobs are blobs for which blocks have been uploaded, but which have not been committed with a request to BlobContract.commitBlobBlocks(String, String, BlockList) or BlobContract.commitBlobBlocks(String, String, BlockList, CommitBlobBlocksOptions) .
    
    Parameters:
    
    includeUncommittedBlobs - Set a value of true to include uncommitted blobs with a response, otherwise, false.
    
    Returns:
    
    A reference to this ListBlobsOptions instance.

/** 
* Copyright Microsoft Corporation 
* 
* Licensed under the Apache License, Version 2.0 (the "License"); 
* you may not use this file except in compliance with the License. 
* You may obtain a copy of the License at 
* http://www.apache.org/licenses/LICENSE-2.0 
* 
* Unless required by applicable law or agreed to in writing, software 
* distributed under the License is distributed on an "AS IS" BASIS, 
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
* See the License for the specific language governing permissions and 
* limitations under the License. 
*/

Class ListBlobsOptions

Constructor Summary

Method Summary

Methods inherited from class com.microsoft.windowsazure.services.blob.models.BlobServiceOptions

Methods inherited from class java.lang.Object

Constructor Detail

ListBlobsOptions

Method Detail

setTimeout

getPrefix

setPrefix

getMarker

setMarker

getMaxResults

setMaxResults

getDelimiter

setDelimiter

isIncludeMetadata

setIncludeMetadata

isIncludeSnapshots

setIncludeSnapshots

isIncludeUncommittedBlobs

setIncludeUncommittedBlobs