azure-docs-sdk-java/docs-ref-autogen/com.azure.storage.common.sa...

137 строки
9.9 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.storage.common.sas.AccountSasResourceType"
fullName: "com.azure.storage.common.sas.AccountSasResourceType"
name: "AccountSasResourceType"
nameWithType: "AccountSasResourceType"
summary: "This is a helper class to construct a string representing the resources accessible by an AccountSAS."
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 **AccountSasResourceType**"
constructors:
- uid: "com.azure.storage.common.sas.AccountSasResourceType.AccountSasResourceType()"
fullName: "com.azure.storage.common.sas.AccountSasResourceType.AccountSasResourceType()"
name: "AccountSasResourceType()"
nameWithType: "AccountSasResourceType.AccountSasResourceType()"
summary: "Initializes an `AccountSasResourceType` object with all fields set to false."
syntax: "public AccountSasResourceType()"
desc: "Initializes an `AccountSasResourceType` object with all fields set to false."
methods:
- uid: "com.azure.storage.common.sas.AccountSasResourceType.isContainer()"
fullName: "com.azure.storage.common.sas.AccountSasResourceType.isContainer()"
name: "isContainer()"
nameWithType: "AccountSasResourceType.isContainer()"
summary: "Gets the access status for container level APIs."
syntax: "public boolean isContainer()"
desc: "Gets the access status for container level APIs.\n\nThis grants access to Blob Containers, Tables, Queues, and File Shares."
returns:
description: "the access status for container level APIs, this grants access to Blob Containers, Tables, Queues, and\n File Shares."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.common.sas.AccountSasResourceType.isObject()"
fullName: "com.azure.storage.common.sas.AccountSasResourceType.isObject()"
name: "isObject()"
nameWithType: "AccountSasResourceType.isObject()"
summary: "Gets the access status for object level APIs."
syntax: "public boolean isObject()"
desc: "Gets the access status for object level APIs.\n\nThis grants access to Blobs, Table Entities, Queue Messages, Files."
returns:
description: "the access status for object level APIs, this grants access to Blobs, Table Entities, Queue Messages,\n Files."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.common.sas.AccountSasResourceType.isService()"
fullName: "com.azure.storage.common.sas.AccountSasResourceType.isService()"
name: "isService()"
nameWithType: "AccountSasResourceType.isService()"
summary: "Gets the access status for service level APIs."
syntax: "public boolean isService()"
desc: "Gets the access status for service level APIs."
returns:
description: "the access status for service level APIs."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.common.sas.AccountSasResourceType.parse(java.lang.String)"
fullName: "com.azure.storage.common.sas.AccountSasResourceType.parse(String resourceTypesString)"
name: "parse(String resourceTypesString)"
nameWithType: "AccountSasResourceType.parse(String resourceTypesString)"
summary: "Creates an `AccountSasResourceType` from the specified resource types string."
modifiers:
- "static"
parameters:
- description: "A <code>String</code> which represents the <code>AccountSASResourceTypes</code>."
name: "resourceTypesString"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public static AccountSasResourceType parse(String resourceTypesString)"
desc: "Creates an `AccountSasResourceType` from the specified resource types string. This method will throw an `IllegalArgumentException` if it encounters a character that does not correspond to a valid resource type."
returns:
description: "A <code>AccountSasResourceType</code> generated from the given <code>String</code>."
type: "<xref href=\"com.azure.storage.common.sas.AccountSasResourceType?alt=com.azure.storage.common.sas.AccountSasResourceType&text=AccountSasResourceType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.common.sas.AccountSasResourceType.setContainer(boolean)"
fullName: "com.azure.storage.common.sas.AccountSasResourceType.setContainer(boolean container)"
name: "setContainer(boolean container)"
nameWithType: "AccountSasResourceType.setContainer(boolean container)"
summary: "Sets the access status for container level APIs, this grants access to Blob Containers, Tables, Queues, and File Shares."
parameters:
- description: "Access status to set"
name: "container"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public AccountSasResourceType setContainer(boolean container)"
desc: "Sets the access status for container level APIs, this grants access to Blob Containers, Tables, Queues, and File Shares."
returns:
description: "the updated AccountSasResourceType object."
type: "<xref href=\"com.azure.storage.common.sas.AccountSasResourceType?alt=com.azure.storage.common.sas.AccountSasResourceType&text=AccountSasResourceType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.common.sas.AccountSasResourceType.setObject(boolean)"
fullName: "com.azure.storage.common.sas.AccountSasResourceType.setObject(boolean object)"
name: "setObject(boolean object)"
nameWithType: "AccountSasResourceType.setObject(boolean object)"
summary: "Sets the access status for object level APIs, this grants access to Blobs, Table Entities, Queue Messages, Files."
parameters:
- description: "Access status to set"
name: "object"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public AccountSasResourceType setObject(boolean object)"
desc: "Sets the access status for object level APIs, this grants access to Blobs, Table Entities, Queue Messages, Files."
returns:
description: "the updated AccountSasResourceType object."
type: "<xref href=\"com.azure.storage.common.sas.AccountSasResourceType?alt=com.azure.storage.common.sas.AccountSasResourceType&text=AccountSasResourceType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.common.sas.AccountSasResourceType.setService(boolean)"
fullName: "com.azure.storage.common.sas.AccountSasResourceType.setService(boolean service)"
name: "setService(boolean service)"
nameWithType: "AccountSasResourceType.setService(boolean service)"
summary: "Sets the access status for service level APIs."
parameters:
- description: "Access status to set"
name: "service"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public AccountSasResourceType setService(boolean service)"
desc: "Sets the access status for service level APIs."
returns:
description: "the updated AccountSasResourceType object."
type: "<xref href=\"com.azure.storage.common.sas.AccountSasResourceType?alt=com.azure.storage.common.sas.AccountSasResourceType&text=AccountSasResourceType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.common.sas.AccountSasResourceType.toString()"
fullName: "com.azure.storage.common.sas.AccountSasResourceType.toString()"
name: "toString()"
nameWithType: "AccountSasResourceType.toString()"
summary: "Converts the given resource types to a `String`."
overridden: "java.lang.Object.toString()"
syntax: "public String toString()"
desc: "Converts the given resource types to a `String`. Using this method will guarantee the resource types are in an order accepted by the service."
returns:
description: "A <code>String</code> which represents the <code>AccountSASResourceTypes</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 resources accessible by an AccountSAS. Setting a value to true means that any SAS which uses these permissions will grant access to that resource type. Once all the values are set, this should be serialized with toString and set as the resources field on an <xref uid=\"com.azure.storage.common.sas.AccountSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountSasSignatureValues\"></xref> object. It is possible to construct the resources string without this class, but the order of the resources is particular and this class guarantees correctness."
metadata: {}
package: "com.azure.storage.common.sas"
artifact: com.azure:azure-storage-common:12.26.1