BlobRetentionPolicy Class

Package:

com.azure.storage.blob.models

Maven Artifact:

com.azure:azure-storage-blob:12.28.1

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

Implements

XmlSerializable<BlobRetentionPolicy>

public final class BlobRetentionPolicy
implements XmlSerializable<BlobRetentionPolicy>

the retention policy which determines how long the associated data should persist.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
static BlobRetentionPolicy	fromXml(XmlReader xmlReader) Reads an instance of BlobRetentionPolicy from the XmlReader.
static BlobRetentionPolicy	fromXml(XmlReader xmlReader, String rootElementName) Reads an instance of BlobRetentionPolicy 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.
BlobRetentionPolicy	setDays(Integer days) Set the days property: Indicates the number of days that metrics or logging or soft-deleted data should be retained.
BlobRetentionPolicy	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

BlobRetentionPolicy

public BlobRetentionPolicy()

Creates an instance of BlobRetentionPolicy class.

Method Details

fromXml

public static BlobRetentionPolicy fromXml(XmlReader xmlReader)

Reads an instance of BlobRetentionPolicy from the XmlReader.

Parameters:

xmlReader - The XmlReader being read.

Returns:

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

Reads an instance of BlobRetentionPolicy 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 BlobRetentionPolicy 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 BlobRetentionPolicy 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 BlobRetentionPolicy object itself.

setEnabled

public BlobRetentionPolicy 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 BlobRetentionPolicy 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