Share via

QueueAccessPolicy Class

  • Reference
Package:
com.azure.storage.queue.models
Maven Artifact:
com.azure:azure-storage-queue:12.24.1
  • java.lang.Object
    • com.azure.storage.queue.models.QueueAccessPolicy

Implements

XmlSerializable<QueueAccessPolicy>

public final class QueueAccessPolicy
implements XmlSerializable<QueueAccessPolicy>

An Access policy.

Constructor Summary

Constructor Description
QueueAccessPolicy()

Creates an instance of QueueAccessPolicy class.

Method Summary

Modifier and Type Method and Description
static QueueAccessPolicy fromXml(XmlReader xmlReader)

Reads an instance of QueueAccessPolicy from the XmlReader.
static QueueAccessPolicy fromXml(XmlReader xmlReader, String rootElementName)

Reads an instance of QueueAccessPolicy from the XmlReader.
OffsetDateTime getExpiresOn()

Get the expiresOn property: the date-time the policy expires.
String getPermissions()

Get the permissions property: the permissions for the acl policy.
OffsetDateTime getStartsOn()

Get the startsOn property: the date-time the policy is active.
QueueAccessPolicy setExpiresOn(OffsetDateTime expiresOn)

Set the expiresOn property: the date-time the policy expires.
QueueAccessPolicy setPermissions(String permissions)

Set the permissions property: the permissions for the acl policy.
QueueAccessPolicy setStartsOn(OffsetDateTime startsOn)

Set the startsOn property: the date-time the policy is active.
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

QueueAccessPolicy

public QueueAccessPolicy()

Creates an instance of QueueAccessPolicy class.

Method Details

fromXml

public static QueueAccessPolicy fromXml(XmlReader xmlReader)

Reads an instance of QueueAccessPolicy from the XmlReader.

Parameters:

xmlReader - The XmlReader being read.

Returns:

An instance of QueueAccessPolicy 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 QueueAccessPolicy.

fromXml

public static QueueAccessPolicy fromXml(XmlReader xmlReader, String rootElementName)

Reads an instance of QueueAccessPolicy 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 QueueAccessPolicy 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 QueueAccessPolicy.

getExpiresOn

public OffsetDateTime getExpiresOn()

Get the expiresOn property: the date-time the policy expires.

Returns:

the expiresOn value.

getPermissions

public String getPermissions()

Get the permissions property: the permissions for the acl policy.

Returns:

the permissions value.

getStartsOn

public OffsetDateTime getStartsOn()

Get the startsOn property: the date-time the policy is active.

Returns:

the startsOn value.

setExpiresOn

public QueueAccessPolicy setExpiresOn(OffsetDateTime expiresOn)

Set the expiresOn property: the date-time the policy expires.

Parameters:

expiresOn - the expiresOn value to set.

Returns:

the QueueAccessPolicy object itself.

setPermissions

public QueueAccessPolicy setPermissions(String permissions)

Set the permissions property: the permissions for the acl policy.

Parameters:

permissions - the permissions value to set.

Returns:

the QueueAccessPolicy object itself.

setStartsOn

public QueueAccessPolicy setStartsOn(OffsetDateTime startsOn)

Set the startsOn property: the date-time the policy is active.

Parameters:

startsOn - the startsOn value to set.

Returns:

the QueueAccessPolicy object itself.

toXml

public XmlWriter toXml(XmlWriter xmlWriter)

Parameters:

xmlWriter

Throws:

toXml

public XmlWriter toXml(XmlWriter xmlWriter, String rootElementName)

Parameters:

xmlWriter
rootElementName

Throws:

Applies to

Azure SDK for Java

Latest