Class ShareGetUserDelegationKeyOptions

java.lang.Object

com.azure.storage.file.share.options.ShareGetUserDelegationKeyOptions

public class ShareGetUserDelegationKeyOptions
extends Object

Extended options that may be passed when getting a user delegation key for a storage account.

Constructor Summary

Constructors

Constructor	Description
ShareGetUserDelegationKeyOptions(OffsetDateTime expiresOn)	Creates a new instance of ShareGetUserDelegationKeyOptions.

Method Summary

Modifier and Type	Method	Description
String	getDelegatedUserTenantId()	Gets the tenant ID of the user to whom the delegation key is issued in Azure AD.
OffsetDateTime	getExpiresOn()	Gets the expiration of the key's validity.
OffsetDateTime	getStartsOn()	Gets the start time of the key's validity.
ShareGetUserDelegationKeyOptions	setDelegatedUserTenantId(String delegatedUserTenantId)	Optional.
ShareGetUserDelegationKeyOptions	setStartsOn(OffsetDateTime startsOn)	Optional.

Methods inherited from class Object

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

Constructor Details

ShareGetUserDelegationKeyOptions

public ShareGetUserDelegationKeyOptions(OffsetDateTime expiresOn)

Creates a new instance of ShareGetUserDelegationKeyOptions.

Parameters:

expiresOn - Expiration of the key's validity. The time should be specified in UTC.

Throws:

NullPointerException - If expiresOn is null.

Method Details

getExpiresOn

public OffsetDateTime getExpiresOn()

Gets the expiration of the key's validity.

Returns:

The expiration time in UTC.

setStartsOn

public ShareGetUserDelegationKeyOptions setStartsOn(OffsetDateTime startsOn)

Optional. Sets the start time of the key's validity. Null indicates the key is valid immediately.

If you set the start time to the current time, failures might occur intermittently for the first few minutes. This is due to different machines having slightly different current times, known as clock skew.

Parameters:

startsOn - The start time in UTC.

Returns:

The updated ShareGetUserDelegationKeyOptions object.

getStartsOn

public OffsetDateTime getStartsOn()

Gets the start time of the key's validity.

Returns:

The start time in UTC.

setDelegatedUserTenantId

public ShareGetUserDelegationKeyOptions setDelegatedUserTenantId(String delegatedUserTenantId)

Optional. Sets the tenant ID of the user to whom the delegation key is issued in Azure AD.

Parameters:

delegatedUserTenantId - The tenant ID.

Returns:

The updated ShareGetUserDelegationKeyOptions object.

getDelegatedUserTenantId

public String getDelegatedUserTenantId()

Gets the tenant ID of the user to whom the delegation key is issued in Azure AD.

Returns:

The tenant ID.