public class ListContainersResult extends Object
BlobContract.listContainers() and
BlobContract.listContainers(ListContainersOptions).
See the List Containers documentation on MSDN for details of the underlying Blob Service REST API operation.
| Modifier and Type | Class and Description |
|---|---|
static class |
ListContainersResult.Container
Represents a container for blob storage returned by the server.
|
static class |
ListContainersResult.ContainerProperties
Represents the properties of a container for blob storage returned by the
server.
|
| Constructor and Description |
|---|
ListContainersResult() |
| Modifier and Type | Method and Description |
|---|---|
String |
getAccountName()
Gets the base URI for invoking Blob Service REST API operations on the
storage account.
|
List<ListContainersResult.Container> |
getContainers()
Gets the container list returned in the response.
|
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 number of container list items to return that was
specified in the request.
|
String |
getNextMarker()
Gets the next marker value needed to specify the beginning of the next
portion of the container 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 containers beginning
with the prefix.
|
void |
setAccountName(String accountName)
Reserved for internal use.
|
void |
setContainers(List<ListContainersResult.Container> value)
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.
|
public List<ListContainersResult.Container> getContainers()
List of ListContainersResult.Container instances representing the
blob containers returned by the request.public void setContainers(List<ListContainersResult.Container> value)
This method is invoked by the API to set the value from the Blob Service REST API operation response returned by the server.
value - A List of ListContainersResult.Container instances representing the
blob containers returned by the request.public String getAccountName()
String containing the base URI for Blob Service REST
API operations on the storage account.public void setAccountName(String accountName)
This method is invoked by the API to set the value from the Blob Service REST API operation response returned by the server.
accountName - A String containing the base URI for Blob Service REST
API operations on the storage account.public String getPrefix()
String containing the prefix used to filter the
container names returned, if any.public void setPrefix(String prefix)
This method is invoked by the API to set the value from the Blob Service REST API operation response returned by the server.
prefix - A String containing the prefix used to filter the
container names returned, if any.public String getMarker()
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
to get the marker value to set on a ListContainersOptions
instance using a call to ListContainersOptions.setMarker(String).
Pass the ListContainersOptions instance as a parameter to a
BlobContract.listContainers(ListContainersOptions) call to get
the next portion of the container list.
String containing the marker used to specify the
beginning of the container list returned, if any.public void setMarker(String marker)
This method is invoked by the API to set the value from the Blob Service REST API operation response returned by the server.
marker - A String containing the marker used to specify the
beginning of the container list returned.public String getNextMarker()
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
to get the marker value to set on a ListContainersOptions
instance using a call to ListContainersOptions.setMarker(String).
Pass the ListContainersOptions instance as a parameter to a
BlobContract.listContainers(ListContainersOptions) call to get
the next portion of the container list.
String containing the next marker value needed to
specify the beginning of the next portion of the container list
to return, if any was set in the response from the server.public void setNextMarker(String nextMarker)
This method is invoked by the API to set the value from the Blob Service REST API operation response returned by the server.
nextMarker - A String containing the next marker value needed to
specify the beginning of the next portion of the container
list to return.public int getMaxResults()
Use the getNextMarker method
to get the marker value to set on a ListContainersOptions
instance using a call to ListContainersOptions.setMarker(String).
Pass the ListContainersOptions instance as a parameter to a
BlobContract.listContainers(ListContainersOptions) call to get
the next portion of the container list.
public void setMaxResults(int maxResults)
This method is invoked by the API to set the value from the Blob Service REST API operation response returned by the server.
maxResults - The maximum number of container list items to return that was
specified in the request, if any./**
* 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.
*/