Package com.azure.storage.blob.models

Class BlobContainerListDetails

java.lang.Object

com.azure.storage.blob.models.BlobContainerListDetails

public final class BlobContainerListDetails
extends Object

This type allows users to specify additional information the service should return with each container when listing containers in an account (via a BlobServiceClient object). Null may be passed if none of the options are desirable.

Constructor Summary

Constructors

Constructor	Description
BlobContainerListDetails()	Constructs an unpopulated BlobContainerListDetails.

Method Summary

Modifier and Type	Method	Description
boolean	getRetrieveDeleted()	Whether deleted containers should be returned.
boolean	getRetrieveMetadata()	Whether metadata should be returned.
boolean	getRetrieveSystemContainers()	Whether system containers should be returned.
BlobContainerListDetails	setRetrieveDeleted(boolean retrieveDeleted)	Whether deleted containers should be returned.
BlobContainerListDetails	setRetrieveMetadata(boolean retrieveMetadata)	Whether metadata should be returned.
BlobContainerListDetails	setRetrieveSystemContainers(boolean retrieveSystemContainers)	Whether system containers should be returned.
ListBlobContainersIncludeType	toIncludeType()	Deprecated. BlobContainerListDetails now contains multiple options.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BlobContainerListDetails

public BlobContainerListDetails()

Constructs an unpopulated BlobContainerListDetails.

Method Detail

getRetrieveMetadata

public boolean getRetrieveMetadata()

Whether metadata should be returned.

Returns:

a flag indicating whether metadata should be returned in the listing

setRetrieveMetadata

public BlobContainerListDetails setRetrieveMetadata(boolean retrieveMetadata)

Whether metadata should be returned.

Parameters:

retrieveMetadata - Flag indicating whether metadata should be returned

Returns:

the updated ContainerListDetails object

getRetrieveDeleted

public boolean getRetrieveDeleted()

Whether deleted containers should be returned.

Returns:

a flag indicating whether deleted containers should be returned

setRetrieveDeleted

public BlobContainerListDetails setRetrieveDeleted(boolean retrieveDeleted)

Whether deleted containers should be returned.

Parameters:

retrieveDeleted - Flag indicating whether deleted containers should be returned.

Returns:

the updated ContainerListDetails object

getRetrieveSystemContainers

public boolean getRetrieveSystemContainers()

Whether system containers should be returned.

Returns:

a flag indicating whether system containers should be returned in the listing

setRetrieveSystemContainers

public BlobContainerListDetails setRetrieveSystemContainers(boolean retrieveSystemContainers)

Whether system containers should be returned.

Parameters:

retrieveSystemContainers - Flag indicating whether system containers should be returned

Returns:

the updated ContainerListDetails object

toIncludeType

@Deprecated
public ListBlobContainersIncludeType toIncludeType()

Deprecated.

BlobContainerListDetails now contains multiple options. This will only convert result of {setRetrieveMetadata(boolean)} for backwards compatibility.

Returns:

the listing flags