Package com.azure.data.tables.sas

Class TableAccountSasResourceType

java.lang.Object

com.azure.data.tables.sas.TableAccountSasResourceType

public final class TableAccountSasResourceType
extends Object

This is a helper class to construct a string representing the resources accessible by an Account SAS. 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 TableAccountSasSignatureValues 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.

Constructor Summary

Constructors

Constructor	Description
TableAccountSasResourceType()

Method Summary

Modifier and Type	Method	Description
boolean	isContainer()	Gets the access status for container level APIs, this grants access to Blob Containers, Tables, Queues, and File Shares.
boolean	isObject()	Get the access status for object level APIs, this grants access to Blobs, Table Entities, Queue Messages, Files.
boolean	isService()	Get the access status for service level APIs.
static TableAccountSasResourceType	parse(String resourceTypesString)	Creates an TableAccountSasResourceType from the specified resource types string.
TableAccountSasResourceType	setContainer(boolean container)	Sets the access status for container level APIs, this grants access to Blob Containers, Tables, Queues, and File Shares.
TableAccountSasResourceType	setObject(boolean object)	Sets the access status for object level APIs, this grants access to Blobs, Table Entities, Queue Messages, Files.
TableAccountSasResourceType	setService(boolean service)	Sets the access status for service level APIs.
String	toString()	Converts the given resource types to a String.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TableAccountSasResourceType

public TableAccountSasResourceType()

Method Detail

parse

public static TableAccountSasResourceType parse(String resourceTypesString)

Creates an TableAccountSasResourceType 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.

Parameters:

resourceTypesString - A String which represents the account resource types.

Returns:

A TableAccountSasResourceType generated from the given String.

Throws:

IllegalArgumentException - If resourceTypesString contains a character other than s, c, or o.

isService

public boolean isService()

Get the access status for service level APIs.

Returns:

The access status for service level APIs.

setService

public TableAccountSasResourceType setService(boolean service)

Sets the access status for service level APIs.

Parameters:

service - The access status to set.

Returns:

The updated TableAccountSasResourceType object.

isContainer

public boolean isContainer()

Gets the access status for container level APIs, this grants access to Blob Containers, Tables, Queues, and File Shares.

Returns:

The access status for container level APIs, this grants access to Blob Containers, Tables, Queues, and File Shares.

setContainer

public TableAccountSasResourceType setContainer(boolean container)

Sets the access status for container level APIs, this grants access to Blob Containers, Tables, Queues, and File Shares.

Parameters:

container - The access status to set.

Returns:

The updated TableAccountSasResourceType object.

isObject

public boolean isObject()

Get the access status for object level APIs, this grants access to Blobs, Table Entities, Queue Messages, Files.

Returns:

The access status for object level APIs, this grants access to Blobs, Table Entities, Queue Messages, Files.

setObject

public TableAccountSasResourceType setObject(boolean object)

Sets the access status for object level APIs, this grants access to Blobs, Table Entities, Queue Messages, Files.

Parameters:

object - The access status to set.

Returns:

The updated TableAccountSasResourceType object.

toString

public String toString()

Converts the given resource types to a String. Using this method will guarantee the resource types are in an order accepted by the service. If all resource types are set to false, an empty string is returned from this method.

Overrides:

toString in class Object

Returns:

A String which represents the account resource types.