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

Class ShareItem

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

  • Constructor Details

    • ShareItem

      public ShareItem()
      Creates an instance of ShareItem.

  • Method Details

    • getName

      public String getName()
      Get the name property: The name property.
      Returns:
      the name value.

    • setName

      public ShareItem setName(String name)
      Set the name property: The name property.
      Parameters:
      name - the name value to set.
      Returns:
      the ShareItem object itself.

    • getSnapshot

      public String getSnapshot()
      Get the snapshot property: The snapshot property.
      Returns:
      the snapshot value.

    • setSnapshot

      public ShareItem setSnapshot(String snapshot)
      Set the snapshot property: The snapshot property.
      Parameters:
      snapshot - the snapshot value to set.
      Returns:
      the ShareItem object itself.

    • isDeleted

      public Boolean isDeleted()
      Get the deleted property: The deleted property.
      Returns:
      the deleted value.

    • setDeleted

      public ShareItem setDeleted(Boolean deleted)
      Set the deleted property: The deleted property.
      Parameters:
      deleted - the deleted value to set.
      Returns:
      the ShareItem object itself.

    • getVersion

      public String getVersion()
      Get the version property: The version property.
      Returns:
      the version value.

    • setVersion

      public ShareItem setVersion(String version)
      Set the version property: The version property.
      Parameters:
      version - the version value to set.
      Returns:
      the ShareItem object itself.

    • getProperties

      public ShareProperties getProperties()
      Get the properties property: The properties property.
      Returns:
      the properties value.

    • setProperties

      public ShareItem setProperties(ShareProperties properties)
      Set the properties property: The properties property.
      Parameters:
      properties - the properties value to set.
      Returns:
      the ShareItem object itself.

    • getMetadata

      public Map<String,String> getMetadata()
      Get the metadata property: The metadata property.
      Returns:
      the metadata value.

    • setMetadata

      public ShareItem setMetadata(Map<String,String> metadata)
      Set the metadata property: The metadata property.
      Parameters:
      metadata - the metadata value to set.
      Returns:
      the ShareItem 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<ShareItem>
      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<ShareItem>
      Throws:
      XMLStreamException

    • fromXml

      public static ShareItem fromXml(com.azure.xml.XmlReader xmlReader) throws XMLStreamException
      Reads an instance of ShareItem from the XmlReader.
      Parameters:
      xmlReader - The XmlReader being read.
      Returns:
      An instance of ShareItem 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 ShareItem.

    • fromXml

      public static ShareItem fromXml(com.azure.xml.XmlReader xmlReader, String rootElementName) throws XMLStreamException
      Reads an instance of ShareItem 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 ShareItem 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 ShareItem.