QueueMetrics Class

Package:

com.azure.storage.queue.models

Maven Artifact:

com.azure:azure-storage-queue:12.24.0

• java.lang.Object
• • com.azure.storage.queue.models.QueueMetrics

Implements

XmlSerializable<QueueMetrics>

public final class QueueMetrics
implements XmlSerializable<QueueMetrics>

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

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
static QueueMetrics	fromXml(XmlReader xmlReader) Reads an instance of QueueMetrics from the XmlReader.
static QueueMetrics	fromXml(XmlReader xmlReader, String rootElementName) Reads an instance of QueueMetrics from the XmlReader.
QueueRetentionPolicy	getRetentionPolicy() Get the retentionPolicy property: the retention policy.
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 Queue service.
Boolean	isIncludeApis() Get the includeApis property: Indicates whether metrics should generate summary statistics for called API operations.
QueueMetrics	setEnabled(boolean enabled) Set the enabled property: Indicates whether metrics are enabled for the Queue service.
QueueMetrics	setIncludeApis(Boolean includeApis) Set the includeApis property: Indicates whether metrics should generate summary statistics for called API operations.
QueueMetrics	setRetentionPolicy(QueueRetentionPolicy retentionPolicy) Set the retentionPolicy property: the retention policy.
QueueMetrics	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

QueueMetrics

public QueueMetrics()

Creates an instance of QueueMetrics class.

Method Details

fromXml

public static QueueMetrics fromXml(XmlReader xmlReader)

Reads an instance of QueueMetrics from the XmlReader.

Parameters:

xmlReader - The XmlReader being read.

Returns:

An instance of QueueMetrics 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 QueueMetrics.

fromXml

public static QueueMetrics fromXml(XmlReader xmlReader, String rootElementName)

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

getRetentionPolicy

public QueueRetentionPolicy getRetentionPolicy()

Get the retentionPolicy property: the retention policy.

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 Queue 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 QueueMetrics setEnabled(boolean enabled)

Set the enabled property: Indicates whether metrics are enabled for the Queue service.

Parameters:

enabled - the enabled value to set.

Returns:

the QueueMetrics object itself.

setIncludeApis

public QueueMetrics 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 QueueMetrics object itself.

setRetentionPolicy

public QueueMetrics setRetentionPolicy(QueueRetentionPolicy retentionPolicy)

Set the retentionPolicy property: the retention policy.

Parameters:

retentionPolicy - the retentionPolicy value to set.

Returns:

the QueueMetrics object itself.

setVersion

public QueueMetrics setVersion(String version)

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

Parameters:

version - the version value to set.

Returns:

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