### YamlMime:JavaType
uid: "com.azure.storage.file.share.models.ShareAccessPolicy"
fullName: "com.azure.storage.file.share.models.ShareAccessPolicy"
name: "ShareAccessPolicy"
nameWithType: "ShareAccessPolicy"
summary: "An Access policy."
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 **ShareAccessPolicy**</br> implements <xref href=\"com.azure.xml.XmlSerializable?alt=com.azure.xml.XmlSerializable&text=XmlSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.storage.file.share.models.ShareAccessPolicy?alt=com.azure.storage.file.share.models.ShareAccessPolicy&text=ShareAccessPolicy\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.storage.file.share.models.ShareAccessPolicy.ShareAccessPolicy()"
  fullName: "com.azure.storage.file.share.models.ShareAccessPolicy.ShareAccessPolicy()"
  name: "ShareAccessPolicy()"
  nameWithType: "ShareAccessPolicy.ShareAccessPolicy()"
  summary: "Creates an instance of Share<wbr>Access<wbr>Policy class."
  syntax: "public ShareAccessPolicy()"
  desc: "Creates an instance of ShareAccessPolicy class."
methods:
- uid: "com.azure.storage.file.share.models.ShareAccessPolicy.fromXml(com.azure.xml.XmlReader)"
  fullName: "com.azure.storage.file.share.models.ShareAccessPolicy.fromXml(XmlReader xmlReader)"
  name: "fromXml(XmlReader xmlReader)"
  nameWithType: "ShareAccessPolicy.fromXml(XmlReader xmlReader)"
  summary: "Reads an instance of Share<wbr>Access<wbr>Policy from the Xml<wbr>Reader."
  modifiers:
  - "static"
  parameters:
  - description: "The XmlReader being read."
    name: "xmlReader"
    type: "<xref href=\"com.azure.xml.XmlReader?alt=com.azure.xml.XmlReader&text=XmlReader\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static ShareAccessPolicy fromXml(XmlReader xmlReader)"
  exceptions:
  - description: "If an error occurs while reading the ShareAccessPolicy."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLStreamException.html\">XMLStreamException</a>"
  desc: "Reads an instance of ShareAccessPolicy from the XmlReader."
  returns:
    description: "An instance of ShareAccessPolicy if the XmlReader was pointing to an instance of it, or null if it was\n pointing to XML null."
    type: "<xref href=\"com.azure.storage.file.share.models.ShareAccessPolicy?alt=com.azure.storage.file.share.models.ShareAccessPolicy&text=ShareAccessPolicy\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.share.models.ShareAccessPolicy.fromXml(com.azure.xml.XmlReader,java.lang.String)"
  fullName: "com.azure.storage.file.share.models.ShareAccessPolicy.fromXml(XmlReader xmlReader, String rootElementName)"
  name: "fromXml(XmlReader xmlReader, String rootElementName)"
  nameWithType: "ShareAccessPolicy.fromXml(XmlReader xmlReader, String rootElementName)"
  summary: "Reads an instance of Share<wbr>Access<wbr>Policy from the Xml<wbr>Reader."
  modifiers:
  - "static"
  parameters:
  - description: "The XmlReader being read."
    name: "xmlReader"
    type: "<xref href=\"com.azure.xml.XmlReader?alt=com.azure.xml.XmlReader&text=XmlReader\" data-throw-if-not-resolved=\"False\" />"
  - description: "Optional root element name to override the default defined by the model. Used to support\n cases where the model can deserialize from different root element names."
    name: "rootElementName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public static ShareAccessPolicy fromXml(XmlReader xmlReader, String rootElementName)"
  exceptions:
  - description: "If an error occurs while reading the ShareAccessPolicy."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLStreamException.html\">XMLStreamException</a>"
  desc: "Reads an instance of ShareAccessPolicy from the XmlReader."
  returns:
    description: "An instance of ShareAccessPolicy if the XmlReader was pointing to an instance of it, or null if it was\n pointing to XML null."
    type: "<xref href=\"com.azure.storage.file.share.models.ShareAccessPolicy?alt=com.azure.storage.file.share.models.ShareAccessPolicy&text=ShareAccessPolicy\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.share.models.ShareAccessPolicy.getExpiresOn()"
  fullName: "com.azure.storage.file.share.models.ShareAccessPolicy.getExpiresOn()"
  name: "getExpiresOn()"
  nameWithType: "ShareAccessPolicy.getExpiresOn()"
  summary: "Get the expires<wbr>On property: The date-time the policy expires."
  syntax: "public OffsetDateTime getExpiresOn()"
  desc: "Get the expiresOn property: The date-time the policy expires."
  returns:
    description: "the expiresOn value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.storage.file.share.models.ShareAccessPolicy.getPermissions()"
  fullName: "com.azure.storage.file.share.models.ShareAccessPolicy.getPermissions()"
  name: "getPermissions()"
  nameWithType: "ShareAccessPolicy.getPermissions()"
  summary: "Get the permissions property: The permissions for the ACL policy."
  syntax: "public String getPermissions()"
  desc: "Get the permissions property: The permissions for the ACL policy."
  returns:
    description: "the permissions value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.file.share.models.ShareAccessPolicy.getStartsOn()"
  fullName: "com.azure.storage.file.share.models.ShareAccessPolicy.getStartsOn()"
  name: "getStartsOn()"
  nameWithType: "ShareAccessPolicy.getStartsOn()"
  summary: "Get the starts<wbr>On property: The date-time the policy is active."
  syntax: "public OffsetDateTime getStartsOn()"
  desc: "Get the startsOn property: The date-time the policy is active."
  returns:
    description: "the startsOn value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.storage.file.share.models.ShareAccessPolicy.setExpiresOn(java.time.OffsetDateTime)"
  fullName: "com.azure.storage.file.share.models.ShareAccessPolicy.setExpiresOn(OffsetDateTime expiresOn)"
  name: "setExpiresOn(OffsetDateTime expiresOn)"
  nameWithType: "ShareAccessPolicy.setExpiresOn(OffsetDateTime expiresOn)"
  summary: "Set the expires<wbr>On property: The date-time the policy expires."
  parameters:
  - description: "the expiresOn value to set."
    name: "expiresOn"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
  syntax: "public ShareAccessPolicy setExpiresOn(OffsetDateTime expiresOn)"
  desc: "Set the expiresOn property: The date-time the policy expires."
  returns:
    description: "the ShareAccessPolicy object itself."
    type: "<xref href=\"com.azure.storage.file.share.models.ShareAccessPolicy?alt=com.azure.storage.file.share.models.ShareAccessPolicy&text=ShareAccessPolicy\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.share.models.ShareAccessPolicy.setPermissions(java.lang.String)"
  fullName: "com.azure.storage.file.share.models.ShareAccessPolicy.setPermissions(String permissions)"
  name: "setPermissions(String permissions)"
  nameWithType: "ShareAccessPolicy.setPermissions(String permissions)"
  summary: "Set the permissions property: The permissions for the ACL policy."
  parameters:
  - description: "the permissions value to set."
    name: "permissions"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public ShareAccessPolicy setPermissions(String permissions)"
  desc: "Set the permissions property: The permissions for the ACL policy."
  returns:
    description: "the ShareAccessPolicy object itself."
    type: "<xref href=\"com.azure.storage.file.share.models.ShareAccessPolicy?alt=com.azure.storage.file.share.models.ShareAccessPolicy&text=ShareAccessPolicy\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.share.models.ShareAccessPolicy.setStartsOn(java.time.OffsetDateTime)"
  fullName: "com.azure.storage.file.share.models.ShareAccessPolicy.setStartsOn(OffsetDateTime startsOn)"
  name: "setStartsOn(OffsetDateTime startsOn)"
  nameWithType: "ShareAccessPolicy.setStartsOn(OffsetDateTime startsOn)"
  summary: "Set the starts<wbr>On property: The date-time the policy is active."
  parameters:
  - description: "the startsOn value to set."
    name: "startsOn"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
  syntax: "public ShareAccessPolicy setStartsOn(OffsetDateTime startsOn)"
  desc: "Set the startsOn property: The date-time the policy is active."
  returns:
    description: "the ShareAccessPolicy object itself."
    type: "<xref href=\"com.azure.storage.file.share.models.ShareAccessPolicy?alt=com.azure.storage.file.share.models.ShareAccessPolicy&text=ShareAccessPolicy\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.share.models.ShareAccessPolicy.toXml(com.azure.xml.XmlWriter)"
  fullName: "com.azure.storage.file.share.models.ShareAccessPolicy.toXml(XmlWriter xmlWriter)"
  name: "toXml(XmlWriter xmlWriter)"
  nameWithType: "ShareAccessPolicy.toXml(XmlWriter xmlWriter)"
  parameters:
  - name: "xmlWriter"
    type: "<xref href=\"com.azure.xml.XmlWriter?alt=com.azure.xml.XmlWriter&text=XmlWriter\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public XmlWriter toXml(XmlWriter xmlWriter)"
  exceptions:
  - type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLStreamException.html\">XMLStreamException</a>"
  returns:
    type: "<xref href=\"com.azure.xml.XmlWriter?alt=com.azure.xml.XmlWriter&text=XmlWriter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.share.models.ShareAccessPolicy.toXml(com.azure.xml.XmlWriter,java.lang.String)"
  fullName: "com.azure.storage.file.share.models.ShareAccessPolicy.toXml(XmlWriter xmlWriter, String rootElementName)"
  name: "toXml(XmlWriter xmlWriter, String rootElementName)"
  nameWithType: "ShareAccessPolicy.toXml(XmlWriter xmlWriter, String rootElementName)"
  parameters:
  - name: "xmlWriter"
    type: "<xref href=\"com.azure.xml.XmlWriter?alt=com.azure.xml.XmlWriter&text=XmlWriter\" data-throw-if-not-resolved=\"False\" />"
  - name: "rootElementName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public XmlWriter toXml(XmlWriter xmlWriter, String rootElementName)"
  exceptions:
  - type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLStreamException.html\">XMLStreamException</a>"
  returns:
    type: "<xref href=\"com.azure.xml.XmlWriter?alt=com.azure.xml.XmlWriter&text=XmlWriter\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "An Access policy."
implements:
- "<xref href=\"com.azure.xml.XmlSerializable?alt=com.azure.xml.XmlSerializable&text=XmlSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.storage.file.share.models.ShareAccessPolicy?alt=com.azure.storage.file.share.models.ShareAccessPolicy&text=ShareAccessPolicy\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.storage.file.share.models"
artifact: com.azure:azure-storage-file-share:12.24.0