public class ListQueuesResult extends Object
QueueContract.listQueues() and
QueueContract.listQueues(ListQueuesOptions).
See the List Queues documentation on MSDN for details of the underlying Queue service REST API operation.
| Modifier and Type | Class and Description |
|---|---|
static class |
ListQueuesResult.Queue
Represents a queue in the storage account returned by the server.
|
| Constructor and Description |
|---|
ListQueuesResult() |
| Modifier and Type | Method and Description |
|---|---|
String |
getAccountName()
Gets the base URI for Queue service REST API operations on the storage
account.
|
String |
getMarker()
Gets the marker value for the beginning of the queue results returned by
the
listQueues
request. |
int |
getMaxResults()
Gets the value specified for the number of queue results to return for
the
listQueues
request. |
String |
getNextMarker()
Gets the next marker value needed to retrieve additional queues.
|
String |
getPrefix()
Gets the prefix
String used to qualify the results returned by
the listQueues
request. |
List<ListQueuesResult.Queue> |
getQueues()
Gets the list of queues returned by a
QueueContract
.listQueues request. |
void |
setAccountName(String accountName)
Reserved for internal use.
|
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.
|
void |
setQueues(List<ListQueuesResult.Queue> value)
Reserved for internal use.
|
public List<ListQueuesResult.Queue> getQueues()
QueueContract
.listQueues request.List of ListQueuesResult.Queue instances representing the queues
returned by the request.public void setQueues(List<ListQueuesResult.Queue> value)
QueueContract.listQueues request. This method is invoked
by the API as part of the response generation from the Queue service REST
API operation to set the value from the queue list returned by the
server.value - A List of ListQueuesResult.Queue instances representing the
queues returned by the request.public String getAccountName()
String containing the base URI for Queue service REST
API operations on the storage account.public void setAccountName(String accountName)
accountName - A String containing the base URI for Queue service
REST API operations on the storage account.public String getPrefix()
String used to qualify the results returned by
the listQueues
request. Only queues with names that start with the prefix are returned
by the request. By default, the prefix is empty and all queues are
returned.String prefix used to qualify the names of the queues
returned.public void setPrefix(String prefix)
String used to qualify
the results returned by the Queue service REST API list queues operation
invoked with a call to
listQueues. This
method is invoked by the API as part of the response generation from the
Queue service REST API operation to set the value from the
Prefix element returned by the server.prefix - The String prefix used to qualify the names of the
queues returned.public String getMarker()
listQueues
request. The marker is used by the server to specify the place to resume
a query for queues. The marker value is a String opaque to the
client. A listQueues
request response may include a NextMarker value if there
are more queue results than can be returned in a single response. Call
the getNextMarker method to get
this value. The client can request the next set of queue results by
setting the marker to this value in the ListQueuesOptions
parameter. By default, this value is empty and the server responds with
the first queues that match the request.String containing the marker value used for the
response.public void setMarker(String marker)
listQueues. This
method is invoked by the API as part of the response generation from the
Queue service REST API operation to set the value from the
Marker element returned by the server.marker - A String containing the marker value used for the
response.public String getNextMarker()
ListQueuesOptions parameter. This
value is empty if there are no more queues that satisfy the request than
are included in the response.String containing the marker value to use to resume the
list queues request.public void setNextMarker(String nextMarker)
nextMarker - A String containing the marker value to use to resume
the list queues request.public int getMaxResults()
listQueues
request. The server will not return more than this number of queues in
the response. If the value is not specified, the server will return up to
5,000 items.
If there are more queues available that match the request than the number
returned, the response will include a next marker value to specify the
beginning of the queues to return in a subsequent request. Call the
getNextMarker method to get this
value. The client can request the next set of queue results by setting
the marker to this value in the ListQueuesOptions parameter.
public void setMaxResults(int maxResults)
maxResults - The maximum number of results to return specified by the
request./**
* 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.
*/