azure-docs-sdk-java/docs-ref-autogen/com.azure.storage.blob.sas....

329 строки
21 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.storage.blob.sas.BlobSasPermission"
fullName: "com.azure.storage.blob.sas.BlobSasPermission"
name: "BlobSasPermission"
nameWithType: "BlobSasPermission"
summary: "This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a blob."
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 **BlobSasPermission**"
constructors:
- uid: "com.azure.storage.blob.sas.BlobSasPermission.BlobSasPermission()"
fullName: "com.azure.storage.blob.sas.BlobSasPermission.BlobSasPermission()"
name: "BlobSasPermission()"
nameWithType: "BlobSasPermission.BlobSasPermission()"
summary: "Initializes a `BlobSasPermission` object with all fields set to false."
syntax: "public BlobSasPermission()"
desc: "Initializes a `BlobSasPermission` object with all fields set to false."
methods:
- uid: "com.azure.storage.blob.sas.BlobSasPermission.hasAddPermission()"
fullName: "com.azure.storage.blob.sas.BlobSasPermission.hasAddPermission()"
name: "hasAddPermission()"
nameWithType: "BlobSasPermission.hasAddPermission()"
syntax: "public boolean hasAddPermission()"
returns:
description: "the add permission status."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.sas.BlobSasPermission.hasCreatePermission()"
fullName: "com.azure.storage.blob.sas.BlobSasPermission.hasCreatePermission()"
name: "hasCreatePermission()"
nameWithType: "BlobSasPermission.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.blob.sas.BlobSasPermission.hasDeletePermission()"
fullName: "com.azure.storage.blob.sas.BlobSasPermission.hasDeletePermission()"
name: "hasDeletePermission()"
nameWithType: "BlobSasPermission.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.blob.sas.BlobSasPermission.hasDeleteVersionPermission()"
fullName: "com.azure.storage.blob.sas.BlobSasPermission.hasDeleteVersionPermission()"
name: "hasDeleteVersionPermission()"
nameWithType: "BlobSasPermission.hasDeleteVersionPermission()"
syntax: "public boolean hasDeleteVersionPermission()"
returns:
description: "the delete version permission status."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.sas.BlobSasPermission.hasExecutePermission()"
fullName: "com.azure.storage.blob.sas.BlobSasPermission.hasExecutePermission()"
name: "hasExecutePermission()"
nameWithType: "BlobSasPermission.hasExecutePermission()"
syntax: "public boolean hasExecutePermission()"
returns:
description: "the execute permission status."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.sas.BlobSasPermission.hasImmutabilityPolicyPermission()"
fullName: "com.azure.storage.blob.sas.BlobSasPermission.hasImmutabilityPolicyPermission()"
name: "hasImmutabilityPolicyPermission()"
nameWithType: "BlobSasPermission.hasImmutabilityPolicyPermission()"
syntax: "public boolean hasImmutabilityPolicyPermission()"
returns:
description: "the set immutability policy permission status."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.sas.BlobSasPermission.hasListPermission()"
fullName: "com.azure.storage.blob.sas.BlobSasPermission.hasListPermission()"
name: "hasListPermission()"
nameWithType: "BlobSasPermission.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.blob.sas.BlobSasPermission.hasMovePermission()"
fullName: "com.azure.storage.blob.sas.BlobSasPermission.hasMovePermission()"
name: "hasMovePermission()"
nameWithType: "BlobSasPermission.hasMovePermission()"
syntax: "public boolean hasMovePermission()"
returns:
description: "the move permission status."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.sas.BlobSasPermission.hasPermanentDeletePermission()"
fullName: "com.azure.storage.blob.sas.BlobSasPermission.hasPermanentDeletePermission()"
name: "hasPermanentDeletePermission()"
nameWithType: "BlobSasPermission.hasPermanentDeletePermission()"
syntax: "public boolean hasPermanentDeletePermission()"
returns:
description: "the permanent delete permission status."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.sas.BlobSasPermission.hasReadPermission()"
fullName: "com.azure.storage.blob.sas.BlobSasPermission.hasReadPermission()"
name: "hasReadPermission()"
nameWithType: "BlobSasPermission.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.blob.sas.BlobSasPermission.hasTagsPermission()"
fullName: "com.azure.storage.blob.sas.BlobSasPermission.hasTagsPermission()"
name: "hasTagsPermission()"
nameWithType: "BlobSasPermission.hasTagsPermission()"
syntax: "public boolean hasTagsPermission()"
returns:
description: "the tags permission status."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.sas.BlobSasPermission.hasWritePermission()"
fullName: "com.azure.storage.blob.sas.BlobSasPermission.hasWritePermission()"
name: "hasWritePermission()"
nameWithType: "BlobSasPermission.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.blob.sas.BlobSasPermission.parse(java.lang.String)"
fullName: "com.azure.storage.blob.sas.BlobSasPermission.parse(String permissionString)"
name: "parse(String permissionString)"
nameWithType: "BlobSasPermission.parse(String permissionString)"
summary: "Creates a `BlobSasPermission` from the specified permissions string."
modifiers:
- "static"
parameters:
- description: "A <code>String</code> which represents the <code>BlobSasPermission</code>."
name: "permissionString"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public static BlobSasPermission parse(String permissionString)"
desc: "Creates a `BlobSasPermission` 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>BlobSasPermission</code> generated from the given <code>String</code>."
type: "<xref href=\"com.azure.storage.blob.sas.BlobSasPermission?alt=com.azure.storage.blob.sas.BlobSasPermission&text=BlobSasPermission\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.sas.BlobSasPermission.setAddPermission(boolean)"
fullName: "com.azure.storage.blob.sas.BlobSasPermission.setAddPermission(boolean hasAddPermission)"
name: "setAddPermission(boolean hasAddPermission)"
nameWithType: "BlobSasPermission.setAddPermission(boolean hasAddPermission)"
summary: "Sets the add permission status."
parameters:
- description: "Permission status to set"
name: "hasAddPermission"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public BlobSasPermission setAddPermission(boolean hasAddPermission)"
desc: "Sets the add permission status."
returns:
description: "the updated BlobSasPermission object."
type: "<xref href=\"com.azure.storage.blob.sas.BlobSasPermission?alt=com.azure.storage.blob.sas.BlobSasPermission&text=BlobSasPermission\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.sas.BlobSasPermission.setCreatePermission(boolean)"
fullName: "com.azure.storage.blob.sas.BlobSasPermission.setCreatePermission(boolean hasCreatePermission)"
name: "setCreatePermission(boolean hasCreatePermission)"
nameWithType: "BlobSasPermission.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 BlobSasPermission setCreatePermission(boolean hasCreatePermission)"
desc: "Sets the create permission status."
returns:
description: "the updated BlobSasPermission object."
type: "<xref href=\"com.azure.storage.blob.sas.BlobSasPermission?alt=com.azure.storage.blob.sas.BlobSasPermission&text=BlobSasPermission\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.sas.BlobSasPermission.setDeletePermission(boolean)"
fullName: "com.azure.storage.blob.sas.BlobSasPermission.setDeletePermission(boolean hasDeletePermission)"
name: "setDeletePermission(boolean hasDeletePermission)"
nameWithType: "BlobSasPermission.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 BlobSasPermission setDeletePermission(boolean hasDeletePermission)"
desc: "Sets the delete permission status."
returns:
description: "the updated BlobSasPermission object."
type: "<xref href=\"com.azure.storage.blob.sas.BlobSasPermission?alt=com.azure.storage.blob.sas.BlobSasPermission&text=BlobSasPermission\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.sas.BlobSasPermission.setDeleteVersionPermission(boolean)"
fullName: "com.azure.storage.blob.sas.BlobSasPermission.setDeleteVersionPermission(boolean hasDeleteVersionPermission)"
name: "setDeleteVersionPermission(boolean hasDeleteVersionPermission)"
nameWithType: "BlobSasPermission.setDeleteVersionPermission(boolean hasDeleteVersionPermission)"
summary: "Sets the delete version permission status."
parameters:
- description: "Permission status to set"
name: "hasDeleteVersionPermission"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public BlobSasPermission setDeleteVersionPermission(boolean hasDeleteVersionPermission)"
desc: "Sets the delete version permission status."
returns:
description: "the updated BlobSasPermission object."
type: "<xref href=\"com.azure.storage.blob.sas.BlobSasPermission?alt=com.azure.storage.blob.sas.BlobSasPermission&text=BlobSasPermission\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.sas.BlobSasPermission.setExecutePermission(boolean)"
fullName: "com.azure.storage.blob.sas.BlobSasPermission.setExecutePermission(boolean hasExecutePermission)"
name: "setExecutePermission(boolean hasExecutePermission)"
nameWithType: "BlobSasPermission.setExecutePermission(boolean hasExecutePermission)"
summary: "Sets the execute permission status."
parameters:
- description: "Permission status to set"
name: "hasExecutePermission"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public BlobSasPermission setExecutePermission(boolean hasExecutePermission)"
desc: "Sets the execute permission status."
returns:
description: "the updated BlobSasPermission object."
type: "<xref href=\"com.azure.storage.blob.sas.BlobSasPermission?alt=com.azure.storage.blob.sas.BlobSasPermission&text=BlobSasPermission\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.sas.BlobSasPermission.setImmutabilityPolicyPermission(boolean)"
fullName: "com.azure.storage.blob.sas.BlobSasPermission.setImmutabilityPolicyPermission(boolean immutabilityPolicyPermission)"
name: "setImmutabilityPolicyPermission(boolean immutabilityPolicyPermission)"
nameWithType: "BlobSasPermission.setImmutabilityPolicyPermission(boolean immutabilityPolicyPermission)"
summary: "Sets the set immutability policy permission status."
parameters:
- description: "Permission status to set"
name: "immutabilityPolicyPermission"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public BlobSasPermission setImmutabilityPolicyPermission(boolean immutabilityPolicyPermission)"
desc: "Sets the set immutability policy permission status."
returns:
description: "the updated BlobSasPermission object."
type: "<xref href=\"com.azure.storage.blob.sas.BlobSasPermission?alt=com.azure.storage.blob.sas.BlobSasPermission&text=BlobSasPermission\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.sas.BlobSasPermission.setListPermission(boolean)"
fullName: "com.azure.storage.blob.sas.BlobSasPermission.setListPermission(boolean hasListPermission)"
name: "setListPermission(boolean hasListPermission)"
nameWithType: "BlobSasPermission.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 BlobSasPermission setListPermission(boolean hasListPermission)"
desc: "Sets the list permission status."
returns:
description: "the updated BlobSasPermission object."
type: "<xref href=\"com.azure.storage.blob.sas.BlobSasPermission?alt=com.azure.storage.blob.sas.BlobSasPermission&text=BlobSasPermission\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.sas.BlobSasPermission.setMovePermission(boolean)"
fullName: "com.azure.storage.blob.sas.BlobSasPermission.setMovePermission(boolean hasMovePermission)"
name: "setMovePermission(boolean hasMovePermission)"
nameWithType: "BlobSasPermission.setMovePermission(boolean hasMovePermission)"
summary: "Sets the move permission status."
parameters:
- description: "Permission status to set"
name: "hasMovePermission"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public BlobSasPermission setMovePermission(boolean hasMovePermission)"
desc: "Sets the move permission status."
returns:
description: "the updated BlobSasPermission object."
type: "<xref href=\"com.azure.storage.blob.sas.BlobSasPermission?alt=com.azure.storage.blob.sas.BlobSasPermission&text=BlobSasPermission\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.sas.BlobSasPermission.setPermanentDeletePermission(boolean)"
fullName: "com.azure.storage.blob.sas.BlobSasPermission.setPermanentDeletePermission(boolean permanentDeletePermission)"
name: "setPermanentDeletePermission(boolean permanentDeletePermission)"
nameWithType: "BlobSasPermission.setPermanentDeletePermission(boolean permanentDeletePermission)"
summary: "Sets the permanent delete permission status."
parameters:
- description: "Permission status to set"
name: "permanentDeletePermission"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public BlobSasPermission setPermanentDeletePermission(boolean permanentDeletePermission)"
desc: "Sets the permanent delete permission status."
returns:
description: "the updated BlobSasPermission object."
type: "<xref href=\"com.azure.storage.blob.sas.BlobSasPermission?alt=com.azure.storage.blob.sas.BlobSasPermission&text=BlobSasPermission\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.sas.BlobSasPermission.setReadPermission(boolean)"
fullName: "com.azure.storage.blob.sas.BlobSasPermission.setReadPermission(boolean hasReadPermission)"
name: "setReadPermission(boolean hasReadPermission)"
nameWithType: "BlobSasPermission.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 BlobSasPermission setReadPermission(boolean hasReadPermission)"
desc: "Sets the read permission status."
returns:
description: "the updated BlobSasPermission object."
type: "<xref href=\"com.azure.storage.blob.sas.BlobSasPermission?alt=com.azure.storage.blob.sas.BlobSasPermission&text=BlobSasPermission\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.sas.BlobSasPermission.setTagsPermission(boolean)"
fullName: "com.azure.storage.blob.sas.BlobSasPermission.setTagsPermission(boolean tagsPermission)"
name: "setTagsPermission(boolean tagsPermission)"
nameWithType: "BlobSasPermission.setTagsPermission(boolean tagsPermission)"
summary: "Sets the tags permission status."
parameters:
- description: "Permission status to set"
name: "tagsPermission"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public BlobSasPermission setTagsPermission(boolean tagsPermission)"
desc: "Sets the tags permission status."
returns:
description: "the updated BlobSasPermission object."
type: "<xref href=\"com.azure.storage.blob.sas.BlobSasPermission?alt=com.azure.storage.blob.sas.BlobSasPermission&text=BlobSasPermission\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.sas.BlobSasPermission.setWritePermission(boolean)"
fullName: "com.azure.storage.blob.sas.BlobSasPermission.setWritePermission(boolean hasWritePermission)"
name: "setWritePermission(boolean hasWritePermission)"
nameWithType: "BlobSasPermission.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 BlobSasPermission setWritePermission(boolean hasWritePermission)"
desc: "Sets the write permission status."
returns:
description: "the updated BlobSasPermission object."
type: "<xref href=\"com.azure.storage.blob.sas.BlobSasPermission?alt=com.azure.storage.blob.sas.BlobSasPermission&text=BlobSasPermission\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.sas.BlobSasPermission.toString()"
fullName: "com.azure.storage.blob.sas.BlobSasPermission.toString()"
name: "toString()"
nameWithType: "BlobSasPermission.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>BlobSasPermission</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 blob. Setting a value to true means that any SAS which uses these permissions will grant permissions for that operation. 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.blob.sas"
artifact: com.azure:azure-storage-blob:12.27.1