ListBlobsResult (Microsoft Azure SDK for Media Services 0.9.8 API)

java.lang.Object
- com.microsoft.windowsazure.services.blob.models.ListBlobsResult

```
public class ListBlobsResult
extends Object
```
A wrapper class for the response returned from a Blob Service REST API List Blobs operation. This is returned by calls to implementations of com.microsoft.windowsazure.services.blob.BlobContract#listBlobs(String) and com.microsoft.windowsazure.services.blob.BlobContract#listBlobs(String, ListBlobsOptions).
See the List Blobs documentation on MSDN for details of the underlying Blob Service REST API operation.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ListBlobsResult.BlobEntry` Represents a Blob element returned in the response.
`static class`	`ListBlobsResult.BlobPrefixEntry` Represents a BlobPrefix element returned in the response.
`static class`	`ListBlobsResult.ListBlobsEntry` The abstract base class for `Blob` and `BlobPrefix` entries in the list of results returned in the response.

Constructor Summary

Constructors
Constructor and Description

ListBlobsResult()

Constructors
Constructor and Description
`ListBlobsResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<ListBlobsResult.BlobPrefixEntry>`	`getBlobPrefixes()` Gets the list of blob prefix entries that satisfied the request.
`List<ListBlobsResult.BlobEntry>`	`getBlobs()` Gets the list of blobs that satisfied the request from the response.
`String`	`getContainerName()` Gets the container URI.
`String`	`getDelimiter()` Gets the delimiter value used to generate the response, if present.
`List<ListBlobsResult.ListBlobsEntry>`	`getEntries()` Gets the list of `ListBlobsEntry` entries generated from the server response to the list blobs request.
`String`	`getMarker()` Gets the value of the marker that was used to specify the beginning of the container list to return with the request.
`int`	`getMaxResults()` Gets the maximum results to return used to generate the response, if present.
`String`	`getNextMarker()` Gets the next marker value needed to specify the beginning of the next portion of the blob list to return, if any was set in the response from the server.
`String`	`getPrefix()` Gets the value of the filter used to return only blobs beginning with the prefix.
`void`	`setContainerName(String containerName)` Reserved for internal use.
`void`	`setDelimiter(String delimiter)` Reserved for internal use.
`void`	`setEntries(List<ListBlobsResult.ListBlobsEntry> entries)` Sets the lists of blob entries and blob prefix entries from a common list of `ListBlobsEntry` entries generated from the server response to the list blobs request.
`void`	`setMarker(String marker)` Reserved for internal use.
`void`	`setMaxResults(int maxResults)` Reserved for internal use.
`void`	`setNextMarker(String nextMarker)` Reserved for internal use.
`void`	`setPrefix(String prefix)` Reserved for internal use.

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

- Constructor Detail
  - ListBlobsResult
```
public ListBlobsResult()
```
- Method Detail
  - getEntries
```
public List<ListBlobsResult.ListBlobsEntry> getEntries()
```
    Gets the list of ListBlobsEntry entries generated from the server response to the list blobs request.
    
    Returns:
    
    The List of ListBlobsResult.ListBlobsEntry entries generated from the server response to the list blobs request.
  - setEntries
```
public void setEntries(List<ListBlobsResult.ListBlobsEntry> entries)
```
    Sets the lists of blob entries and blob prefix entries from a common list of ListBlobsEntry entries generated from the server response to the list blobs request.
    
    Parameters:
    
    entries - The List of ListBlobsResult.ListBlobsEntry entries to set the lists of blob entries and blob prefix entries from.
  - getBlobPrefixes
```
public List<ListBlobsResult.BlobPrefixEntry> getBlobPrefixes()
```
    Gets the list of blob prefix entries that satisfied the request. Each BlobPrefixEntry represents one or more blobs that have a common substring up to the delimiter specified in the request options.
    This list may contain only a portion of the blob prefix entries that satisfy the request, limited by a server timeout or a maximum results parameter. If there are more blob entries and blob prefix entries that could satisfy the result, the server returns a NextMarker element with the response.
    The delimiter option 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 may be a single character or a string. When the request includes the delimiter option, the response includes a BlobPrefixEntry in place of all blobs whose names begin with the same substring up to the appearance of the delimiter string. The value of ListBlobsResult.BlobPrefixEntry.getName() is substring+ delimiter , where substring is the common substring that begins one or more blob names, and delimiter is the value of the delimiter option.
    To move down a level in the virtual hierarchy, you can use the ListBlobsResult.BlobPrefixEntry.getName() method to get the prefix value to use to make a subsequent call to list blobs that begin with this prefix.
    Use the getNextMarker method to get this value and pass it as a marker option to a subsequent list blobs request to get the next set of blob results.
    Blobs are listed in alphabetical order in the response body, with upper-case letters listed first.
    
    Returns:
    
    A List of ListBlobsResult.BlobEntry instances for the blobs that satisfied the request.
  - getBlobs
```
public List<ListBlobsResult.BlobEntry> getBlobs()
```
    Gets the list of blobs that satisfied the request from the response. This list may contain only a portion of the blobs that satisfy the request, limited by a server timeout or a maximum results parameter. If there are more blobs or blob prefixes that could satisfy the result, the server returns a NextMarker element with the response.
    Use the getNextMarker method to get this value and pass it as a marker option to a subsequent list blobs request to get the next set of blob results.
    Blobs are listed in alphabetical order in the response body, with upper-case letters listed first.
    
    Returns:
    
    A List of ListBlobsResult.BlobEntry instances for the blobs that satisfied the request.
  - getPrefix
```
public String getPrefix()
```
    Gets the value of the filter used to return only blobs beginning with the prefix. This value is not set if a prefix was not specified in the list blobs request.
    
    Returns:
    
    A String containing the prefix used to filter the blob names returned, if any.
  - setPrefix
```
public void setPrefix(String prefix)
```
    Reserved for internal use. Sets the filter used to return only blobs beginning with the prefix from the Prefix element returned in the response.
    This method is invoked by the API to set the value from the Blob Service REST API operation response returned by the server.
    
    Parameters:
    
    prefix - A String containing the prefix used to filter the blob names returned, if any.
  - getMarker
```
public String getMarker()
```
    Gets the value of the marker that was used to specify the beginning of the container list to return with the request. This value is not set if a marker was not specified in the 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 to get the marker value to set on a ListBlobsOptions instance using a call to ListBlobsOptions.setMarker(String). Pass the ListBlobsOptions instance as a parameter to a listBlobs call to get the next portion of the blob list.
    
    Returns:
    
    A String containing the marker used to specify the beginning of the blob list returned, if any.
  - setMarker
```
public void setMarker(String marker)
```
    Reserved for internal use. Sets the marker used to specify the beginning of the blob list to return from the Marker element returned in the response.
    This method is invoked by the API to set the value from the Blob Service REST API operation response returned by the server.
    
    Parameters:
    
    marker - A String containing the marker used to specify the beginning of the blob list returned.
  - getNextMarker
```
public String getNextMarker()
```
    Gets the next marker value needed to specify the beginning of the next portion of the blob list to return, if any was set in the response from the server.
    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 to get the marker value to set on a ListBlobsOptions instance using a call to ListBlobsOptions.setMarker(String). Pass the ListBlobsOptions instance as a parameter to a listBlobs call to get the next portion of the blob list.
    
    Returns:
    
    A String containing the next marker value needed to specify the beginning of the next portion of the blob list to return, if any was set in the response from the server.
  - setNextMarker
```
public void setNextMarker(String nextMarker)
```
    Reserved for internal use. Sets the next marker value needed to specify the beginning of the next portion of the blob list to return from the NextMarker element returned in the response.
    This method is invoked by the API to set the value from the Blob Service REST API operation response returned by the server.
    
    Parameters:
    
    nextMarker - A String containing the next marker value needed to specify the beginning of the next portion of the blob list to return.
  - getMaxResults
```
public int getMaxResults()
```
    Gets the maximum results to return used to generate the response, if present. The number of entries returned in the response will not exceed this number, including all BlobPrefix elements. This value is not set if a maximum number was not specified in the request. If the request does not specify this parameter or specifies a value greater than 5,000, the server will return up to 5,000 items. If there are more blobs or blob prefixes that satisfy the request than this maximum value, the server will include a next marker value in the response, which can be used to get the remaining blobs with a subsequent request.
    Use the getNextMarker method to get the marker value to set on a ListBlobsOptions instance using a call to ListBlobsOptions.setMarker(String). Pass the ListBlobsOptions instance as a parameter to a listBlobs call to get the next portion of the blob list.
    
    Returns:
    
    The maximum results to return value in the response, if any.
  - setMaxResults
```
public void setMaxResults(int maxResults)
```
    Reserved for internal use. Sets the maximum results to return value from the MaxResults element of the EnumerationResults element returned in the response.
    This method is invoked by the API to set the value from the Blob Service REST API operation response returned by the server.
    
    Parameters:
    
    maxResults - The maximum results to return value in the response, if any.
  - getDelimiter
```
public String getDelimiter()
```
    Gets the delimiter value used to generate the response, if present. When the request includes this parameter, the operation returns BlobPrefix elements in the response body that act as a placeholder for all blobs whose names begin with the same substring up to the appearance of the delimiter character.
    
    Returns:
    
    A String containing the delimiter value used as a request parameter.
  - setDelimiter
```
public void setDelimiter(String delimiter)
```
    Reserved for internal use. Sets the delimiter value from the Delimiter element of the EnumerationResults element returned in the response.
    This method is invoked by the API to set the value from the Blob Service REST API operation response returned by the server.
    
    Parameters:
    
    delimiter - A String containing the delimiter value in the response, if any.
  - getContainerName
```
public String getContainerName()
```
    Gets the container URI. This value is returned in the ContainerName attribute of the EnumerationResults element returned in the response.
    
    Returns:
    
    A String containing the container URI.
  - setContainerName
```
public void setContainerName(String containerName)
```
    Reserved for internal use. Sets the container URI value from the ContainerName attribute of the EnumerationResults element returned in the response.
    This method is invoked by the API to set the value from the Blob Service REST API operation response returned by the server.
    
    Parameters:
    
    containerName - A String containing the container URI.

/** 
* 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 ListBlobsResult

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ListBlobsResult

Method Detail

getEntries

setEntries

getBlobPrefixes

getBlobs

getPrefix

setPrefix

getMarker

setMarker

getNextMarker

setNextMarker

getMaxResults

setMaxResults

getDelimiter

setDelimiter

getContainerName

setContainerName