Package com.azure.storage.file.share.options

Class ShareListFilesAndDirectoriesOptions

  • public final class ShareListFilesAndDirectoriesOptions
extends Object
    Extended options for a directory listing operation.

    • Constructor Detail

      • ShareListFilesAndDirectoriesOptions

        public ShareListFilesAndDirectoriesOptions()

    • Method Detail

      • getPrefix

        public String getPrefix()
        Returns:
        prefix for this listing operation.

      • getMaxResultsPerPage

        public Integer getMaxResultsPerPage()
        Returns:
        max results per page for this listing operation.

      • setMaxResultsPerPage

        public ShareListFilesAndDirectoriesOptions setMaxResultsPerPage​(Integer maxResultsPerPage)
        Sets the max results per page for a listing operation.
        Parameters:
        maxResultsPerPage - the max results per page.
        Returns:
        updated options.

      • includeExtendedInfo

        public Boolean includeExtendedInfo()
        Note that setting timestamps, etag, attributes, or permission key will also set this option as true. Attempting to set it back to false while any of these options are true will be unsuccessful. Including extended info in a listing operation can result in a more expensive operation, but will present more accurate information on the listing item.
        Returns:
        whether to include extended info on this listing operation.

      • setIncludeExtendedInfo

        public ShareListFilesAndDirectoriesOptions setIncludeExtendedInfo​(Boolean includeExtendedInfo)
        Note that setting timestamps, etag, attributes, or permission key will also set this option as true. Attempting to set it back to false will be unsuccessful. Sets the prefix for a listing operation. Including extended info in a listing operation can result in a more expensive operation, but will present more accurate information on the listing item.
        Parameters:
        includeExtendedInfo - whether to include extended info.
        Returns:
        updated options.
        Throws:
        IllegalStateException - Throws when attempting to set null when other parameters require it to be true.

      • includeTimestamps

        public boolean includeTimestamps()
        Returns:
        whether to include timestamps on this listing operation.

      • setIncludeTimestamps

        public ShareListFilesAndDirectoriesOptions setIncludeTimestamps​(boolean includeTimestamps)
        Parameters:
        includeTimestamps - whether to include timestamps on this listing operation.
        Returns:
        updated options

      • includeETag

        public boolean includeETag()
        Returns:
        whether to include the etag on this listing operation.

      • setIncludeETag

        public ShareListFilesAndDirectoriesOptions setIncludeETag​(boolean includeETag)
        Parameters:
        includeETag - whether to include the etag on this listing operation.
        Returns:
        updated options

      • includeAttributes

        public boolean includeAttributes()
        Returns:
        whether to include file attributes on this listing operation.

      • setIncludeAttributes

        public ShareListFilesAndDirectoriesOptions setIncludeAttributes​(boolean includeAttributes)
        Parameters:
        includeAttributes - whether to include file attributes on this listing operation.
        Returns:
        updated options

      • includePermissionKey

        public boolean includePermissionKey()
        Returns:
        whether to include the permission key on this listing operation.

      • setIncludePermissionKey

        public ShareListFilesAndDirectoriesOptions setIncludePermissionKey​(boolean includePermissionKey)
        Parameters:
        includePermissionKey - whether to include the permission key on this listing operation.
        Returns:
        updated options