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 Details

  • Method Details

    • 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.
      Gets the listing flags.
      Returns:
      the listing flags