TableSasSignatureValues Class

Package:

com.azure.data.tables.sas

Maven Artifact:

com.azure:azure-data-tables:12.4.0

• java.lang.Object
• • com.azure.data.tables.sas.TableSasSignatureValues

public final class TableSasSignatureValues

Used to initialize parameters for a Shared Access Signature (SAS) for the Azure Table Storage service. Once all the values here are set, use the generateSas() method on the desired Table client to obtain a representation of the SAS which can then be applied to a new client using the sasToken(String) method on the desired client builder.

Constructor Summary

Constructor	Description
TableSasSignatureValues(String identifier)	Creates an object with the specified identifier.
TableSasSignatureValues(OffsetDateTime expiryTime, TableSasPermission permissions)	Creates an object with the specified expiry time and permissions.

Method Summary

Modifier and Type	Method and Description
String	getEndPartitionKey() Get the maximum partition key accessible with this shared access signature.
String	getEndRowKey() Get the maximum row key accessible with this shared access signature.
OffsetDateTime	getExpiryTime() Returns the time after which the SAS will no longer work.
String	getIdentifier() Returns the name of the access policy on the table this SAS references if any.
String	getPermissions() Returns the permissions string allowed by the SAS.
TableSasProtocol	getProtocol() Returns the TableSasProtocol which determines the protocols allowed by the SAS.
TableSasIpRange	getSasIpRange() Returns the TableSasIpRange which determines the IP ranges that are allowed to use the SAS.
String	getStartPartitionKey() Get the minimum partition key accessible with this shared access signature.
String	getStartRowKey() Get the minimum row key accessible with this shared access signature.
OffsetDateTime	getStartTime() Returns when the SAS will take effect.
String	getVersion() Returns the version of the service this SAS will target.
TableSasSignatureValues	setEndPartitionKey(String endPartitionKey) Set the maximum partition key accessible with this shared access signature.
TableSasSignatureValues	setEndRowKey(String endRowKey) Set the maximum row key accessible with this shared access signature.
TableSasSignatureValues	setExpiryTime(OffsetDateTime expiryTime) Sets the time after which the SAS will no longer work.
TableSasSignatureValues	setIdentifier(String identifier) Sets the name of the access policy on the table this SAS references if any.
TableSasSignatureValues	setPermissions(TableSasPermission permissions) Sets the permissions string allowed by the SAS.
TableSasSignatureValues	setProtocol(TableSasProtocol protocol) Sets the TableSasProtocol which determines the protocols allowed by the SAS.
TableSasSignatureValues	setSasIpRange(TableSasIpRange sasIpRange) Sets the TableSasIpRange which determines the IP ranges that are allowed to use the SAS.
TableSasSignatureValues	setStartPartitionKey(String startPartitionKey) Set the minimum partition key accessible with this shared access signature.
TableSasSignatureValues	setStartRowKey(String startRowKey) Set the minimum row key accessible with this shared access signature.
TableSasSignatureValues	setStartTime(OffsetDateTime startTime) Sets when the SAS will take effect.
TableSasSignatureValues	setVersion(String version) Sets the version of the service this SAS will target.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

TableSasSignatureValues

public TableSasSignatureValues(String identifier)

Creates an object with the specified identifier.

Parameters:

identifier - Name of the access policy.

TableSasSignatureValues

public TableSasSignatureValues(OffsetDateTime expiryTime, TableSasPermission permissions)

Creates an object with the specified expiry time and permissions.

Parameters:

expiryTime - The time after which the SAS will no longer work.

permissions - TableSasPermission allowed by the SAS.

Method Details

getEndPartitionKey

public String getEndPartitionKey()

Get the maximum partition key accessible with this shared access signature. Key values are inclusive. If omitted, there is no upper bound on the table entities that can be accessed. If provided, it must accompany an ending row key that can be set via setEndRowKey().

Returns:

The end partition key.

getEndRowKey

public String getEndRowKey()

Get the maximum row key accessible with this shared access signature. Key values are inclusive. If omitted, there is no upper bound on the table entities that can be accessed. If provided, it must accompany an ending row key that can be set via setEndPartitionKey().

Returns:

The end row key.

getExpiryTime

public OffsetDateTime getExpiryTime()

Returns the time after which the SAS will no longer work.

Returns:

The time after which the SAS will no longer work.

getIdentifier

public String getIdentifier()

Returns the name of the access policy on the table this SAS references if any. Please see here for more information.

Returns:

The name of the access policy on the table this SAS references if any.

getPermissions

public String getPermissions()

Returns the permissions string allowed by the SAS. Please refer to TableSasPermission for help determining the permissions allowed.

Returns:

The permissions string allowed by the SAS. Please refer to TableSasPermission for help determining the permissions allowed.

getProtocol

public TableSasProtocol getProtocol()

Returns the TableSasProtocol which determines the protocols allowed by the SAS.

Returns:

The TableSasProtocol which determines the protocols allowed by the SAS.

getSasIpRange

public TableSasIpRange getSasIpRange()

Returns the TableSasIpRange which determines the IP ranges that are allowed to use the SAS.

Returns:

The TableSasIpRange which determines the IP ranges that are allowed to use the SAS.

getStartPartitionKey

public String getStartPartitionKey()

Get the minimum partition key accessible with this shared access signature. Key values are inclusive. If omitted, there is no lower bound on the table entities that can be accessed. If provided, it must accompany a start row key that can be set via setStartRowKey().

Returns:

The start partition key.

getStartRowKey

public String getStartRowKey()

Get the minimum row key accessible with this shared access signature. Key values are inclusive. If omitted, there is no lower bound on the table entities that can be accessed. If provided, it must accompany a start row key that can be set via setStartPartitionKey().

Returns:

The start row key.

getStartTime

public OffsetDateTime getStartTime()

Returns when the SAS will take effect.

Returns:

When the SAS will take effect.

getVersion

public String getVersion()

Returns the version of the service this SAS will target. If not specified, it will default to the version targeted by the library.

Returns:

The version of the service this SAS will target. If not specified, it will default to the version targeted by the library.

setEndPartitionKey

public TableSasSignatureValues setEndPartitionKey(String endPartitionKey)

Set the maximum partition key accessible with this shared access signature. Key values are inclusive. If omitted, there is no upper bound on the table entities that can be accessed. If provided, it must accompany an ending row key that can be set via setEndRowKey().

Parameters:

endPartitionKey - The end partition key to set.

Returns:

The updated TableSasSignatureValues object.

setEndRowKey

public TableSasSignatureValues setEndRowKey(String endRowKey)

Set the maximum row key accessible with this shared access signature. Key values are inclusive. If omitted, there is no upper bound on the table entities that can be accessed. If provided, it must accompany an ending row key that can be set via setEndPartitionKey().

Parameters:

endRowKey - The end row key to set.

Returns:

The updated TableSasSignatureValues object.

setExpiryTime

public TableSasSignatureValues setExpiryTime(OffsetDateTime expiryTime)

Sets the time after which the SAS will no longer work.

Parameters:

expiryTime - When the SAS will no longer work

Returns:

The updated TableSasSignatureValues object.

setIdentifier

public TableSasSignatureValues setIdentifier(String identifier)

Sets the name of the access policy on the table this SAS references if any. Please see here for more information.

Parameters:

identifier - Name of the access policy

Returns:

The updated TableSasSignatureValues object.

setPermissions

public TableSasSignatureValues setPermissions(TableSasPermission permissions)

Sets the permissions string allowed by the SAS. Please refer to TableSasPermission for help constructing the permissions string.

Parameters:

permissions - Permissions for the SAS

Returns:

The updated TableSasSignatureValues object.

setProtocol

public TableSasSignatureValues setProtocol(TableSasProtocol protocol)

Sets the TableSasProtocol which determines the protocols allowed by the SAS.

Parameters:

protocol - Protocol for the SAS

Returns:

The updated TableSasSignatureValues object.

setSasIpRange

public TableSasSignatureValues setSasIpRange(TableSasIpRange sasIpRange)

Sets the TableSasIpRange which determines the IP ranges that are allowed to use the SAS.

Parameters:

sasIpRange - Allowed IP range to set

Returns:

The updated TableSasSignatureValues object.

setStartPartitionKey

public TableSasSignatureValues setStartPartitionKey(String startPartitionKey)

Set the minimum partition key accessible with this shared access signature. Key values are inclusive. If omitted, there is no lower bound on the table entities that can be accessed. If provided, it must accompany a start row key that can be set via setStartRowKey().

Parameters:

startPartitionKey - The start partition key to set.

Returns:

The updated TableSasSignatureValues object.

setStartRowKey

public TableSasSignatureValues setStartRowKey(String startRowKey)

Set the minimum row key accessible with this shared access signature. Key values are inclusive. If omitted, there is no lower bound on the table entities that can be accessed. If provided, it must accompany a start row key that can be set via setStartPartitionKey().

Parameters:

startRowKey - The start row key to set.

Returns:

The updated TableSasSignatureValues object.

setStartTime

public TableSasSignatureValues setStartTime(OffsetDateTime startTime)

Sets when the SAS will take effect.

Parameters:

startTime - When the SAS takes effect

Returns:

The updated TableSasSignatureValues object.

setVersion

public TableSasSignatureValues setVersion(String version)

Sets the version of the service this SAS will target. If not specified, it will default to the version targeted by the library.

Parameters:

version - Version to target

Returns:

The updated TableSasSignatureValues object.