com.azure.data.tables.sas

Class TableAccountSasSignatureValues

java.lang.Object

com.azure.data.tables.sas.TableAccountSasSignatureValues

public final class TableAccountSasSignatureValues
extends Object

Used to initialize parameters for a Shared Access Signature (SAS) for an Azure Storage account. Once all the values here are set, use the generateAccountSas() method on the desired service 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.

See Also:

Storage SAS overview, Create an account SAS

Constructor Summary

Constructors

Constructor and Description
TableAccountSasSignatureValues(OffsetDateTime expiryTime, TableAccountSasPermission permissions, TableAccountSasService services, TableAccountSasResourceType resourceTypes) Initializes a new TableAccountSasSignatureValues object.

Method Summary

Modifier and Type	Method and Description
OffsetDateTime	getExpiryTime() Get The time after which the SAS will no longer work.
String	getPermissions() Gets the operations the SAS user may perform.
TableSasProtocol	getProtocol() Get the TableSasProtocol which determines the HTTP protocol that will be used.
String	getResourceTypes() Get the resource types accessible with this SAS.
TableSasIpRange	getSasIpRange() Get the TableSasIpRange which determines the IP ranges that are allowed to use the SAS.
String	getServices() Get the services accessible with this SAS.
OffsetDateTime	getStartTime() Get when the SAS will take effect.
String	getVersion() Get the service version that is targeted, if null or empty the latest service version targeted by the library will be used.
TableAccountSasSignatureValues	setProtocol(TableSasProtocol protocol) Sets the TableSasProtocol which determines the HTTP protocol that will be used.
TableAccountSasSignatureValues	setSasIpRange(TableSasIpRange sasIpRange) Sets the TableSasIpRange which determines the IP ranges that are allowed to use the SAS.
TableAccountSasSignatureValues	setStartTime(OffsetDateTime startTime) Sets when the SAS will take effect.
TableAccountSasSignatureValues	setVersion(String version) Sets the service version that is targeted.

Methods inherited from class java.lang.Object

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

Constructor Detail

TableAccountSasSignatureValues

public TableAccountSasSignatureValues(OffsetDateTime expiryTime,
                                      TableAccountSasPermission permissions,
                                      TableAccountSasService services,
                                      TableAccountSasResourceType resourceTypes)

Initializes a new TableAccountSasSignatureValues object.

Parameters:

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

permissions - account permissions allowed by the SAS.

services - account services targeted by the SAS.

resourceTypes - account resource types targeted by the SAS.

Method Detail

getExpiryTime

public OffsetDateTime getExpiryTime()

Get The time after which the SAS will no longer work.

Returns:

The time after which the SAS will no longer work.

getPermissions

public String getPermissions()

Gets the operations the SAS user may perform. Please refer to TableAccountSasPermission to help determine which permissions are allowed.

Returns:

The operations the SAS user may perform.

getServices

public String getServices()

Get the services accessible with this SAS. Please refer to TableAccountSasService to help determine which services are accessible.

Returns:

The services accessible with this SAS.

getResourceTypes

public String getResourceTypes()

Get the resource types accessible with this SAS. Please refer to TableAccountSasResourceType to help determine the resource types that are accessible.

Returns:

The resource types accessible with this SAS.

getVersion

public String getVersion()

Get the service version that is targeted, if null or empty the latest service version targeted by the library will be used.

Returns:

The service version that is targeted.

setVersion

public TableAccountSasSignatureValues setVersion(String version)

Sets the service version that is targeted. Leave this null or empty to target the version used by the library.

Parameters:

version - The target version to set.

Returns:

The updated TableAccountSasSignatureValues object.

getProtocol

public TableSasProtocol getProtocol()

Get the TableSasProtocol which determines the HTTP protocol that will be used.

Returns:

The TableSasProtocol.

setProtocol

public TableAccountSasSignatureValues setProtocol(TableSasProtocol protocol)

Sets the TableSasProtocol which determines the HTTP protocol that will be used.

Parameters:

protocol - The TableSasProtocol to set.

Returns:

The updated TableAccountSasSignatureValues object.

getStartTime

public OffsetDateTime getStartTime()

Get when the SAS will take effect.

Returns:

When the SAS will take effect.

setStartTime

public TableAccountSasSignatureValues setStartTime(OffsetDateTime startTime)

Sets when the SAS will take effect.

Parameters:

startTime - The start time to set.

Returns:

The updated TableAccountSasSignatureValues object.

getSasIpRange

public TableSasIpRange getSasIpRange()

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

Returns:

The TableSasIpRange.

setSasIpRange

public TableAccountSasSignatureValues setSasIpRange(TableSasIpRange sasIpRange)

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

Parameters:

sasIpRange - The allowed IP range to set.

Returns:

The updated TableAccountSasSignatureValues object.

See Also:

Specifying IP Address or IP range