Package com.azure.storage.blob.models

Class BlobMetrics

java.lang.Object
com.azure.storage.blob.models.BlobMetrics
All Implemented Interfaces:
com.azure.xml.XmlSerializable<BlobMetrics>
public final class BlobMetrics extends Object implements com.azure.xml.XmlSerializable<BlobMetrics>
a summary of request statistics grouped by API in hour or minute aggregates for blobs.

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static BlobMetrics
    fromXml(com.azure.xml.XmlReader xmlReader)
    Reads an instance of BlobMetrics from the XmlReader.
    static BlobMetrics
    fromXml(com.azure.xml.XmlReader xmlReader, String rootElementName)
    Reads an instance of BlobMetrics from the XmlReader.
    BlobRetentionPolicy
    getRetentionPolicy()
    Get the retentionPolicy property: the retention policy which determines how long the associated data should persist.
    String
    getVersion()
    Get the version property: The version of Storage Analytics to configure.
    boolean
    isEnabled()
    Get the enabled property: Indicates whether metrics are enabled for the Blob service.
    Boolean
    isIncludeApis()
    Get the includeApis property: Indicates whether metrics should generate summary statistics for called API operations.
    BlobMetrics
    setEnabled(boolean enabled)
    Set the enabled property: Indicates whether metrics are enabled for the Blob service.
    BlobMetrics
    setIncludeApis(Boolean includeApis)
    Set the includeApis property: Indicates whether metrics should generate summary statistics for called API operations.
    BlobMetrics
    setRetentionPolicy(BlobRetentionPolicy retentionPolicy)
    Set the retentionPolicy property: the retention policy which determines how long the associated data should persist.
    BlobMetrics
    setVersion(String version)
    Set the version property: The version of Storage Analytics to configure.
    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

    • BlobMetrics

      public BlobMetrics()
      Creates an instance of BlobMetrics class.

  • Method Details

    • getVersion

      public String getVersion()
      Get the version property: The version of Storage Analytics to configure.
      Returns:
      the version value.

    • setVersion

      public BlobMetrics setVersion(String version)
      Set the version property: The version of Storage Analytics to configure.
      Parameters:
      version - the version value to set.
      Returns:
      the BlobMetrics object itself.

    • isEnabled

      public boolean isEnabled()
      Get the enabled property: Indicates whether metrics are enabled for the Blob service.
      Returns:
      the enabled value.

    • setEnabled

      public BlobMetrics setEnabled(boolean enabled)
      Set the enabled property: Indicates whether metrics are enabled for the Blob service.
      Parameters:
      enabled - the enabled value to set.
      Returns:
      the BlobMetrics object itself.

    • isIncludeApis

      public Boolean isIncludeApis()
      Get the includeApis property: Indicates whether metrics should generate summary statistics for called API operations.
      Returns:
      the includeApis value.

    • setIncludeApis

      public BlobMetrics setIncludeApis(Boolean includeApis)
      Set the includeApis property: Indicates whether metrics should generate summary statistics for called API operations.
      Parameters:
      includeApis - the includeApis value to set.
      Returns:
      the BlobMetrics object itself.

    • getRetentionPolicy

      public BlobRetentionPolicy getRetentionPolicy()
      Get the retentionPolicy property: the retention policy which determines how long the associated data should persist.
      Returns:
      the retentionPolicy value.

    • setRetentionPolicy

      public BlobMetrics setRetentionPolicy(BlobRetentionPolicy retentionPolicy)
      Set the retentionPolicy property: the retention policy which determines how long the associated data should persist.
      Parameters:
      retentionPolicy - the retentionPolicy value to set.
      Returns:
      the BlobMetrics 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<BlobMetrics>
      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<BlobMetrics>
      Throws:
      XMLStreamException

    • fromXml

      public static BlobMetrics fromXml(com.azure.xml.XmlReader xmlReader) throws XMLStreamException
      Reads an instance of BlobMetrics from the XmlReader.
      Parameters:
      xmlReader - The XmlReader being read.
      Returns:
      An instance of BlobMetrics 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 BlobMetrics.

    • fromXml

      public static BlobMetrics fromXml(com.azure.xml.XmlReader xmlReader, String rootElementName) throws XMLStreamException
      Reads an instance of BlobMetrics 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 BlobMetrics 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 BlobMetrics.