184 строки
14 KiB
YAML
184 строки
14 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions"
|
|
fullName: "com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions"
|
|
name: "ShareListFilesAndDirectoriesOptions"
|
|
nameWithType: "ShareListFilesAndDirectoriesOptions"
|
|
summary: "Extended options for a directory listing operation."
|
|
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 **ShareListFilesAndDirectoriesOptions**"
|
|
constructors:
|
|
- uid: "com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions.ShareListFilesAndDirectoriesOptions()"
|
|
fullName: "com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions.ShareListFilesAndDirectoriesOptions()"
|
|
name: "ShareListFilesAndDirectoriesOptions()"
|
|
nameWithType: "ShareListFilesAndDirectoriesOptions.ShareListFilesAndDirectoriesOptions()"
|
|
syntax: "public ShareListFilesAndDirectoriesOptions()"
|
|
methods:
|
|
- uid: "com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions.getMaxResultsPerPage()"
|
|
fullName: "com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions.getMaxResultsPerPage()"
|
|
name: "getMaxResultsPerPage()"
|
|
nameWithType: "ShareListFilesAndDirectoriesOptions.getMaxResultsPerPage()"
|
|
syntax: "public Integer getMaxResultsPerPage()"
|
|
returns:
|
|
description: "max results per page for this listing operation."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions.getPrefix()"
|
|
fullName: "com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions.getPrefix()"
|
|
name: "getPrefix()"
|
|
nameWithType: "ShareListFilesAndDirectoriesOptions.getPrefix()"
|
|
syntax: "public String getPrefix()"
|
|
returns:
|
|
description: "prefix for this listing operation."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions.includeAttributes()"
|
|
fullName: "com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions.includeAttributes()"
|
|
name: "includeAttributes()"
|
|
nameWithType: "ShareListFilesAndDirectoriesOptions.includeAttributes()"
|
|
syntax: "public boolean includeAttributes()"
|
|
returns:
|
|
description: "whether to include file attributes on this listing operation."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions.includeETag()"
|
|
fullName: "com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions.includeETag()"
|
|
name: "includeETag()"
|
|
nameWithType: "ShareListFilesAndDirectoriesOptions.includeETag()"
|
|
syntax: "public boolean includeETag()"
|
|
returns:
|
|
description: "whether to include the etag on this listing operation."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions.includeExtendedInfo()"
|
|
fullName: "com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions.includeExtendedInfo()"
|
|
name: "includeExtendedInfo()"
|
|
nameWithType: "ShareListFilesAndDirectoriesOptions.includeExtendedInfo()"
|
|
summary: "Note that setting timestamps, etag, attributes, or permission key will also set this option as true."
|
|
syntax: "public Boolean includeExtendedInfo()"
|
|
desc: "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:
|
|
description: "whether to include extended info on this listing operation."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions.includePermissionKey()"
|
|
fullName: "com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions.includePermissionKey()"
|
|
name: "includePermissionKey()"
|
|
nameWithType: "ShareListFilesAndDirectoriesOptions.includePermissionKey()"
|
|
syntax: "public boolean includePermissionKey()"
|
|
returns:
|
|
description: "whether to include the permission key on this listing operation."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions.includeTimestamps()"
|
|
fullName: "com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions.includeTimestamps()"
|
|
name: "includeTimestamps()"
|
|
nameWithType: "ShareListFilesAndDirectoriesOptions.includeTimestamps()"
|
|
syntax: "public boolean includeTimestamps()"
|
|
returns:
|
|
description: "whether to include timestamps on this listing operation."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions.setIncludeAttributes(boolean)"
|
|
fullName: "com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions.setIncludeAttributes(boolean includeAttributes)"
|
|
name: "setIncludeAttributes(boolean includeAttributes)"
|
|
nameWithType: "ShareListFilesAndDirectoriesOptions.setIncludeAttributes(boolean includeAttributes)"
|
|
parameters:
|
|
- description: "whether to include file attributes on this listing operation."
|
|
name: "includeAttributes"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareListFilesAndDirectoriesOptions setIncludeAttributes(boolean includeAttributes)"
|
|
returns:
|
|
description: "updated options"
|
|
type: "<xref href=\"com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions?alt=com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions&text=ShareListFilesAndDirectoriesOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions.setIncludeETag(boolean)"
|
|
fullName: "com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions.setIncludeETag(boolean includeETag)"
|
|
name: "setIncludeETag(boolean includeETag)"
|
|
nameWithType: "ShareListFilesAndDirectoriesOptions.setIncludeETag(boolean includeETag)"
|
|
parameters:
|
|
- description: "whether to include the etag on this listing operation."
|
|
name: "includeETag"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareListFilesAndDirectoriesOptions setIncludeETag(boolean includeETag)"
|
|
returns:
|
|
description: "updated options"
|
|
type: "<xref href=\"com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions?alt=com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions&text=ShareListFilesAndDirectoriesOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions.setIncludeExtendedInfo(java.lang.Boolean)"
|
|
fullName: "com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions.setIncludeExtendedInfo(Boolean includeExtendedInfo)"
|
|
name: "setIncludeExtendedInfo(Boolean includeExtendedInfo)"
|
|
nameWithType: "ShareListFilesAndDirectoriesOptions.setIncludeExtendedInfo(Boolean includeExtendedInfo)"
|
|
summary: "Note that setting timestamps, etag, attributes, or permission key will also set this option as true."
|
|
parameters:
|
|
- description: "whether to include extended info."
|
|
name: "includeExtendedInfo"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public ShareListFilesAndDirectoriesOptions setIncludeExtendedInfo(Boolean includeExtendedInfo)"
|
|
desc: "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."
|
|
returns:
|
|
description: "updated options."
|
|
type: "<xref href=\"com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions?alt=com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions&text=ShareListFilesAndDirectoriesOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions.setIncludePermissionKey(boolean)"
|
|
fullName: "com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions.setIncludePermissionKey(boolean includePermissionKey)"
|
|
name: "setIncludePermissionKey(boolean includePermissionKey)"
|
|
nameWithType: "ShareListFilesAndDirectoriesOptions.setIncludePermissionKey(boolean includePermissionKey)"
|
|
parameters:
|
|
- description: "whether to include the permission key on this listing operation."
|
|
name: "includePermissionKey"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareListFilesAndDirectoriesOptions setIncludePermissionKey(boolean includePermissionKey)"
|
|
returns:
|
|
description: "updated options"
|
|
type: "<xref href=\"com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions?alt=com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions&text=ShareListFilesAndDirectoriesOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions.setIncludeTimestamps(boolean)"
|
|
fullName: "com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions.setIncludeTimestamps(boolean includeTimestamps)"
|
|
name: "setIncludeTimestamps(boolean includeTimestamps)"
|
|
nameWithType: "ShareListFilesAndDirectoriesOptions.setIncludeTimestamps(boolean includeTimestamps)"
|
|
parameters:
|
|
- description: "whether to include timestamps on this listing operation."
|
|
name: "includeTimestamps"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareListFilesAndDirectoriesOptions setIncludeTimestamps(boolean includeTimestamps)"
|
|
returns:
|
|
description: "updated options"
|
|
type: "<xref href=\"com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions?alt=com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions&text=ShareListFilesAndDirectoriesOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions.setMaxResultsPerPage(java.lang.Integer)"
|
|
fullName: "com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions.setMaxResultsPerPage(Integer maxResultsPerPage)"
|
|
name: "setMaxResultsPerPage(Integer maxResultsPerPage)"
|
|
nameWithType: "ShareListFilesAndDirectoriesOptions.setMaxResultsPerPage(Integer maxResultsPerPage)"
|
|
summary: "Sets the max results per page for a listing operation."
|
|
parameters:
|
|
- description: "the max results per page."
|
|
name: "maxResultsPerPage"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public ShareListFilesAndDirectoriesOptions setMaxResultsPerPage(Integer maxResultsPerPage)"
|
|
desc: "Sets the max results per page for a listing operation."
|
|
returns:
|
|
description: "updated options."
|
|
type: "<xref href=\"com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions?alt=com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions&text=ShareListFilesAndDirectoriesOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions.setPrefix(java.lang.String)"
|
|
fullName: "com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions.setPrefix(String prefix)"
|
|
name: "setPrefix(String prefix)"
|
|
nameWithType: "ShareListFilesAndDirectoriesOptions.setPrefix(String prefix)"
|
|
summary: "Sets the prefix for a listing operation."
|
|
parameters:
|
|
- description: "the prefix."
|
|
name: "prefix"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ShareListFilesAndDirectoriesOptions setPrefix(String prefix)"
|
|
desc: "Sets the prefix for a listing operation."
|
|
returns:
|
|
description: "updated options."
|
|
type: "<xref href=\"com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions?alt=com.azure.storage.file.share.options.ShareListFilesAndDirectoriesOptions&text=ShareListFilesAndDirectoriesOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Extended options for a directory listing operation."
|
|
metadata: {}
|
|
package: "com.azure.storage.file.share.options"
|
|
artifact: com.azure:azure-storage-file-share:12.24.0
|