203 строки
14 KiB
YAML
203 строки
14 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.storage.queue.models.QueueMetrics"
|
|
fullName: "com.azure.storage.queue.models.QueueMetrics"
|
|
name: "QueueMetrics"
|
|
nameWithType: "QueueMetrics"
|
|
summary: "a summary of request statistics grouped by API in hour or minute aggregates for queues."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **QueueMetrics**</br> implements <xref href=\"com.azure.xml.XmlSerializable?alt=com.azure.xml.XmlSerializable&text=XmlSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.storage.queue.models.QueueMetrics?alt=com.azure.storage.queue.models.QueueMetrics&text=QueueMetrics\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.storage.queue.models.QueueMetrics.QueueMetrics()"
|
|
fullName: "com.azure.storage.queue.models.QueueMetrics.QueueMetrics()"
|
|
name: "QueueMetrics()"
|
|
nameWithType: "QueueMetrics.QueueMetrics()"
|
|
summary: "Creates an instance of Queue<wbr>Metrics class."
|
|
syntax: "public QueueMetrics()"
|
|
desc: "Creates an instance of QueueMetrics class."
|
|
methods:
|
|
- uid: "com.azure.storage.queue.models.QueueMetrics.fromXml(com.azure.xml.XmlReader)"
|
|
fullName: "com.azure.storage.queue.models.QueueMetrics.fromXml(XmlReader xmlReader)"
|
|
name: "fromXml(XmlReader xmlReader)"
|
|
nameWithType: "QueueMetrics.fromXml(XmlReader xmlReader)"
|
|
summary: "Reads an instance of Queue<wbr>Metrics from the Xml<wbr>Reader."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "The XmlReader being read."
|
|
name: "xmlReader"
|
|
type: "<xref href=\"com.azure.xml.XmlReader?alt=com.azure.xml.XmlReader&text=XmlReader\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static QueueMetrics fromXml(XmlReader xmlReader)"
|
|
exceptions:
|
|
- description: "If the deserialized XML object was missing any required properties."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLStreamException.html\">XMLStreamException</a>"
|
|
desc: "Reads an instance of QueueMetrics from the XmlReader."
|
|
returns:
|
|
description: "An instance of QueueMetrics if the XmlReader was pointing to an instance of it, or null if it was\n pointing to XML null."
|
|
type: "<xref href=\"com.azure.storage.queue.models.QueueMetrics?alt=com.azure.storage.queue.models.QueueMetrics&text=QueueMetrics\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.queue.models.QueueMetrics.fromXml(com.azure.xml.XmlReader,java.lang.String)"
|
|
fullName: "com.azure.storage.queue.models.QueueMetrics.fromXml(XmlReader xmlReader, String rootElementName)"
|
|
name: "fromXml(XmlReader xmlReader, String rootElementName)"
|
|
nameWithType: "QueueMetrics.fromXml(XmlReader xmlReader, String rootElementName)"
|
|
summary: "Reads an instance of Queue<wbr>Metrics from the Xml<wbr>Reader."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "The XmlReader being read."
|
|
name: "xmlReader"
|
|
type: "<xref href=\"com.azure.xml.XmlReader?alt=com.azure.xml.XmlReader&text=XmlReader\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Optional root element name to override the default defined by the model. Used to support\n cases where the model can deserialize from different root element names."
|
|
name: "rootElementName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public static QueueMetrics fromXml(XmlReader xmlReader, String rootElementName)"
|
|
exceptions:
|
|
- description: "If the deserialized XML object was missing any required properties."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLStreamException.html\">XMLStreamException</a>"
|
|
desc: "Reads an instance of QueueMetrics from the XmlReader."
|
|
returns:
|
|
description: "An instance of QueueMetrics if the XmlReader was pointing to an instance of it, or null if it was\n pointing to XML null."
|
|
type: "<xref href=\"com.azure.storage.queue.models.QueueMetrics?alt=com.azure.storage.queue.models.QueueMetrics&text=QueueMetrics\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.queue.models.QueueMetrics.getRetentionPolicy()"
|
|
fullName: "com.azure.storage.queue.models.QueueMetrics.getRetentionPolicy()"
|
|
name: "getRetentionPolicy()"
|
|
nameWithType: "QueueMetrics.getRetentionPolicy()"
|
|
summary: "Get the retention<wbr>Policy property: the retention policy."
|
|
syntax: "public QueueRetentionPolicy getRetentionPolicy()"
|
|
desc: "Get the retentionPolicy property: the retention policy."
|
|
returns:
|
|
description: "the retentionPolicy value."
|
|
type: "<xref href=\"com.azure.storage.queue.models.QueueRetentionPolicy?alt=com.azure.storage.queue.models.QueueRetentionPolicy&text=QueueRetentionPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.queue.models.QueueMetrics.getVersion()"
|
|
fullName: "com.azure.storage.queue.models.QueueMetrics.getVersion()"
|
|
name: "getVersion()"
|
|
nameWithType: "QueueMetrics.getVersion()"
|
|
summary: "Get the version property: The version of Storage Analytics to configure."
|
|
syntax: "public String getVersion()"
|
|
desc: "Get the version property: The version of Storage Analytics to configure."
|
|
returns:
|
|
description: "the version value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.queue.models.QueueMetrics.isEnabled()"
|
|
fullName: "com.azure.storage.queue.models.QueueMetrics.isEnabled()"
|
|
name: "isEnabled()"
|
|
nameWithType: "QueueMetrics.isEnabled()"
|
|
summary: "Get the enabled property: Indicates whether metrics are enabled for the Queue service."
|
|
syntax: "public boolean isEnabled()"
|
|
desc: "Get the enabled property: Indicates whether metrics are enabled for the Queue service."
|
|
returns:
|
|
description: "the enabled value."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.queue.models.QueueMetrics.isIncludeApis()"
|
|
fullName: "com.azure.storage.queue.models.QueueMetrics.isIncludeApis()"
|
|
name: "isIncludeApis()"
|
|
nameWithType: "QueueMetrics.isIncludeApis()"
|
|
summary: "Get the include<wbr>Apis property: Indicates whether metrics should generate summary statistics for called API operations."
|
|
syntax: "public Boolean isIncludeApis()"
|
|
desc: "Get the includeApis property: Indicates whether metrics should generate summary statistics for called API operations."
|
|
returns:
|
|
description: "the includeApis value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.azure.storage.queue.models.QueueMetrics.setEnabled(boolean)"
|
|
fullName: "com.azure.storage.queue.models.QueueMetrics.setEnabled(boolean enabled)"
|
|
name: "setEnabled(boolean enabled)"
|
|
nameWithType: "QueueMetrics.setEnabled(boolean enabled)"
|
|
summary: "Set the enabled property: Indicates whether metrics are enabled for the Queue service."
|
|
parameters:
|
|
- description: "the enabled value to set."
|
|
name: "enabled"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public QueueMetrics setEnabled(boolean enabled)"
|
|
desc: "Set the enabled property: Indicates whether metrics are enabled for the Queue service."
|
|
returns:
|
|
description: "the QueueMetrics object itself."
|
|
type: "<xref href=\"com.azure.storage.queue.models.QueueMetrics?alt=com.azure.storage.queue.models.QueueMetrics&text=QueueMetrics\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.queue.models.QueueMetrics.setIncludeApis(java.lang.Boolean)"
|
|
fullName: "com.azure.storage.queue.models.QueueMetrics.setIncludeApis(Boolean includeApis)"
|
|
name: "setIncludeApis(Boolean includeApis)"
|
|
nameWithType: "QueueMetrics.setIncludeApis(Boolean includeApis)"
|
|
summary: "Set the include<wbr>Apis property: Indicates whether metrics should generate summary statistics for called API operations."
|
|
parameters:
|
|
- description: "the includeApis value to set."
|
|
name: "includeApis"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public QueueMetrics setIncludeApis(Boolean includeApis)"
|
|
desc: "Set the includeApis property: Indicates whether metrics should generate summary statistics for called API operations."
|
|
returns:
|
|
description: "the QueueMetrics object itself."
|
|
type: "<xref href=\"com.azure.storage.queue.models.QueueMetrics?alt=com.azure.storage.queue.models.QueueMetrics&text=QueueMetrics\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.queue.models.QueueMetrics.setRetentionPolicy(com.azure.storage.queue.models.QueueRetentionPolicy)"
|
|
fullName: "com.azure.storage.queue.models.QueueMetrics.setRetentionPolicy(QueueRetentionPolicy retentionPolicy)"
|
|
name: "setRetentionPolicy(QueueRetentionPolicy retentionPolicy)"
|
|
nameWithType: "QueueMetrics.setRetentionPolicy(QueueRetentionPolicy retentionPolicy)"
|
|
summary: "Set the retention<wbr>Policy property: the retention policy."
|
|
parameters:
|
|
- description: "the retentionPolicy value to set."
|
|
name: "retentionPolicy"
|
|
type: "<xref href=\"com.azure.storage.queue.models.QueueRetentionPolicy?alt=com.azure.storage.queue.models.QueueRetentionPolicy&text=QueueRetentionPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public QueueMetrics setRetentionPolicy(QueueRetentionPolicy retentionPolicy)"
|
|
desc: "Set the retentionPolicy property: the retention policy."
|
|
returns:
|
|
description: "the QueueMetrics object itself."
|
|
type: "<xref href=\"com.azure.storage.queue.models.QueueMetrics?alt=com.azure.storage.queue.models.QueueMetrics&text=QueueMetrics\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.queue.models.QueueMetrics.setVersion(java.lang.String)"
|
|
fullName: "com.azure.storage.queue.models.QueueMetrics.setVersion(String version)"
|
|
name: "setVersion(String version)"
|
|
nameWithType: "QueueMetrics.setVersion(String version)"
|
|
summary: "Set the version property: The version of Storage Analytics to configure."
|
|
parameters:
|
|
- description: "the version value to set."
|
|
name: "version"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public QueueMetrics setVersion(String version)"
|
|
desc: "Set the version property: The version of Storage Analytics to configure."
|
|
returns:
|
|
description: "the QueueMetrics object itself."
|
|
type: "<xref href=\"com.azure.storage.queue.models.QueueMetrics?alt=com.azure.storage.queue.models.QueueMetrics&text=QueueMetrics\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.queue.models.QueueMetrics.toXml(com.azure.xml.XmlWriter)"
|
|
fullName: "com.azure.storage.queue.models.QueueMetrics.toXml(XmlWriter xmlWriter)"
|
|
name: "toXml(XmlWriter xmlWriter)"
|
|
nameWithType: "QueueMetrics.toXml(XmlWriter xmlWriter)"
|
|
parameters:
|
|
- name: "xmlWriter"
|
|
type: "<xref href=\"com.azure.xml.XmlWriter?alt=com.azure.xml.XmlWriter&text=XmlWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public XmlWriter toXml(XmlWriter xmlWriter)"
|
|
exceptions:
|
|
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLStreamException.html\">XMLStreamException</a>"
|
|
returns:
|
|
type: "<xref href=\"com.azure.xml.XmlWriter?alt=com.azure.xml.XmlWriter&text=XmlWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.queue.models.QueueMetrics.toXml(com.azure.xml.XmlWriter,java.lang.String)"
|
|
fullName: "com.azure.storage.queue.models.QueueMetrics.toXml(XmlWriter xmlWriter, String rootElementName)"
|
|
name: "toXml(XmlWriter xmlWriter, String rootElementName)"
|
|
nameWithType: "QueueMetrics.toXml(XmlWriter xmlWriter, String rootElementName)"
|
|
parameters:
|
|
- name: "xmlWriter"
|
|
type: "<xref href=\"com.azure.xml.XmlWriter?alt=com.azure.xml.XmlWriter&text=XmlWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
- name: "rootElementName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public XmlWriter toXml(XmlWriter xmlWriter, String rootElementName)"
|
|
exceptions:
|
|
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLStreamException.html\">XMLStreamException</a>"
|
|
returns:
|
|
type: "<xref href=\"com.azure.xml.XmlWriter?alt=com.azure.xml.XmlWriter&text=XmlWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "a summary of request statistics grouped by API in hour or minute aggregates for queues."
|
|
implements:
|
|
- "<xref href=\"com.azure.xml.XmlSerializable?alt=com.azure.xml.XmlSerializable&text=XmlSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.storage.queue.models.QueueMetrics?alt=com.azure.storage.queue.models.QueueMetrics&text=QueueMetrics\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.storage.queue.models"
|
|
artifact: com.azure:azure-storage-queue:12.23.0
|