ListContainersOptions (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.ListContainersOptions

```
public class ListContainersOptions
extends BlobServiceOptions
```
Represents the options that may be set on a listContainers request. These options include a server response timeout for the request, a container name prefix filter, a marker for continuing requests, the maximum number of results to return in a request, and whether to include container metadata in the results. Options that are not set will not be passed to the server with a request.

Constructor Summary

Constructors
Constructor and Description

ListContainersOptions()

Constructors
Constructor and Description
`ListContainersOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getMarker()` Gets the marker value set in this `ListContainersOptions` instance.
`int`	`getMaxResults()` Gets the value of the maximum number of results to return set in this `ListContainersOptions` instance.
`String`	`getPrefix()` Gets the container name prefix filter value set in this `ListContainersOptions` instance.
`boolean`	`isIncludeMetadata()` Gets the value of a flag set in this `ListContainersOptions` instance indicating whether to include container metadata in the response to the request.
`ListContainersOptions`	`setIncludeMetadata(boolean includeMetadata)` Sets the value of an optional flag indicating whether to include container metadata with the response to the request.
`ListContainersOptions`	`setMarker(String marker)` Sets the optional marker value to use in a request.
`ListContainersOptions`	`setMaxResults(int maxResults)` Sets the optional maximum number of results to return for a request.
`ListContainersOptions`	`setPrefix(String prefix)` Sets the optional container name prefix filter value to use in a request.
`ListContainersOptions`	`setTimeout(Integer timeout)` Sets the optional server request timeout value associated with this `ListContainersOptions` 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
  - ListContainersOptions
```
public ListContainersOptions()
```
- Method Detail
  - setTimeout
```
public ListContainersOptions setTimeout(Integer timeout)
```
    Sets the optional server request timeout value associated with this ListContainersOptions instance.
    The timeout value only affects calls made on methods where this ListContainersOptions 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 ListContainersOptions instance.
  - getPrefix
```
public String getPrefix()
```
    Gets the container name prefix filter value set in this ListContainersOptions instance.
    
    Returns:
    
    A String containing the container name prefix value, if any.
  - setPrefix
```
public ListContainersOptions setPrefix(String prefix)
```
    Sets the optional container name prefix filter value to use in a request. If this value is set, the server will return only container names that match the prefix value in the response.
    The prefix value only affects calls made on methods where this ListContainersOptions instance is passed as a parameter.
    
    Parameters:
    
    prefix - A String containing the container name prefix value to use to filter the request results.
    
    Returns:
    
    A reference to this ListContainersOptions instance.
  - getMarker
```
public String getMarker()
```
    Gets the marker value set in this ListContainersOptions instance.
    
    Returns:
    
    A String containing the marker value to use to specify the beginning of the request results.
  - setMarker
```
public ListContainersOptions setMarker(String marker)
```
    Sets the optional marker value to use in a request. If this value is set, the server will return container names beginning at the specified marker in the response.
    The List Containers operation returns a marker value in a NextMarker element if the container list returned is not complete. The marker value may then be used in a subsequent call to request the next set of container list items. The marker value is opaque to the client.
    Use the getNextMarker method on a ListContainersResult instance to get the marker value to set on a ListContainersOptions instance using a call to this method. Pass the ListContainersOptions instance as a parameter to a BlobContract.listContainers(ListContainersOptions) call to get the next portion of the container list.
    The marker value only affects calls made on methods where this ListContainersOptions 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 ListContainersOptions instance.
  - getMaxResults
```
public int getMaxResults()
```
    Gets the value of the maximum number of results to return set in this ListContainersOptions instance.
    
    Returns:
    
    The maximum number of results to return.
  - setMaxResults
```
public ListContainersOptions 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 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 containers than this value that can be returned, 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 container list items. The marker value is opaque to the client.
    Use the getNextMarker method on a ListContainersResult instance to get the marker value to set on a ListContainersOptions instance using a call to setMarker(String). Pass the ListContainersOptions instance as a parameter to a BlobContract.listContainers(ListContainersOptions) call to get the next portion of the container list.
    The maxResults value only affects calls made on methods where this ListContainersOptions instance is passed as a parameter.
    
    Parameters:
    
    maxResults - The maximum number of results to return.
    
    Returns:
    
    A reference to this ListContainersOptions instance.
  - isIncludeMetadata
```
public boolean isIncludeMetadata()
```
    Gets the value of a flag set in this ListContainersOptions instance indicating whether to include container metadata in the response to the request.
    
    Returns:
    
    true to include container metadata in the response to the request.
  - setIncludeMetadata
```
public ListContainersOptions setIncludeMetadata(boolean includeMetadata)
```
    Sets the value of an optional flag indicating whether to include container metadata with the response to the request.
    The includeMetadata value only affects calls made on methods where this ListContainersOptions instance is passed as a parameter.
    
    Parameters:
    
    includeMetadata - Set to true to include container metadata in the response to the request.
    
    Returns:
    
    A reference to this ListContainersOptions 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 ListContainersOptions

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

ListContainersOptions

Method Detail

setTimeout

getPrefix

setPrefix

getMarker

setMarker

getMaxResults

setMaxResults

isIncludeMetadata

setIncludeMetadata