com.azure.storage.file.share.models.ShareFileItem.yml

### YamlMime:JavaType
uid: "com.azure.storage.file.share.models.ShareFileItem"
fullName: "com.azure.storage.file.share.models.ShareFileItem"
name: "ShareFileItem"
nameWithType: "ShareFileItem"
summary: "Contains file or directory reference information in the storage File service."
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 **ShareFileItem**"
constructors:
- uid: "com.azure.storage.file.share.models.ShareFileItem.ShareFileItem(java.lang.String,boolean,java.lang.Long)"
  fullName: "com.azure.storage.file.share.models.ShareFileItem.ShareFileItem(String name, boolean isDirectory, Long fileSize)"
  name: "ShareFileItem(String name, boolean isDirectory, Long fileSize)"
  nameWithType: "ShareFileItem.ShareFileItem(String name, boolean isDirectory, Long fileSize)"
  summary: "Creates an instance of file or directory reference information about a specific Share."
  parameters:
  - description: "Name of the file or the directory."
    name: "name"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "A boolean set to true if the reference is a directory, false if the reference is a file."
    name: "isDirectory"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
  - description: "Size of a file. Pass <code>null</code> if the reference is a directory."
    name: "fileSize"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
  syntax: "public ShareFileItem(String name, boolean isDirectory, Long fileSize)"
  desc: "Creates an instance of file or directory reference information about a specific Share."
- uid: "com.azure.storage.file.share.models.ShareFileItem.ShareFileItem(java.lang.String,boolean,java.lang.String,com.azure.storage.file.share.models.ShareFileItemProperties,java.util.EnumSet<com.azure.storage.file.share.models.NtfsFileAttributes>,java.lang.String,java.lang.Long)"
  fullName: "com.azure.storage.file.share.models.ShareFileItem.ShareFileItem(String name, boolean isDirectory, String id, ShareFileItemProperties properties, EnumSet<NtfsFileAttributes> fileAttributes, String permissionKey, Long fileSize)"
  name: "ShareFileItem(String name, boolean isDirectory, String id, ShareFileItemProperties properties, EnumSet<NtfsFileAttributes> fileAttributes, String permissionKey, Long fileSize)"
  nameWithType: "ShareFileItem.ShareFileItem(String name, boolean isDirectory, String id, ShareFileItemProperties properties, EnumSet<NtfsFileAttributes> fileAttributes, String permissionKey, Long fileSize)"
  summary: "Creates an instance of file or directory reference information about a specific Share."
  parameters:
  - description: "Name of the file or the directory."
    name: "name"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "A boolean set to true if the reference is a directory, false if the reference is a file."
    name: "isDirectory"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
  - description: "ID of the file or directory."
    name: "id"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "Properties of the file or directory."
    name: "properties"
    type: "<xref href=\"com.azure.storage.file.share.models.ShareFileItemProperties?alt=com.azure.storage.file.share.models.ShareFileItemProperties&text=ShareFileItemProperties\" data-throw-if-not-resolved=\"False\" />"
  - description: "NTFS attributes of the file or directory."
    name: "fileAttributes"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html\">EnumSet</a>&lt;<xref href=\"com.azure.storage.file.share.models.NtfsFileAttributes?alt=com.azure.storage.file.share.models.NtfsFileAttributes&text=NtfsFileAttributes\" data-throw-if-not-resolved=\"False\" />&gt;"
  - description: "Permission key of the file or directory."
    name: "permissionKey"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "Size of a file. Pass <code>null</code> if the reference is a directory."
    name: "fileSize"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
  syntax: "public ShareFileItem(String name, boolean isDirectory, String id, ShareFileItemProperties properties, EnumSet<NtfsFileAttributes> fileAttributes, String permissionKey, Long fileSize)"
  desc: "Creates an instance of file or directory reference information about a specific Share."
methods:
- uid: "com.azure.storage.file.share.models.ShareFileItem.getFileAttributes()"
  fullName: "com.azure.storage.file.share.models.ShareFileItem.getFileAttributes()"
  name: "getFileAttributes()"
  nameWithType: "ShareFileItem.getFileAttributes()"
  summary: "Gets the NTFS attributes of the file or directory."
  syntax: "public EnumSet<NtfsFileAttributes> getFileAttributes()"
  desc: "Gets the NTFS attributes of the file or directory."
  returns:
    description: "NTFS attributes of the file or directory."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html\">EnumSet</a>&lt;<xref href=\"com.azure.storage.file.share.models.NtfsFileAttributes?alt=com.azure.storage.file.share.models.NtfsFileAttributes&text=NtfsFileAttributes\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.storage.file.share.models.ShareFileItem.getFileSize()"
  fullName: "com.azure.storage.file.share.models.ShareFileItem.getFileSize()"
  name: "getFileSize()"
  nameWithType: "ShareFileItem.getFileSize()"
  summary: "Gets the size of a file, `null` if the reference is a directory."
  syntax: "public Long getFileSize()"
  desc: "Gets the size of a file, `null` if the reference is a directory."
  returns:
    description: "Size of a file, <code>null</code> if the reference is a directory."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
- uid: "com.azure.storage.file.share.models.ShareFileItem.getId()"
  fullName: "com.azure.storage.file.share.models.ShareFileItem.getId()"
  name: "getId()"
  nameWithType: "ShareFileItem.getId()"
  summary: "Gets the ID of the file or directory."
  syntax: "public String getId()"
  desc: "Gets the ID of the file or directory."
  returns:
    description: "ID of the file or directory."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.file.share.models.ShareFileItem.getName()"
  fullName: "com.azure.storage.file.share.models.ShareFileItem.getName()"
  name: "getName()"
  nameWithType: "ShareFileItem.getName()"
  summary: "Gets the name of the file or the directory."
  syntax: "public String getName()"
  desc: "Gets the name of the file or the directory."
  returns:
    description: "Name of the file or the directory."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.file.share.models.ShareFileItem.getPermissionKey()"
  fullName: "com.azure.storage.file.share.models.ShareFileItem.getPermissionKey()"
  name: "getPermissionKey()"
  nameWithType: "ShareFileItem.getPermissionKey()"
  summary: "Gets the permission key of the file or directory."
  syntax: "public String getPermissionKey()"
  desc: "Gets the permission key of the file or directory."
  returns:
    description: "Permission key of the file or directory."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.file.share.models.ShareFileItem.getProperties()"
  fullName: "com.azure.storage.file.share.models.ShareFileItem.getProperties()"
  name: "getProperties()"
  nameWithType: "ShareFileItem.getProperties()"
  summary: "Gets the properties of the file or directory."
  syntax: "public ShareFileItemProperties getProperties()"
  desc: "Gets the properties of the file or directory."
  returns:
    description: "Properties of the file or directory."
    type: "<xref href=\"com.azure.storage.file.share.models.ShareFileItemProperties?alt=com.azure.storage.file.share.models.ShareFileItemProperties&text=ShareFileItemProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.share.models.ShareFileItem.isDirectory()"
  fullName: "com.azure.storage.file.share.models.ShareFileItem.isDirectory()"
  name: "isDirectory()"
  nameWithType: "ShareFileItem.isDirectory()"
  summary: "Gets a boolean set to true if the reference is a directory, false if the reference is a file."
  syntax: "public boolean isDirectory()"
  desc: "Gets a boolean set to true if the reference is a directory, false if the reference is a file."
  returns:
    description: "True if the reference is a directory, or false if the reference is a file."
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Contains file or directory reference information in the storage File service."
metadata: {}
package: "com.azure.storage.file.share.models"
artifact: com.azure:azure-storage-file-share:12.23.0