QueueRetentionPolicy Class

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

Implements

XmlSerializable<QueueRetentionPolicy>

public final class QueueRetentionPolicy
implements XmlSerializable<QueueRetentionPolicy>

the retention policy.

Constructor Summary

Constructor Description
QueueRetentionPolicy()

Creates an instance of QueueRetentionPolicy class.

Method Summary

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

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

Reads an instance of QueueRetentionPolicy from the XmlReader.
Integer getDays()

Get the days property: Indicates the number of days that metrics or logging or soft-deleted data should be retained.
boolean isEnabled()

Get the enabled property: Indicates whether a retention policy is enabled for the storage service.
QueueRetentionPolicy setDays(Integer days)

Set the days property: Indicates the number of days that metrics or logging or soft-deleted data should be retained.
QueueRetentionPolicy setEnabled(boolean enabled)

Set the enabled property: Indicates whether a retention policy is enabled for the storage service.
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

QueueRetentionPolicy

public QueueRetentionPolicy()

Creates an instance of QueueRetentionPolicy class.

Method Details

fromXml

public static QueueRetentionPolicy fromXml(XmlReader xmlReader)

Reads an instance of QueueRetentionPolicy from the XmlReader.

Parameters:

xmlReader - The XmlReader being read.

Returns:

An instance of QueueRetentionPolicy 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 QueueRetentionPolicy fromXml(XmlReader xmlReader, String rootElementName)

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

getDays

public Integer getDays()

Get the days property: Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted.

Returns:

the days value.

isEnabled

public boolean isEnabled()

Get the enabled property: Indicates whether a retention policy is enabled for the storage service.

Returns:

the enabled value.

setDays

public QueueRetentionPolicy setDays(Integer days)

Set the days property: Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted.

Parameters:

days - the days value to set.

Returns:

the QueueRetentionPolicy object itself.

setEnabled

public QueueRetentionPolicy setEnabled(boolean enabled)

Set the enabled property: Indicates whether a retention policy is enabled for the storage service.

Parameters:

enabled - the enabled value to set.

Returns:

the QueueRetentionPolicy 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