Class AccountSasParameters


  • public final class AccountSasParameters
    extends Object
    The parameters to list SAS credentials of a storage account.
    • Constructor Detail

      • AccountSasParameters

        public AccountSasParameters()
    • Method Detail

      • services

        public Services services()
        Get the services property: The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f).
        Returns:
        the services value.
      • withServices

        public AccountSasParameters withServices​(Services services)
        Set the services property: The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f).
        Parameters:
        services - the services value to set.
        Returns:
        the AccountSasParameters object itself.
      • resourceTypes

        public SignedResourceTypes resourceTypes()
        Get the resourceTypes property: The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files.
        Returns:
        the resourceTypes value.
      • withResourceTypes

        public AccountSasParameters withResourceTypes​(SignedResourceTypes resourceTypes)
        Set the resourceTypes property: The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files.
        Parameters:
        resourceTypes - the resourceTypes value to set.
        Returns:
        the AccountSasParameters object itself.
      • permissions

        public Permissions permissions()
        Get the permissions property: The signed permissions for the account 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 AccountSasParameters withPermissions​(Permissions permissions)
        Set the permissions property: The signed permissions for the account 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 AccountSasParameters 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 AccountSasParameters 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 AccountSasParameters 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 AccountSasParameters 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 AccountSasParameters object itself.
      • sharedAccessStartTime

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

        public AccountSasParameters withSharedAccessStartTime​(OffsetDateTime sharedAccessStartTime)
        Set the sharedAccessStartTime property: The time at which the SAS becomes valid.
        Parameters:
        sharedAccessStartTime - the sharedAccessStartTime value to set.
        Returns:
        the AccountSasParameters 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 AccountSasParameters 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 AccountSasParameters 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 AccountSasParameters 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 AccountSasParameters object itself.
      • validate

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