FileSystemListDetails Class

  • Reference
Package:
com.azure.storage.file.datalake.models
Maven Artifact:
com.azure:azure-storage-file-datalake:12.21.0
  • java.lang.Object
    • com.azure.storage.file.datalake.models.FileSystemListDetails

public final class FileSystemListDetails

This type allows users to specify additional information the service should return with each file system when listing file systems in an account (via a DataLakeServiceAsyncClient object). This type is immutable to ensure thread-safety of requests, so changing the details for a different listing operation requires construction of a new object. Null may be passed if none of the options are desirable.

Constructor Summary

Constructor Description
FileSystemListDetails()

Creates a new instance of FileSystemListDetails.

Method Summary

Modifier and Type Method and Description
boolean getRetrieveDeleted()

Whether deleted file systems should be returned.
boolean getRetrieveMetadata()

Whether metadata should be returned.
boolean getRetrieveSystemFileSystems()

Whether system fileSystems should be returned.
FileSystemListDetails setRetrieveDeleted(boolean retrieveDeleted)

Whether deleted file systems should be returned.
FileSystemListDetails setRetrieveMetadata(boolean retrieveMetadata)

Whether metadata should be returned.
FileSystemListDetails setRetrieveSystemFileSystems(boolean retrieveSystemFileSystems)

Whether system fileSystems should be returned.
ListFileSystemsIncludeType toIncludeType()

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

FileSystemListDetails

public FileSystemListDetails()

Creates a new instance of FileSystemListDetails.

Method Details

getRetrieveDeleted

public boolean getRetrieveDeleted()

Whether deleted file systems should be returned.

Returns:

a flag indicating whether deleted file systems should be returned

getRetrieveMetadata

public boolean getRetrieveMetadata()

Whether metadata should be returned.

Returns:

a flag indicating whether metadata should be returned in the listing

getRetrieveSystemFileSystems

public boolean getRetrieveSystemFileSystems()

Whether system fileSystems should be returned.

Returns:

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

setRetrieveDeleted

public FileSystemListDetails setRetrieveDeleted(boolean retrieveDeleted)

Whether deleted file systems should be returned.

Parameters:

retrieveDeleted - Flag indicating whether deleted file systems should be returned.

Returns:

the updated FileSystemListDetails object

setRetrieveMetadata

public FileSystemListDetails setRetrieveMetadata(boolean retrieveMetadata)

Whether metadata should be returned.

Parameters:

retrieveMetadata - Flag indicating whether metadata should be returned

Returns:

the updated FileSystemListDetails object

setRetrieveSystemFileSystems

public FileSystemListDetails setRetrieveSystemFileSystems(boolean retrieveSystemFileSystems)

Whether system fileSystems should be returned.

Parameters:

retrieveSystemFileSystems - Flag indicating whether system fileSystems should be returned

Returns:

the updated FileSystemListDetails object

toIncludeType

public ListFileSystemsIncludeType toIncludeType()

Returns:

the listing flags

Applies to