Package com.azure.storage.blob.models

Class BlobRetentionPolicy

java.lang.Object
com.azure.storage.blob.models.BlobRetentionPolicy
All Implemented Interfaces:
com.azure.xml.XmlSerializable<BlobRetentionPolicy>
public final class BlobRetentionPolicy extends Object implements com.azure.xml.XmlSerializable<BlobRetentionPolicy>
the retention policy which determines how long the associated data should persist.

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static BlobRetentionPolicy
    fromXml(com.azure.xml.XmlReader xmlReader)
    Reads an instance of BlobRetentionPolicy from the XmlReader.
    static BlobRetentionPolicy
    fromXml(com.azure.xml.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.
    com.azure.xml.XmlWriter
    toXml(com.azure.xml.XmlWriter xmlWriter)
     
    com.azure.xml.XmlWriter
    toXml(com.azure.xml.XmlWriter xmlWriter, String rootElementName)
     

    Methods inherited from class 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

    • isEnabled

      public boolean isEnabled()
      Get the enabled property: Indicates whether a retention policy is enabled for the storage service.
      Returns:
      the enabled value.

    • 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.

    • 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.

    • 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.

    • toXml

      public com.azure.xml.XmlWriter toXml(com.azure.xml.XmlWriter xmlWriter) throws XMLStreamException
      Specified by:
      toXml in interface com.azure.xml.XmlSerializable<BlobRetentionPolicy>
      Throws:
      XMLStreamException

    • toXml

      public com.azure.xml.XmlWriter toXml(com.azure.xml.XmlWriter xmlWriter, String rootElementName) throws XMLStreamException
      Specified by:
      toXml in interface com.azure.xml.XmlSerializable<BlobRetentionPolicy>
      Throws:
      XMLStreamException

    • fromXml

      public static BlobRetentionPolicy fromXml(com.azure.xml.XmlReader xmlReader) throws XMLStreamException
      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 an error occurs while reading the BlobRetentionPolicy.

    • fromXml

      public static BlobRetentionPolicy fromXml(com.azure.xml.XmlReader xmlReader, String rootElementName) throws XMLStreamException
      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 an error occurs while reading the BlobRetentionPolicy.