101 строка
9.6 KiB
YAML
101 строка
9.6 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.core.util.MetricsOptions"
|
|
fullName: "com.azure.core.util.MetricsOptions"
|
|
name: "MetricsOptions"
|
|
nameWithType: "MetricsOptions"
|
|
summary: "Metrics configuration options for clients."
|
|
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 class **MetricsOptions**"
|
|
constructors:
|
|
- uid: "com.azure.core.util.MetricsOptions.MetricsOptions()"
|
|
fullName: "com.azure.core.util.MetricsOptions.MetricsOptions()"
|
|
name: "MetricsOptions()"
|
|
nameWithType: "MetricsOptions.MetricsOptions()"
|
|
summary: "Creates new instance of <xref uid=\"com.azure.core.util.MetricsOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MetricsOptions\"></xref>"
|
|
syntax: "public MetricsOptions()"
|
|
desc: "Creates new instance of <xref uid=\"com.azure.core.util.MetricsOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MetricsOptions\"></xref>"
|
|
- uid: "com.azure.core.util.MetricsOptions.MetricsOptions(java.lang.Class<? extends com.azure.core.util.metrics.MeterProvider>)"
|
|
fullName: "com.azure.core.util.MetricsOptions.MetricsOptions(Class<? extends MeterProvider> meterProvider)"
|
|
name: "MetricsOptions(Class<? extends MeterProvider> meterProvider)"
|
|
nameWithType: "MetricsOptions.MetricsOptions(Class<? extends MeterProvider> meterProvider)"
|
|
summary: "Creates new instance of <xref uid=\"com.azure.core.util.MetricsOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MetricsOptions\"></xref>"
|
|
modifiers:
|
|
- "protected"
|
|
parameters:
|
|
- description: "type of the <xref uid=\"? extends com.azure.core.util.metrics.MeterProvider\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MeterProvider\"></xref> implementation that should be used to construct an instance of\n <xref uid=\"com.azure.core.util.metrics.Meter\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Meter\"></xref>.\n If the value is not set (or <code>null</code>), then the first <xref uid=\"? extends com.azure.core.util.metrics.MeterProvider\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MeterProvider\"></xref> resolved by <a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html\">ServiceLoader</a> will\n be used to create an instance of <xref uid=\"com.azure.core.util.metrics.Meter\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Meter\"></xref>. If the value is set and doesn't match any\n <xref uid=\"? extends com.azure.core.util.metrics.MeterProvider\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MeterProvider\"></xref> resolved by <a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html\">ServiceLoader</a> an <xref uid=\"java.lang.IllegalStateException\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IllegalStateException\"></xref> will be thrown when\n attempting to create an instance of <xref uid=\"com.azure.core.util.metrics.Meter\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Meter\"></xref>."
|
|
name: "meterProvider"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html\">Class</a><<xref href=\"? extends com.azure.core.util.metrics.MeterProvider?alt=? extends com.azure.core.util.metrics.MeterProvider&text=MeterProvider\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "protected MetricsOptions(Class<? extends MeterProvider> meterProvider)"
|
|
desc: "Creates new instance of <xref uid=\"com.azure.core.util.MetricsOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MetricsOptions\"></xref>"
|
|
methods:
|
|
- uid: "com.azure.core.util.MetricsOptions.fromConfiguration(com.azure.core.util.Configuration)"
|
|
fullName: "com.azure.core.util.MetricsOptions.fromConfiguration(Configuration configuration)"
|
|
name: "fromConfiguration(Configuration configuration)"
|
|
nameWithType: "MetricsOptions.fromConfiguration(Configuration configuration)"
|
|
summary: "Attempts to load metrics options from the configuration."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "The <xref uid=\"com.azure.core.util.Configuration\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Configuration\"></xref> instance containing metrics options. If\n <code>null</code> is passed then <xref uid=\"com.azure.core.util.Configuration.getGlobalConfiguration()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Configuration#getGlobalConfiguration()\"></xref> will be used."
|
|
name: "configuration"
|
|
type: "<xref href=\"com.azure.core.util.Configuration?alt=com.azure.core.util.Configuration&text=Configuration\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static MetricsOptions fromConfiguration(Configuration configuration)"
|
|
desc: "Attempts to load metrics options from the configuration."
|
|
returns:
|
|
description: "A <xref uid=\"com.azure.core.util.MetricsOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MetricsOptions\"></xref> reflecting a metrics loaded from configuration, if no options are found, default\n (enabled) options will be returned."
|
|
type: "<xref href=\"com.azure.core.util.MetricsOptions?alt=com.azure.core.util.MetricsOptions&text=MetricsOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.util.MetricsOptions.getMeterProvider()"
|
|
fullName: "com.azure.core.util.MetricsOptions.getMeterProvider()"
|
|
name: "getMeterProvider()"
|
|
nameWithType: "MetricsOptions.getMeterProvider()"
|
|
summary: "Gets configured <xref uid=\"? extends com.azure.core.util.metrics.MeterProvider\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MeterProvider\"></xref> implementation that should be used to construct an instance of <xref uid=\"com.azure.core.util.metrics.Meter\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Meter\"></xref>."
|
|
syntax: "public Class<? extends MeterProvider> getMeterProvider()"
|
|
desc: "Gets configured <xref uid=\"? extends com.azure.core.util.metrics.MeterProvider\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MeterProvider\"></xref> implementation that should be used to construct an instance of <xref uid=\"com.azure.core.util.metrics.Meter\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Meter\"></xref>."
|
|
returns:
|
|
description: "The <xref uid=\"? extends com.azure.core.util.metrics.MeterProvider\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MeterProvider\"></xref> implementation used to create an instance of <xref uid=\"com.azure.core.util.metrics.Meter\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Meter\"></xref>."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html\">Class</a><<xref href=\"? extends com.azure.core.util.metrics.MeterProvider?alt=? extends com.azure.core.util.metrics.MeterProvider&text=MeterProvider\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.core.util.MetricsOptions.isEnabled()"
|
|
fullName: "com.azure.core.util.MetricsOptions.isEnabled()"
|
|
name: "isEnabled()"
|
|
nameWithType: "MetricsOptions.isEnabled()"
|
|
summary: "Flag indicating if metrics should be enabled."
|
|
syntax: "public boolean isEnabled()"
|
|
desc: "Flag indicating if metrics should be enabled."
|
|
returns:
|
|
description: "<code>true</code> if metrics are enabled, <code>false</code> otherwise."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.util.MetricsOptions.setEnabled(boolean)"
|
|
fullName: "com.azure.core.util.MetricsOptions.setEnabled(boolean enabled)"
|
|
name: "setEnabled(boolean enabled)"
|
|
nameWithType: "MetricsOptions.setEnabled(boolean enabled)"
|
|
summary: "Enables or disables metrics."
|
|
parameters:
|
|
- description: "pass <code>true</code> to enable metrics."
|
|
name: "enabled"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public MetricsOptions setEnabled(boolean enabled)"
|
|
desc: "Enables or disables metrics. By default, metrics are enabled if and only if metrics implementation is detected."
|
|
returns:
|
|
description: "the updated <xref uid=\"com.azure.core.util.MetricsOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MetricsOptions\"></xref> object."
|
|
type: "<xref href=\"com.azure.core.util.MetricsOptions?alt=com.azure.core.util.MetricsOptions&text=MetricsOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Metrics configuration options for clients."
|
|
metadata: {}
|
|
package: "com.azure.core.util"
|
|
artifact: com.azure:azure-core:1.52.0
|