com.azure.storage.file.share.sas.ShareSasPermission.yml

### YamlMime:JavaType
uid: "com.azure.storage.file.share.sas.ShareSasPermission"
fullName: "com.azure.storage.file.share.sas.ShareSasPermission"
name: "ShareSasPermission"
nameWithType: "ShareSasPermission"
summary: "This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a share."
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 **ShareSasPermission**"
constructors:
- uid: "com.azure.storage.file.share.sas.ShareSasPermission.ShareSasPermission()"
  fullName: "com.azure.storage.file.share.sas.ShareSasPermission.ShareSasPermission()"
  name: "ShareSasPermission()"
  nameWithType: "ShareSasPermission.ShareSasPermission()"
  summary: "Initializes an `ShareSasPermission` object with all fields set to false."
  syntax: "public ShareSasPermission()"
  desc: "Initializes an `ShareSasPermission` object with all fields set to false."
methods:
- uid: "com.azure.storage.file.share.sas.ShareSasPermission.hasCreatePermission()"
  fullName: "com.azure.storage.file.share.sas.ShareSasPermission.hasCreatePermission()"
  name: "hasCreatePermission()"
  nameWithType: "ShareSasPermission.hasCreatePermission()"
  syntax: "public boolean hasCreatePermission()"
  returns:
    description: "the create permission status"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.share.sas.ShareSasPermission.hasDeletePermission()"
  fullName: "com.azure.storage.file.share.sas.ShareSasPermission.hasDeletePermission()"
  name: "hasDeletePermission()"
  nameWithType: "ShareSasPermission.hasDeletePermission()"
  syntax: "public boolean hasDeletePermission()"
  returns:
    description: "the delete permission status"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.share.sas.ShareSasPermission.hasListPermission()"
  fullName: "com.azure.storage.file.share.sas.ShareSasPermission.hasListPermission()"
  name: "hasListPermission()"
  nameWithType: "ShareSasPermission.hasListPermission()"
  syntax: "public boolean hasListPermission()"
  returns:
    description: "the list permission status"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.share.sas.ShareSasPermission.hasReadPermission()"
  fullName: "com.azure.storage.file.share.sas.ShareSasPermission.hasReadPermission()"
  name: "hasReadPermission()"
  nameWithType: "ShareSasPermission.hasReadPermission()"
  syntax: "public boolean hasReadPermission()"
  returns:
    description: "the read permission status"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.share.sas.ShareSasPermission.hasWritePermission()"
  fullName: "com.azure.storage.file.share.sas.ShareSasPermission.hasWritePermission()"
  name: "hasWritePermission()"
  nameWithType: "ShareSasPermission.hasWritePermission()"
  syntax: "public boolean hasWritePermission()"
  returns:
    description: "the write permission status"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.share.sas.ShareSasPermission.parse(java.lang.String)"
  fullName: "com.azure.storage.file.share.sas.ShareSasPermission.parse(String permissionString)"
  name: "parse(String permissionString)"
  nameWithType: "ShareSasPermission.parse(String permissionString)"
  summary: "Creates an `ShareSasPermission` from the specified permissions string."
  modifiers:
  - "static"
  parameters:
  - description: "A <code>String</code> which represents the <code>ShareSasPermission</code>."
    name: "permissionString"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public static ShareSasPermission parse(String permissionString)"
  desc: "Creates an `ShareSasPermission` from the specified permissions string. This method will throw an `IllegalArgumentException` if it encounters a character that does not correspond to a valid permission."
  returns:
    description: "A <code>ShareSasPermission</code> generated from the given <code>String</code>."
    type: "<xref href=\"com.azure.storage.file.share.sas.ShareSasPermission?alt=com.azure.storage.file.share.sas.ShareSasPermission&text=ShareSasPermission\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.share.sas.ShareSasPermission.setCreatePermission(boolean)"
  fullName: "com.azure.storage.file.share.sas.ShareSasPermission.setCreatePermission(boolean hasCreatePermission)"
  name: "setCreatePermission(boolean hasCreatePermission)"
  nameWithType: "ShareSasPermission.setCreatePermission(boolean hasCreatePermission)"
  summary: "Sets the create permission status."
  parameters:
  - description: "Permission status to set"
    name: "hasCreatePermission"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public ShareSasPermission setCreatePermission(boolean hasCreatePermission)"
  desc: "Sets the create permission status."
  returns:
    description: "the updated ShareSasPermission object"
    type: "<xref href=\"com.azure.storage.file.share.sas.ShareSasPermission?alt=com.azure.storage.file.share.sas.ShareSasPermission&text=ShareSasPermission\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.share.sas.ShareSasPermission.setDeletePermission(boolean)"
  fullName: "com.azure.storage.file.share.sas.ShareSasPermission.setDeletePermission(boolean hasDeletePermission)"
  name: "setDeletePermission(boolean hasDeletePermission)"
  nameWithType: "ShareSasPermission.setDeletePermission(boolean hasDeletePermission)"
  summary: "Sets the delete permission status."
  parameters:
  - description: "Permission status to set"
    name: "hasDeletePermission"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public ShareSasPermission setDeletePermission(boolean hasDeletePermission)"
  desc: "Sets the delete permission status."
  returns:
    description: "the updated ShareSasPermission object"
    type: "<xref href=\"com.azure.storage.file.share.sas.ShareSasPermission?alt=com.azure.storage.file.share.sas.ShareSasPermission&text=ShareSasPermission\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.share.sas.ShareSasPermission.setListPermission(boolean)"
  fullName: "com.azure.storage.file.share.sas.ShareSasPermission.setListPermission(boolean hasListPermission)"
  name: "setListPermission(boolean hasListPermission)"
  nameWithType: "ShareSasPermission.setListPermission(boolean hasListPermission)"
  summary: "Sets the list permission status."
  parameters:
  - description: "Permission status to set"
    name: "hasListPermission"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public ShareSasPermission setListPermission(boolean hasListPermission)"
  desc: "Sets the list permission status."
  returns:
    description: "the updated ShareSasPermission object"
    type: "<xref href=\"com.azure.storage.file.share.sas.ShareSasPermission?alt=com.azure.storage.file.share.sas.ShareSasPermission&text=ShareSasPermission\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.share.sas.ShareSasPermission.setReadPermission(boolean)"
  fullName: "com.azure.storage.file.share.sas.ShareSasPermission.setReadPermission(boolean hasReadPermission)"
  name: "setReadPermission(boolean hasReadPermission)"
  nameWithType: "ShareSasPermission.setReadPermission(boolean hasReadPermission)"
  summary: "Sets the read permission status."
  parameters:
  - description: "Permission status to set"
    name: "hasReadPermission"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public ShareSasPermission setReadPermission(boolean hasReadPermission)"
  desc: "Sets the read permission status."
  returns:
    description: "the updated ShareSasPermission object"
    type: "<xref href=\"com.azure.storage.file.share.sas.ShareSasPermission?alt=com.azure.storage.file.share.sas.ShareSasPermission&text=ShareSasPermission\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.share.sas.ShareSasPermission.setWritePermission(boolean)"
  fullName: "com.azure.storage.file.share.sas.ShareSasPermission.setWritePermission(boolean hasWritePermission)"
  name: "setWritePermission(boolean hasWritePermission)"
  nameWithType: "ShareSasPermission.setWritePermission(boolean hasWritePermission)"
  summary: "Sets the write permission status."
  parameters:
  - description: "Permission status to set"
    name: "hasWritePermission"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public ShareSasPermission setWritePermission(boolean hasWritePermission)"
  desc: "Sets the write permission status."
  returns:
    description: "the updated ShareSasPermission object"
    type: "<xref href=\"com.azure.storage.file.share.sas.ShareSasPermission?alt=com.azure.storage.file.share.sas.ShareSasPermission&text=ShareSasPermission\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.share.sas.ShareSasPermission.toString()"
  fullName: "com.azure.storage.file.share.sas.ShareSasPermission.toString()"
  name: "toString()"
  nameWithType: "ShareSasPermission.toString()"
  summary: "Converts the given permissions to a `String`."
  overridden: "java.lang.Object.toString()"
  syntax: "public String toString()"
  desc: "Converts the given permissions to a `String`. Using this method will guarantee the permissions are in an order accepted by the service."
  returns:
    description: "A <code>String</code> which represents the <code>ShareSasPermission</code>."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
type: "class"
desc: "This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a share. Setting a value to true means that any SAS which uses these permissions will grant permissions for that operation. Once all the values are set, this should be serialized with toString and set as the permissions field on a <xref uid=\"com.azure.storage.file.share.sas.ShareServiceSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareServiceSasSignatureValues\"></xref> object. It is possible to construct the permissions string without this class, but the order of the permissions is particular and this class guarantees correctness."
metadata: {}
package: "com.azure.storage.file.share.sas"
artifact: com.azure:azure-storage-file-share:12.22.1