Package com.azure.storage.file.share.models

Class HandleItem

java.lang.Object
com.azure.storage.file.share.models.HandleItem
All Implemented Interfaces:
com.azure.xml.XmlSerializable<HandleItem>
public final class HandleItem extends Object implements com.azure.xml.XmlSerializable<HandleItem>
A listed Azure Storage handle item.

  • Constructor Details

    • HandleItem

      public HandleItem()
      Creates an instance of HandleItem class.

  • Method Details

    • getHandleId

      public String getHandleId()
      Get the handleId property: XSMB service handle ID.
      Returns:
      the handleId value.

    • setHandleId

      public HandleItem setHandleId(String handleId)
      Set the handleId property: XSMB service handle ID.
      Parameters:
      handleId - the handleId value to set.
      Returns:
      the HandleItem object itself.

    • getPath

      public String getPath()
      Get the path property: File or directory name including full path starting from share root.
      Returns:
      the path value.

    • setPath

      public HandleItem setPath(String path)
      Set the path property: File or directory name including full path starting from share root.
      Parameters:
      path - the path value to set.
      Returns:
      the HandleItem object itself.

    • getFileId

      public String getFileId()
      Get the fileId property: FileId uniquely identifies the file or directory.
      Returns:
      the fileId value.

    • setFileId

      public HandleItem setFileId(String fileId)
      Set the fileId property: FileId uniquely identifies the file or directory.
      Parameters:
      fileId - the fileId value to set.
      Returns:
      the HandleItem object itself.

    • getParentId

      public String getParentId()
      Get the parentId property: ParentId uniquely identifies the parent directory of the object.
      Returns:
      the parentId value.

    • setParentId

      public HandleItem setParentId(String parentId)
      Set the parentId property: ParentId uniquely identifies the parent directory of the object.
      Parameters:
      parentId - the parentId value to set.
      Returns:
      the HandleItem object itself.

    • getSessionId

      public String getSessionId()
      Get the sessionId property: SMB session ID in context of which the file handle was opened.
      Returns:
      the sessionId value.

    • setSessionId

      public HandleItem setSessionId(String sessionId)
      Set the sessionId property: SMB session ID in context of which the file handle was opened.
      Parameters:
      sessionId - the sessionId value to set.
      Returns:
      the HandleItem object itself.

    • getClientIp

      public String getClientIp()
      Get the clientIp property: Client IP that opened the handle.
      Returns:
      the clientIp value.

    • setClientIp

      public HandleItem setClientIp(String clientIp)
      Set the clientIp property: Client IP that opened the handle.
      Parameters:
      clientIp - the clientIp value to set.
      Returns:
      the HandleItem object itself.

    • getOpenTime

      public OffsetDateTime getOpenTime()
      Get the openTime property: Time when the session that previously opened the handle has last been reconnected. (UTC).
      Returns:
      the openTime value.

    • setOpenTime

      public HandleItem setOpenTime(OffsetDateTime openTime)
      Set the openTime property: Time when the session that previously opened the handle has last been reconnected. (UTC).
      Parameters:
      openTime - the openTime value to set.
      Returns:
      the HandleItem object itself.

    • getLastReconnectTime

      public OffsetDateTime getLastReconnectTime()
      Get the lastReconnectTime property: Time handle was last connected to (UTC).
      Returns:
      the lastReconnectTime value.

    • setLastReconnectTime

      public HandleItem setLastReconnectTime(OffsetDateTime lastReconnectTime)
      Set the lastReconnectTime property: Time handle was last connected to (UTC).
      Parameters:
      lastReconnectTime - the lastReconnectTime value to set.
      Returns:
      the HandleItem object itself.

    • getAccessRights

      public List<ShareFileHandleAccessRights> getAccessRights()
      Get the accessRights property: The ShareFileHandleAccessRights property.
      Returns:
      the accessRights list value.

    • setAccessRights

      public HandleItem setAccessRights(List<ShareFileHandleAccessRights> accessRights)
      Set the accessRights property: The ShareFileHandleAccessRights property.
      Parameters:
      accessRights - the accessRights list to set.
      Returns:
      the HandleItem object itself.

    • getClientName

      public String getClientName()
      Get the clientName property: Name of the client machine where the share is being mounted.
      Returns:
      the clientName value.

    • setClientName

      public HandleItem setClientName(String clientName)
      Set the clientName property: Name of the client machine where the share is being mounted.
      Parameters:
      clientName - the clientName value to set.
      Returns:
      the HandleItem object itself.

    • toXml

      public com.azure.xml.XmlWriter toXml(com.azure.xml.XmlWriter xmlWriter) throws XMLStreamException
      Specified by:
      toXml in interface com.azure.xml.XmlSerializable<HandleItem>
      Throws:
      XMLStreamException

    • toXml

      public com.azure.xml.XmlWriter toXml(com.azure.xml.XmlWriter xmlWriter, String rootElementName) throws XMLStreamException
      Specified by:
      toXml in interface com.azure.xml.XmlSerializable<HandleItem>
      Throws:
      XMLStreamException

    • fromXml

      public static HandleItem fromXml(com.azure.xml.XmlReader xmlReader) throws XMLStreamException
      Reads an instance of HandleItem from the XmlReader.
      Parameters:
      xmlReader - The XmlReader being read.
      Returns:
      An instance of HandleItem if the XmlReader was pointing to an instance of it, or null if it was pointing to XML null.
      Throws:
      IllegalStateException - If the deserialized XML object was missing any required properties.
      XMLStreamException - If an error occurs while reading the HandleItem.

    • fromXml

      public static HandleItem fromXml(com.azure.xml.XmlReader xmlReader, String rootElementName) throws XMLStreamException
      Reads an instance of HandleItem from the XmlReader.
      Parameters:
      xmlReader - The XmlReader being read.
      rootElementName - Optional root element name to override the default defined by the model. Used to support cases where the model can deserialize from different root element names.
      Returns:
      An instance of HandleItem if the XmlReader was pointing to an instance of it, or null if it was pointing to XML null.
      Throws:
      IllegalStateException - If the deserialized XML object was missing any required properties.
      XMLStreamException - If an error occurs while reading the HandleItem.