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

Implements

XmlSerializable<BlobMetrics>

public final class BlobMetrics
implements XmlSerializable<BlobMetrics>

a summary of request statistics grouped by API in hour or minute aggregates for blobs.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
static BlobMetrics	fromXml(XmlReader xmlReader) Reads an instance of BlobMetrics from the XmlReader.
static BlobMetrics	fromXml(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.
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

BlobMetrics

public BlobMetrics()

Creates an instance of BlobMetrics class.

Method Details

fromXml

public static BlobMetrics fromXml(XmlReader xmlReader)

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 the deserialized XML object was missing any required properties.

fromXml

public static BlobMetrics fromXml(XmlReader xmlReader, String rootElementName)

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 the deserialized XML object was missing any required properties.

getRetentionPolicy

public BlobRetentionPolicy getRetentionPolicy()

Get the retentionPolicy property: the retention policy which determines how long the associated data should persist.

Returns:

the retentionPolicy value.

getVersion

public String getVersion()

Get the version property: The version of Storage Analytics to configure.

Returns:

the version value.

isEnabled

public boolean isEnabled()

Get the enabled property: Indicates whether metrics are enabled for the Blob service.

Returns:

the enabled value.

isIncludeApis

public Boolean isIncludeApis()

Get the includeApis property: Indicates whether metrics should generate summary statistics for called API operations.

Returns:

the includeApis 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.

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.

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.

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.

toXml

public XmlWriter toXml(XmlWriter xmlWriter)

Parameters:

xmlWriter

Throws:

XMLStreamException

toXml

public XmlWriter toXml(XmlWriter xmlWriter, String rootElementName)

Parameters:

xmlWriter

rootElementName

Throws:

XMLStreamException