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

Class ShareAccessPolicy

java.lang.Object
com.azure.storage.file.share.models.ShareAccessPolicy
All Implemented Interfaces:
com.azure.xml.XmlSerializable<ShareAccessPolicy>
public final class ShareAccessPolicy extends Object implements com.azure.xml.XmlSerializable<ShareAccessPolicy>
An Access policy.

  • Constructor Details

    • ShareAccessPolicy

      public ShareAccessPolicy()
      Creates an instance of ShareAccessPolicy class.

  • Method Details

    • getStartsOn

      public OffsetDateTime getStartsOn()
      Get the startsOn property: The date-time the policy is active.
      Returns:
      the startsOn value.

    • setStartsOn

      public ShareAccessPolicy setStartsOn(OffsetDateTime startsOn)
      Set the startsOn property: The date-time the policy is active.
      Parameters:
      startsOn - the startsOn value to set.
      Returns:
      the ShareAccessPolicy object itself.

    • getExpiresOn

      public OffsetDateTime getExpiresOn()
      Get the expiresOn property: The date-time the policy expires.
      Returns:
      the expiresOn value.

    • setExpiresOn

      public ShareAccessPolicy setExpiresOn(OffsetDateTime expiresOn)
      Set the expiresOn property: The date-time the policy expires.
      Parameters:
      expiresOn - the expiresOn value to set.
      Returns:
      the ShareAccessPolicy object itself.

    • getPermissions

      public String getPermissions()
      Get the permissions property: The permissions for the ACL policy.
      Returns:
      the permissions value.

    • setPermissions

      public ShareAccessPolicy setPermissions(String permissions)
      Set the permissions property: The permissions for the ACL policy.
      Parameters:
      permissions - the permissions value to set.
      Returns:
      the ShareAccessPolicy 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<ShareAccessPolicy>
      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<ShareAccessPolicy>
      Throws:
      XMLStreamException

    • fromXml

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

    • fromXml

      public static ShareAccessPolicy fromXml(com.azure.xml.XmlReader xmlReader, String rootElementName) throws XMLStreamException
      Reads an instance of ShareAccessPolicy 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 ShareAccessPolicy if the XmlReader was pointing to an instance of it, or null if it was pointing to XML null.
      Throws:
      XMLStreamException - If an error occurs while reading the ShareAccessPolicy.