ListQueuesOptions (Microsoft Azure SDK for Media Services 0.9.8 API)

java.lang.Object
- com.microsoft.windowsazure.services.queue.models.QueueServiceOptions
- - com.microsoft.windowsazure.services.queue.models.ListQueuesOptions

```
public class ListQueuesOptions
extends QueueServiceOptions
```
Represents the options that may be set on the Queue service for QueueContract.listQueues(ListQueuesOptions) requests. These options include a server response timeout for the request, a prefix to match queue names to return, a marker to specify where to resume a list queues query, the maximum number of queues to return in a single response, and whether to include queue metadata with the response.

Constructor Summary

Constructors
Constructor and Description

ListQueuesOptions()

Constructors
Constructor and Description
`ListQueuesOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getMarker()` Gets a `String` value that identifies the beginning of the list of queues to be returned with a `listQueues` request.
`int`	`getMaxResults()` Gets the maximum number of queues to return with a `listQueues` request.
`String`	`getPrefix()` Gets the prefix `String` used to match queue names to return in a `listQueues` request.
`boolean`	`isIncludeMetadata()` Gets a flag indicating whether to return metadata with a `listQueues` request.
`ListQueuesOptions`	`setIncludeMetadata(boolean includeMetadata)` Sets a flag indicating whether to return metadata with a `listQueues` request.
`ListQueuesOptions`	`setMarker(String marker)` Sets a `String` marker value that identifies the beginning of the list of queues to be returned with a `listQueues` request.
`ListQueuesOptions`	`setMaxResults(int maxResults)` Sets the maximum number of queues to return with a `listQueues` request.
`ListQueuesOptions`	`setPrefix(String prefix)` Sets the prefix `String` to use to match queue names to return in a `listQueues` request.
`ListQueuesOptions`	`setTimeout(Integer timeout)` Sets the server request timeout value associated with this `ListQueuesOptions` instance.

Methods inherited from class com.microsoft.windowsazure.services.queue.models.QueueServiceOptions
getTimeout

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

- Constructor Detail
  - ListQueuesOptions
```
public ListQueuesOptions()
```
- Method Detail
  - setTimeout
```
public ListQueuesOptions setTimeout(Integer timeout)
```
    Sets the server request timeout value associated with this ListQueuesOptions instance.
    The timeout value only affects calls made on methods where this ListQueuesOptions instance is passed as a parameter.
    
    Overrides:
    
    setTimeout in class QueueServiceOptions
    
    Parameters:
    
    timeout - The server request timeout value to set in milliseconds.
    
    Returns:
    
    A reference to this ListQueuesOptions instance.
  - getPrefix
```
public String getPrefix()
```
    Gets the prefix String used to match queue names to return in a listQueues request.
    
    Returns:
    
    The prefix String used to match queue names to return in a listQueues request.
  - setPrefix
```
public ListQueuesOptions setPrefix(String prefix)
```
    Sets the prefix String to use to match queue names to return in a listQueues request.
    The prefix value only affects calls made on methods where this ListQueuesOptions instance is passed as a parameter.
    
    Parameters:
    
    prefix - The prefix String to use to match queue names to return in a listQueues request.
    
    Returns:
    
    A reference to this ListQueuesOptions instance.
  - getMarker
```
public String getMarker()
```
    Gets a String value that identifies the beginning of the list of queues to be returned with a listQueues request.
    The listQueues method returns a NextMarker element within the response if the list returned was not complete, which can be accessed with the ListQueuesResult.getNextMarker() method. This opaque value may then be set on a ListQueuesOptions instance with a call to setMarker to be used in a subsequent listQueues call to request the next portion of the list of queues.
    
    Returns:
    
    The marker value that identifies the beginning of the list of queues to be returned.
  - setMarker
```
public ListQueuesOptions setMarker(String marker)
```
    Sets a String marker value that identifies the beginning of the list of queues to be returned with a listQueues request.
    The listQueues method returns a NextMarker element within the response if the list returned was not complete, which can be accessed with the ListQueuesResult.getNextMarker() method. This opaque value may then be set on a ListQueuesOptions instance with a call to setMarker to be used in a subsequent listQueues call to request the next portion of the list of queues.
    
    Parameters:
    
    marker - The String marker value to set.
    
    Returns:
    
    A reference to this ListQueuesOptions instance.
  - getMaxResults
```
public int getMaxResults()
```
    Gets the maximum number of queues to return with a listQueues request. If the value is not specified, the server will return up to 5,000 items.
    
    Returns:
    
    The maximum number of queues to return.
  - setMaxResults
```
public ListQueuesOptions setMaxResults(int maxResults)
```
    Sets the maximum number of queues to return with a listQueues request. If the value is not specified, by default the server will return up to 5,000 items.
    The maxResults value only affects calls made on methods where this ListQueuesOptions instance is passed as a parameter.
    
    Parameters:
    
    maxResults - The maximum number of queues to return.
    
    Returns:
    
    A reference to this ListQueuesOptions instance.
  - isIncludeMetadata
```
public boolean isIncludeMetadata()
```
    Gets a flag indicating whether to return metadata with a listQueues request.
    
    Returns:
    
    true to return metadata.
  - setIncludeMetadata
```
public ListQueuesOptions setIncludeMetadata(boolean includeMetadata)
```
    Sets a flag indicating whether to return metadata with a listQueues request.
    
    Parameters:
    
    includeMetadata - true to return metadata.
    
    Returns:
    
    A reference to this ListQueuesOptions 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 ListQueuesOptions

Constructor Summary

Method Summary

Methods inherited from class com.microsoft.windowsazure.services.queue.models.QueueServiceOptions

Methods inherited from class java.lang.Object

Constructor Detail

ListQueuesOptions

Method Detail

setTimeout

getPrefix

setPrefix

getMarker

setMarker

getMaxResults

setMaxResults

isIncludeMetadata

setIncludeMetadata