Class ServiceSasParameters


  • public final class ServiceSasParameters
    extends Object
    The parameters to list service SAS credentials of a specific resource.
    • Constructor Detail

      • ServiceSasParameters

        public ServiceSasParameters()
    • Method Detail

      • canonicalizedResource

        public String canonicalizedResource()
        Get the canonicalizedResource property: The canonical path to the signed resource.
        Returns:
        the canonicalizedResource value.
      • withCanonicalizedResource

        public ServiceSasParameters withCanonicalizedResource​(String canonicalizedResource)
        Set the canonicalizedResource property: The canonical path to the signed resource.
        Parameters:
        canonicalizedResource - the canonicalizedResource value to set.
        Returns:
        the ServiceSasParameters object itself.
      • resource

        public SignedResource resource()
        Get the resource property: The signed services accessible with the service SAS. Possible values include: Blob (b), Container (c), File (f), Share (s).
        Returns:
        the resource value.
      • withResource

        public ServiceSasParameters withResource​(SignedResource resource)
        Set the resource property: The signed services accessible with the service SAS. Possible values include: Blob (b), Container (c), File (f), Share (s).
        Parameters:
        resource - the resource value to set.
        Returns:
        the ServiceSasParameters object itself.
      • permissions

        public Permissions permissions()
        Get the permissions property: The signed permissions for the service SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p).
        Returns:
        the permissions value.
      • withPermissions

        public ServiceSasParameters withPermissions​(Permissions permissions)
        Set the permissions property: The signed permissions for the service SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p).
        Parameters:
        permissions - the permissions value to set.
        Returns:
        the ServiceSasParameters object itself.
      • ipAddressOrRange

        public String ipAddressOrRange()
        Get the ipAddressOrRange property: An IP address or a range of IP addresses from which to accept requests.
        Returns:
        the ipAddressOrRange value.
      • withIpAddressOrRange

        public ServiceSasParameters withIpAddressOrRange​(String ipAddressOrRange)
        Set the ipAddressOrRange property: An IP address or a range of IP addresses from which to accept requests.
        Parameters:
        ipAddressOrRange - the ipAddressOrRange value to set.
        Returns:
        the ServiceSasParameters object itself.
      • protocols

        public HttpProtocol protocols()
        Get the protocols property: The protocol permitted for a request made with the account SAS.
        Returns:
        the protocols value.
      • withProtocols

        public ServiceSasParameters withProtocols​(HttpProtocol protocols)
        Set the protocols property: The protocol permitted for a request made with the account SAS.
        Parameters:
        protocols - the protocols value to set.
        Returns:
        the ServiceSasParameters object itself.
      • sharedAccessStartTime

        public OffsetDateTime sharedAccessStartTime()
        Get the sharedAccessStartTime property: The time at which the SAS becomes valid.
        Returns:
        the sharedAccessStartTime value.
      • withSharedAccessStartTime

        public ServiceSasParameters withSharedAccessStartTime​(OffsetDateTime sharedAccessStartTime)
        Set the sharedAccessStartTime property: The time at which the SAS becomes valid.
        Parameters:
        sharedAccessStartTime - the sharedAccessStartTime value to set.
        Returns:
        the ServiceSasParameters object itself.
      • sharedAccessExpiryTime

        public OffsetDateTime sharedAccessExpiryTime()
        Get the sharedAccessExpiryTime property: The time at which the shared access signature becomes invalid.
        Returns:
        the sharedAccessExpiryTime value.
      • withSharedAccessExpiryTime

        public ServiceSasParameters withSharedAccessExpiryTime​(OffsetDateTime sharedAccessExpiryTime)
        Set the sharedAccessExpiryTime property: The time at which the shared access signature becomes invalid.
        Parameters:
        sharedAccessExpiryTime - the sharedAccessExpiryTime value to set.
        Returns:
        the ServiceSasParameters object itself.
      • identifier

        public String identifier()
        Get the identifier property: A unique value up to 64 characters in length that correlates to an access policy specified for the container, queue, or table.
        Returns:
        the identifier value.
      • withIdentifier

        public ServiceSasParameters withIdentifier​(String identifier)
        Set the identifier property: A unique value up to 64 characters in length that correlates to an access policy specified for the container, queue, or table.
        Parameters:
        identifier - the identifier value to set.
        Returns:
        the ServiceSasParameters object itself.
      • partitionKeyStart

        public String partitionKeyStart()
        Get the partitionKeyStart property: The start of partition key.
        Returns:
        the partitionKeyStart value.
      • withPartitionKeyStart

        public ServiceSasParameters withPartitionKeyStart​(String partitionKeyStart)
        Set the partitionKeyStart property: The start of partition key.
        Parameters:
        partitionKeyStart - the partitionKeyStart value to set.
        Returns:
        the ServiceSasParameters object itself.
      • partitionKeyEnd

        public String partitionKeyEnd()
        Get the partitionKeyEnd property: The end of partition key.
        Returns:
        the partitionKeyEnd value.
      • withPartitionKeyEnd

        public ServiceSasParameters withPartitionKeyEnd​(String partitionKeyEnd)
        Set the partitionKeyEnd property: The end of partition key.
        Parameters:
        partitionKeyEnd - the partitionKeyEnd value to set.
        Returns:
        the ServiceSasParameters object itself.
      • rowKeyStart

        public String rowKeyStart()
        Get the rowKeyStart property: The start of row key.
        Returns:
        the rowKeyStart value.
      • withRowKeyStart

        public ServiceSasParameters withRowKeyStart​(String rowKeyStart)
        Set the rowKeyStart property: The start of row key.
        Parameters:
        rowKeyStart - the rowKeyStart value to set.
        Returns:
        the ServiceSasParameters object itself.
      • rowKeyEnd

        public String rowKeyEnd()
        Get the rowKeyEnd property: The end of row key.
        Returns:
        the rowKeyEnd value.
      • withRowKeyEnd

        public ServiceSasParameters withRowKeyEnd​(String rowKeyEnd)
        Set the rowKeyEnd property: The end of row key.
        Parameters:
        rowKeyEnd - the rowKeyEnd value to set.
        Returns:
        the ServiceSasParameters object itself.
      • keyToSign

        public String keyToSign()
        Get the keyToSign property: The key to sign the account SAS token with.
        Returns:
        the keyToSign value.
      • withKeyToSign

        public ServiceSasParameters withKeyToSign​(String keyToSign)
        Set the keyToSign property: The key to sign the account SAS token with.
        Parameters:
        keyToSign - the keyToSign value to set.
        Returns:
        the ServiceSasParameters object itself.
      • cacheControl

        public String cacheControl()
        Get the cacheControl property: The response header override for cache control.
        Returns:
        the cacheControl value.
      • withCacheControl

        public ServiceSasParameters withCacheControl​(String cacheControl)
        Set the cacheControl property: The response header override for cache control.
        Parameters:
        cacheControl - the cacheControl value to set.
        Returns:
        the ServiceSasParameters object itself.
      • contentDisposition

        public String contentDisposition()
        Get the contentDisposition property: The response header override for content disposition.
        Returns:
        the contentDisposition value.
      • withContentDisposition

        public ServiceSasParameters withContentDisposition​(String contentDisposition)
        Set the contentDisposition property: The response header override for content disposition.
        Parameters:
        contentDisposition - the contentDisposition value to set.
        Returns:
        the ServiceSasParameters object itself.
      • contentEncoding

        public String contentEncoding()
        Get the contentEncoding property: The response header override for content encoding.
        Returns:
        the contentEncoding value.
      • withContentEncoding

        public ServiceSasParameters withContentEncoding​(String contentEncoding)
        Set the contentEncoding property: The response header override for content encoding.
        Parameters:
        contentEncoding - the contentEncoding value to set.
        Returns:
        the ServiceSasParameters object itself.
      • contentLanguage

        public String contentLanguage()
        Get the contentLanguage property: The response header override for content language.
        Returns:
        the contentLanguage value.
      • withContentLanguage

        public ServiceSasParameters withContentLanguage​(String contentLanguage)
        Set the contentLanguage property: The response header override for content language.
        Parameters:
        contentLanguage - the contentLanguage value to set.
        Returns:
        the ServiceSasParameters object itself.
      • contentType

        public String contentType()
        Get the contentType property: The response header override for content type.
        Returns:
        the contentType value.
      • withContentType

        public ServiceSasParameters withContentType​(String contentType)
        Set the contentType property: The response header override for content type.
        Parameters:
        contentType - the contentType value to set.
        Returns:
        the ServiceSasParameters object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.