UserDelegationKey Class

Package:

com.azure.storage.blob.models

Maven Artifact:

com.azure:azure-storage-blob:12.28.0

• java.lang.Object
• • com.azure.storage.blob.models.UserDelegationKey

Implements

XmlSerializable<UserDelegationKey>

public final class UserDelegationKey
implements XmlSerializable<UserDelegationKey>

A user delegation key.

Constructor Summary

Constructor	Description
UserDelegationKey()	Creates an instance of UserDelegationKey class.

Method Summary

Modifier and Type	Method and Description
static UserDelegationKey	fromXml(XmlReader xmlReader) Reads an instance of UserDelegationKey from the XmlReader.
static UserDelegationKey	fromXml(XmlReader xmlReader, String rootElementName) Reads an instance of UserDelegationKey from the XmlReader.
OffsetDateTime	getSignedExpiry() Get the signedExpiry property: The date-time the key expires.
String	getSignedObjectId() Get the signedObjectId property: The Azure Active Directory object ID in GUID format.
String	getSignedService() Get the signedService property: Abbreviation of the Azure Storage service that accepts the key.
OffsetDateTime	getSignedStart() Get the signedStart property: The date-time the key is active.
String	getSignedTenantId() Get the signedTenantId property: The Azure Active Directory tenant ID in GUID format.
String	getSignedVersion() Get the signedVersion property: The service version that created the key.
String	getValue() Get the value property: The key as a base64 string.
UserDelegationKey	setSignedExpiry(OffsetDateTime signedExpiry) Set the signedExpiry property: The date-time the key expires.
UserDelegationKey	setSignedObjectId(String signedObjectId) Set the signedObjectId property: The Azure Active Directory object ID in GUID format.
UserDelegationKey	setSignedService(String signedService) Set the signedService property: Abbreviation of the Azure Storage service that accepts the key.
UserDelegationKey	setSignedStart(OffsetDateTime signedStart) Set the signedStart property: The date-time the key is active.
UserDelegationKey	setSignedTenantId(String signedTenantId) Set the signedTenantId property: The Azure Active Directory tenant ID in GUID format.
UserDelegationKey	setSignedVersion(String signedVersion) Set the signedVersion property: The service version that created the key.
UserDelegationKey	setValue(String value) Set the value property: The key as a base64 string.
XmlWriter	toXml(XmlWriter xmlWriter)
XmlWriter	toXml(XmlWriter xmlWriter, String rootElementName)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

UserDelegationKey

public UserDelegationKey()

Creates an instance of UserDelegationKey class.

Method Details

fromXml

public static UserDelegationKey fromXml(XmlReader xmlReader)

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 the deserialized XML object was missing any required properties.

fromXml

public static UserDelegationKey fromXml(XmlReader xmlReader, String rootElementName)

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 the deserialized XML object was missing any required properties.

getSignedExpiry

public OffsetDateTime getSignedExpiry()

Get the signedExpiry property: The date-time the key expires.

Returns:

the signedExpiry value.

getSignedObjectId

public String getSignedObjectId()

Get the signedObjectId property: The Azure Active Directory object ID in GUID format.

Returns:

the signedObjectId value.

getSignedService

public String getSignedService()

Get the signedService property: Abbreviation of the Azure Storage service that accepts the key.

Returns:

the signedService value.

getSignedStart

public OffsetDateTime getSignedStart()

Get the signedStart property: The date-time the key is active.

Returns:

the signedStart value.

getSignedTenantId

public String getSignedTenantId()

Get the signedTenantId property: The Azure Active Directory tenant ID in GUID format.

Returns:

the signedTenantId value.

getSignedVersion

public String getSignedVersion()

Get the signedVersion property: The service version that created the key.

Returns:

the signedVersion value.

getValue

public String getValue()

Get the value property: The key as a base64 string.

Returns:

the value 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.

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.

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.

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.

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.

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.

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 XmlWriter toXml(XmlWriter xmlWriter)

Parameters:

xmlWriter

Throws:

XMLStreamException

toXml

public XmlWriter toXml(XmlWriter xmlWriter, String rootElementName)

Parameters:

xmlWriter

rootElementName

Throws:

XMLStreamException