Package com.azure.storage.blob.models

Class UserDelegationKey

java.lang.Object
com.azure.storage.blob.models.UserDelegationKey
All Implemented Interfaces:
com.azure.xml.XmlSerializable<UserDelegationKey>
public final class UserDelegationKey extends Object implements com.azure.xml.XmlSerializable<UserDelegationKey>
A user delegation key.

  • Constructor Details

    • UserDelegationKey

      public UserDelegationKey()
      Creates an instance of UserDelegationKey class.

  • Method Details

    • getSignedObjectId

      public String getSignedObjectId()
      Get the signedObjectId property: The Azure Active Directory object ID in GUID format.
      Returns:
      the signedObjectId value.

    • setSignedObjectId

      public UserDelegationKey setSignedObjectId(String signedObjectId)
      Set the signedObjectId property: The Azure Active Directory object ID in GUID format.
      Parameters:
      signedObjectId - the signedObjectId value to set.
      Returns:
      the UserDelegationKey object itself.

    • getSignedTenantId

      public String getSignedTenantId()
      Get the signedTenantId property: The Azure Active Directory tenant ID in GUID format.
      Returns:
      the signedTenantId value.

    • setSignedTenantId

      public UserDelegationKey setSignedTenantId(String signedTenantId)
      Set the signedTenantId property: The Azure Active Directory tenant ID in GUID format.
      Parameters:
      signedTenantId - the signedTenantId value to set.
      Returns:
      the UserDelegationKey object itself.

    • getSignedStart

      public OffsetDateTime getSignedStart()
      Get the signedStart property: The date-time the key is active.
      Returns:
      the signedStart value.

    • setSignedStart

      public UserDelegationKey setSignedStart(OffsetDateTime signedStart)
      Set the signedStart property: The date-time the key is active.
      Parameters:
      signedStart - the signedStart value to set.
      Returns:
      the UserDelegationKey object itself.

    • getSignedExpiry

      public OffsetDateTime getSignedExpiry()
      Get the signedExpiry property: The date-time the key expires.
      Returns:
      the signedExpiry value.

    • setSignedExpiry

      public UserDelegationKey setSignedExpiry(OffsetDateTime signedExpiry)
      Set the signedExpiry property: The date-time the key expires.
      Parameters:
      signedExpiry - the signedExpiry value to set.
      Returns:
      the UserDelegationKey object itself.

    • getSignedService

      public String getSignedService()
      Get the signedService property: Abbreviation of the Azure Storage service that accepts the key.
      Returns:
      the signedService value.

    • setSignedService

      public UserDelegationKey setSignedService(String signedService)
      Set the signedService property: Abbreviation of the Azure Storage service that accepts the key.
      Parameters:
      signedService - the signedService value to set.
      Returns:
      the UserDelegationKey object itself.

    • getSignedVersion

      public String getSignedVersion()
      Get the signedVersion property: The service version that created the key.
      Returns:
      the signedVersion value.

    • setSignedVersion

      public UserDelegationKey setSignedVersion(String signedVersion)
      Set the signedVersion property: The service version that created the key.
      Parameters:
      signedVersion - the signedVersion value to set.
      Returns:
      the UserDelegationKey object itself.

    • getValue

      public String getValue()
      Get the value property: The key as a base64 string.
      Returns:
      the value value.

    • setValue

      public UserDelegationKey setValue(String value)
      Set the value property: The key as a base64 string.
      Parameters:
      value - the value value to set.
      Returns:
      the UserDelegationKey object itself.

    • toXml

      public com.azure.xml.XmlWriter toXml(com.azure.xml.XmlWriter xmlWriter) throws XMLStreamException
      Specified by:
      toXml in interface com.azure.xml.XmlSerializable<UserDelegationKey>
      Throws:
      XMLStreamException

    • toXml

      public com.azure.xml.XmlWriter toXml(com.azure.xml.XmlWriter xmlWriter, String rootElementName) throws XMLStreamException
      Specified by:
      toXml in interface com.azure.xml.XmlSerializable<UserDelegationKey>
      Throws:
      XMLStreamException

    • fromXml

      public static UserDelegationKey fromXml(com.azure.xml.XmlReader xmlReader) throws XMLStreamException
      Reads an instance of UserDelegationKey from the XmlReader.
      Parameters:
      xmlReader - The XmlReader being read.
      Returns:
      An instance of UserDelegationKey if the XmlReader was pointing to an instance of it, or null if it was pointing to XML null.
      Throws:
      XMLStreamException - If an error occurs while reading the UserDelegationKey.

    • fromXml

      public static UserDelegationKey fromXml(com.azure.xml.XmlReader xmlReader, String rootElementName) throws XMLStreamException
      Reads an instance of UserDelegationKey from the XmlReader.
      Parameters:
      xmlReader - The XmlReader being read.
      rootElementName - Optional root element name to override the default defined by the model. Used to support cases where the model can deserialize from different root element names.
      Returns:
      An instance of UserDelegationKey if the XmlReader was pointing to an instance of it, or null if it was pointing to XML null.
      Throws:
      XMLStreamException - If an error occurs while reading the UserDelegationKey.