203 строки
14 KiB
YAML
203 строки
14 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.storage.file.share.models.ShareMetrics"
|
|
fullName: "com.azure.storage.file.share.models.ShareMetrics"
|
|
name: "ShareMetrics"
|
|
nameWithType: "ShareMetrics"
|
|
summary: "Storage Analytics metrics for file service."
|
|
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 **ShareMetrics**</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.file.share.models.ShareMetrics?alt=com.azure.storage.file.share.models.ShareMetrics&text=ShareMetrics\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.storage.file.share.models.ShareMetrics.ShareMetrics()"
|
|
fullName: "com.azure.storage.file.share.models.ShareMetrics.ShareMetrics()"
|
|
name: "ShareMetrics()"
|
|
nameWithType: "ShareMetrics.ShareMetrics()"
|
|
summary: "Creates an instance of Share<wbr>Metrics class."
|
|
syntax: "public ShareMetrics()"
|
|
desc: "Creates an instance of ShareMetrics class."
|
|
methods:
|
|
- uid: "com.azure.storage.file.share.models.ShareMetrics.fromXml(com.azure.xml.XmlReader)"
|
|
fullName: "com.azure.storage.file.share.models.ShareMetrics.fromXml(XmlReader xmlReader)"
|
|
name: "fromXml(XmlReader xmlReader)"
|
|
nameWithType: "ShareMetrics.fromXml(XmlReader xmlReader)"
|
|
summary: "Reads an instance of Share<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 ShareMetrics 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 ShareMetrics from the XmlReader."
|
|
returns:
|
|
description: "An instance of ShareMetrics 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.file.share.models.ShareMetrics?alt=com.azure.storage.file.share.models.ShareMetrics&text=ShareMetrics\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareMetrics.fromXml(com.azure.xml.XmlReader,java.lang.String)"
|
|
fullName: "com.azure.storage.file.share.models.ShareMetrics.fromXml(XmlReader xmlReader, String rootElementName)"
|
|
name: "fromXml(XmlReader xmlReader, String rootElementName)"
|
|
nameWithType: "ShareMetrics.fromXml(XmlReader xmlReader, String rootElementName)"
|
|
summary: "Reads an instance of Share<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 ShareMetrics 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 ShareMetrics from the XmlReader."
|
|
returns:
|
|
description: "An instance of ShareMetrics 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.file.share.models.ShareMetrics?alt=com.azure.storage.file.share.models.ShareMetrics&text=ShareMetrics\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareMetrics.getRetentionPolicy()"
|
|
fullName: "com.azure.storage.file.share.models.ShareMetrics.getRetentionPolicy()"
|
|
name: "getRetentionPolicy()"
|
|
nameWithType: "ShareMetrics.getRetentionPolicy()"
|
|
summary: "Get the retention<wbr>Policy property: The retention policy."
|
|
syntax: "public ShareRetentionPolicy getRetentionPolicy()"
|
|
desc: "Get the retentionPolicy property: The retention policy."
|
|
returns:
|
|
description: "the retentionPolicy value."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareRetentionPolicy?alt=com.azure.storage.file.share.models.ShareRetentionPolicy&text=ShareRetentionPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareMetrics.getVersion()"
|
|
fullName: "com.azure.storage.file.share.models.ShareMetrics.getVersion()"
|
|
name: "getVersion()"
|
|
nameWithType: "ShareMetrics.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.file.share.models.ShareMetrics.isEnabled()"
|
|
fullName: "com.azure.storage.file.share.models.ShareMetrics.isEnabled()"
|
|
name: "isEnabled()"
|
|
nameWithType: "ShareMetrics.isEnabled()"
|
|
summary: "Get the enabled property: Indicates whether metrics are enabled for the File service."
|
|
syntax: "public boolean isEnabled()"
|
|
desc: "Get the enabled property: Indicates whether metrics are enabled for the File service."
|
|
returns:
|
|
description: "the enabled value."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareMetrics.isIncludeApis()"
|
|
fullName: "com.azure.storage.file.share.models.ShareMetrics.isIncludeApis()"
|
|
name: "isIncludeApis()"
|
|
nameWithType: "ShareMetrics.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.file.share.models.ShareMetrics.setEnabled(boolean)"
|
|
fullName: "com.azure.storage.file.share.models.ShareMetrics.setEnabled(boolean enabled)"
|
|
name: "setEnabled(boolean enabled)"
|
|
nameWithType: "ShareMetrics.setEnabled(boolean enabled)"
|
|
summary: "Set the enabled property: Indicates whether metrics are enabled for the File 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 ShareMetrics setEnabled(boolean enabled)"
|
|
desc: "Set the enabled property: Indicates whether metrics are enabled for the File service."
|
|
returns:
|
|
description: "the ShareMetrics object itself."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareMetrics?alt=com.azure.storage.file.share.models.ShareMetrics&text=ShareMetrics\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareMetrics.setIncludeApis(java.lang.Boolean)"
|
|
fullName: "com.azure.storage.file.share.models.ShareMetrics.setIncludeApis(Boolean includeApis)"
|
|
name: "setIncludeApis(Boolean includeApis)"
|
|
nameWithType: "ShareMetrics.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 ShareMetrics setIncludeApis(Boolean includeApis)"
|
|
desc: "Set the includeApis property: Indicates whether metrics should generate summary statistics for called API operations."
|
|
returns:
|
|
description: "the ShareMetrics object itself."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareMetrics?alt=com.azure.storage.file.share.models.ShareMetrics&text=ShareMetrics\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareMetrics.setRetentionPolicy(com.azure.storage.file.share.models.ShareRetentionPolicy)"
|
|
fullName: "com.azure.storage.file.share.models.ShareMetrics.setRetentionPolicy(ShareRetentionPolicy retentionPolicy)"
|
|
name: "setRetentionPolicy(ShareRetentionPolicy retentionPolicy)"
|
|
nameWithType: "ShareMetrics.setRetentionPolicy(ShareRetentionPolicy 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.file.share.models.ShareRetentionPolicy?alt=com.azure.storage.file.share.models.ShareRetentionPolicy&text=ShareRetentionPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareMetrics setRetentionPolicy(ShareRetentionPolicy retentionPolicy)"
|
|
desc: "Set the retentionPolicy property: The retention policy."
|
|
returns:
|
|
description: "the ShareMetrics object itself."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareMetrics?alt=com.azure.storage.file.share.models.ShareMetrics&text=ShareMetrics\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareMetrics.setVersion(java.lang.String)"
|
|
fullName: "com.azure.storage.file.share.models.ShareMetrics.setVersion(String version)"
|
|
name: "setVersion(String version)"
|
|
nameWithType: "ShareMetrics.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 ShareMetrics setVersion(String version)"
|
|
desc: "Set the version property: The version of Storage Analytics to configure."
|
|
returns:
|
|
description: "the ShareMetrics object itself."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareMetrics?alt=com.azure.storage.file.share.models.ShareMetrics&text=ShareMetrics\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareMetrics.toXml(com.azure.xml.XmlWriter)"
|
|
fullName: "com.azure.storage.file.share.models.ShareMetrics.toXml(XmlWriter xmlWriter)"
|
|
name: "toXml(XmlWriter xmlWriter)"
|
|
nameWithType: "ShareMetrics.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.file.share.models.ShareMetrics.toXml(com.azure.xml.XmlWriter,java.lang.String)"
|
|
fullName: "com.azure.storage.file.share.models.ShareMetrics.toXml(XmlWriter xmlWriter, String rootElementName)"
|
|
name: "toXml(XmlWriter xmlWriter, String rootElementName)"
|
|
nameWithType: "ShareMetrics.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: "Storage Analytics metrics for file service."
|
|
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.file.share.models.ShareMetrics?alt=com.azure.storage.file.share.models.ShareMetrics&text=ShareMetrics\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.storage.file.share.models"
|
|
artifact: com.azure:azure-storage-file-share:12.23.1
|