com.azure.storage.blob.models.BlobContainerListDetails.yml

### YamlMime:JavaType
uid: "com.azure.storage.blob.models.BlobContainerListDetails"
fullName: "com.azure.storage.blob.models.BlobContainerListDetails"
name: "BlobContainerListDetails"
nameWithType: "BlobContainerListDetails"
summary: "This type allows users to specify additional information the service should return with each container when listing containers in an account (via a <xref uid=\"com.azure.storage.blob.BlobServiceClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobServiceClient\"></xref> object)."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **BlobContainerListDetails**"
constructors:
- uid: "com.azure.storage.blob.models.BlobContainerListDetails.BlobContainerListDetails()"
  fullName: "com.azure.storage.blob.models.BlobContainerListDetails.BlobContainerListDetails()"
  name: "BlobContainerListDetails()"
  nameWithType: "BlobContainerListDetails.BlobContainerListDetails()"
  summary: "Constructs an unpopulated <xref uid=\"com.azure.storage.blob.models.BlobContainerListDetails\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobContainerListDetails\"></xref>."
  syntax: "public BlobContainerListDetails()"
  desc: "Constructs an unpopulated <xref uid=\"com.azure.storage.blob.models.BlobContainerListDetails\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobContainerListDetails\"></xref>."
methods:
- uid: "com.azure.storage.blob.models.BlobContainerListDetails.getRetrieveDeleted()"
  fullName: "com.azure.storage.blob.models.BlobContainerListDetails.getRetrieveDeleted()"
  name: "getRetrieveDeleted()"
  nameWithType: "BlobContainerListDetails.getRetrieveDeleted()"
  summary: "Whether deleted containers should be returned."
  syntax: "public boolean getRetrieveDeleted()"
  desc: "Whether deleted containers should be returned."
  returns:
    description: "a flag indicating whether deleted containers should be returned"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobContainerListDetails.getRetrieveMetadata()"
  fullName: "com.azure.storage.blob.models.BlobContainerListDetails.getRetrieveMetadata()"
  name: "getRetrieveMetadata()"
  nameWithType: "BlobContainerListDetails.getRetrieveMetadata()"
  summary: "Whether metadata should be returned."
  syntax: "public boolean getRetrieveMetadata()"
  desc: "Whether metadata should be returned."
  returns:
    description: "a flag indicating whether metadata should be returned in the listing"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobContainerListDetails.getRetrieveSystemContainers()"
  fullName: "com.azure.storage.blob.models.BlobContainerListDetails.getRetrieveSystemContainers()"
  name: "getRetrieveSystemContainers()"
  nameWithType: "BlobContainerListDetails.getRetrieveSystemContainers()"
  summary: "Whether system containers should be returned."
  syntax: "public boolean getRetrieveSystemContainers()"
  desc: "Whether system containers should be returned."
  returns:
    description: "a flag indicating whether system containers should be returned in the listing"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobContainerListDetails.setRetrieveDeleted(boolean)"
  fullName: "com.azure.storage.blob.models.BlobContainerListDetails.setRetrieveDeleted(boolean retrieveDeleted)"
  name: "setRetrieveDeleted(boolean retrieveDeleted)"
  nameWithType: "BlobContainerListDetails.setRetrieveDeleted(boolean retrieveDeleted)"
  summary: "Whether deleted containers should be returned."
  parameters:
  - description: "Flag indicating whether deleted containers should be returned."
    name: "retrieveDeleted"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public BlobContainerListDetails setRetrieveDeleted(boolean retrieveDeleted)"
  desc: "Whether deleted containers should be returned."
  returns:
    description: "the updated ContainerListDetails object"
    type: "<xref href=\"com.azure.storage.blob.models.BlobContainerListDetails?alt=com.azure.storage.blob.models.BlobContainerListDetails&text=BlobContainerListDetails\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobContainerListDetails.setRetrieveMetadata(boolean)"
  fullName: "com.azure.storage.blob.models.BlobContainerListDetails.setRetrieveMetadata(boolean retrieveMetadata)"
  name: "setRetrieveMetadata(boolean retrieveMetadata)"
  nameWithType: "BlobContainerListDetails.setRetrieveMetadata(boolean retrieveMetadata)"
  summary: "Whether metadata should be returned."
  parameters:
  - description: "Flag indicating whether metadata should be returned"
    name: "retrieveMetadata"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public BlobContainerListDetails setRetrieveMetadata(boolean retrieveMetadata)"
  desc: "Whether metadata should be returned."
  returns:
    description: "the updated ContainerListDetails object"
    type: "<xref href=\"com.azure.storage.blob.models.BlobContainerListDetails?alt=com.azure.storage.blob.models.BlobContainerListDetails&text=BlobContainerListDetails\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobContainerListDetails.setRetrieveSystemContainers(boolean)"
  fullName: "com.azure.storage.blob.models.BlobContainerListDetails.setRetrieveSystemContainers(boolean retrieveSystemContainers)"
  name: "setRetrieveSystemContainers(boolean retrieveSystemContainers)"
  nameWithType: "BlobContainerListDetails.setRetrieveSystemContainers(boolean retrieveSystemContainers)"
  summary: "Whether system containers should be returned."
  parameters:
  - description: "Flag indicating whether system containers should be returned"
    name: "retrieveSystemContainers"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public BlobContainerListDetails setRetrieveSystemContainers(boolean retrieveSystemContainers)"
  desc: "Whether system containers should be returned."
  returns:
    description: "the updated ContainerListDetails object"
    type: "<xref href=\"com.azure.storage.blob.models.BlobContainerListDetails?alt=com.azure.storage.blob.models.BlobContainerListDetails&text=BlobContainerListDetails\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobContainerListDetails.toIncludeType()"
  fullName: "com.azure.storage.blob.models.BlobContainerListDetails.toIncludeType()"
  name: "toIncludeType()"
  nameWithType: "BlobContainerListDetails.toIncludeType()"
  deprecatedTag: "<xref uid=\"com.azure.storage.blob.models.BlobContainerListDetails\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobContainerListDetails\"></xref> now contains multiple options. This will only convert result of \\{<xref uid=\"com.azure.storage.blob.models.BlobContainerListDetails.setRetrieveMetadata(boolean)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#setRetrieveMetadata(boolean)\"></xref>\\} for backwards compatibility."
  syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public ListBlobContainersIncludeType toIncludeType()"
  hasDeprecatedTag: true
  returns:
    description: "the listing flags"
    type: "<xref href=\"com.azure.storage.blob.models.ListBlobContainersIncludeType?alt=com.azure.storage.blob.models.ListBlobContainersIncludeType&text=ListBlobContainersIncludeType\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "This type allows users to specify additional information the service should return with each container when listing containers in an account (via a <xref uid=\"com.azure.storage.blob.BlobServiceClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobServiceClient\"></xref> object). Null may be passed if none of the options are desirable."
metadata: {}
package: "com.azure.storage.blob.models"
artifact: com.azure:azure-storage-blob:12.26.1