azure-docs-sdk-java/docs-ref-autogen/com.azure.monitor.query.mod...

168 строки
10 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.monitor.query.models.MetricDefinition"
fullName: "com.azure.monitor.query.models.MetricDefinition"
name: "MetricDefinition"
nameWithType: "MetricDefinition"
summary: "Metric definition class specifies the metadata for a metric."
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 **MetricDefinition**"
constructors:
- uid: "com.azure.monitor.query.models.MetricDefinition.MetricDefinition()"
fullName: "com.azure.monitor.query.models.MetricDefinition.MetricDefinition()"
name: "MetricDefinition()"
nameWithType: "MetricDefinition.MetricDefinition()"
summary: "Creates an instance of Metric<wbr>Definition."
syntax: "public MetricDefinition()"
desc: "Creates an instance of MetricDefinition."
methods:
- uid: "com.azure.monitor.query.models.MetricDefinition.getCategory()"
fullName: "com.azure.monitor.query.models.MetricDefinition.getCategory()"
name: "getCategory()"
nameWithType: "MetricDefinition.getCategory()"
summary: "Returns the custom category name for this metric."
syntax: "public String getCategory()"
desc: "Returns the custom category name for this metric."
returns:
description: "custom category name for this metric."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.monitor.query.models.MetricDefinition.getDescription()"
fullName: "com.azure.monitor.query.models.MetricDefinition.getDescription()"
name: "getDescription()"
nameWithType: "MetricDefinition.getDescription()"
summary: "Returns the detailed description of this metric."
syntax: "public String getDescription()"
desc: "Returns the detailed description of this metric."
returns:
description: "detailed description of this metric."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.monitor.query.models.MetricDefinition.getDimensions()"
fullName: "com.azure.monitor.query.models.MetricDefinition.getDimensions()"
name: "getDimensions()"
nameWithType: "MetricDefinition.getDimensions()"
summary: "Returns the names of all the dimensions available for this metric."
syntax: "public List<String> getDimensions()"
desc: "Returns the names of all the dimensions available for this metric."
returns:
description: "the names of all the dimensions available for this metric."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- uid: "com.azure.monitor.query.models.MetricDefinition.getId()"
fullName: "com.azure.monitor.query.models.MetricDefinition.getId()"
name: "getId()"
nameWithType: "MetricDefinition.getId()"
summary: "The resource identifier of the metric definition."
syntax: "public String getId()"
desc: "The resource identifier of the metric definition."
returns:
description: "the resource identifier of the metric definition."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.monitor.query.models.MetricDefinition.getMetricAvailabilities()"
fullName: "com.azure.monitor.query.models.MetricDefinition.getMetricAvailabilities()"
name: "getMetricAvailabilities()"
nameWithType: "MetricDefinition.getMetricAvailabilities()"
summary: "Returns the collection of what aggregation intervals are available to be queried."
syntax: "public List<MetricAvailability> getMetricAvailabilities()"
desc: "Returns the collection of what aggregation intervals are available to be queried."
returns:
description: "the collection of what aggregation intervals are available to be queried."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.monitor.query.models.MetricAvailability?alt=com.azure.monitor.query.models.MetricAvailability&text=MetricAvailability\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.monitor.query.models.MetricDefinition.getMetricClass()"
fullName: "com.azure.monitor.query.models.MetricDefinition.getMetricClass()"
name: "getMetricClass()"
nameWithType: "MetricDefinition.getMetricClass()"
summary: "Returns the class of the metric."
syntax: "public MetricClass getMetricClass()"
desc: "Returns the class of the metric."
returns:
description: "the class of the metric."
type: "<xref href=\"com.azure.monitor.query.models.MetricClass?alt=com.azure.monitor.query.models.MetricClass&text=MetricClass\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.monitor.query.models.MetricDefinition.getName()"
fullName: "com.azure.monitor.query.models.MetricDefinition.getName()"
name: "getName()"
nameWithType: "MetricDefinition.getName()"
summary: "Returns the name of the metric,"
syntax: "public String getName()"
desc: "Returns the name of the metric,"
returns:
description: "the name of the metric,"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.monitor.query.models.MetricDefinition.getNamespace()"
fullName: "com.azure.monitor.query.models.MetricDefinition.getNamespace()"
name: "getNamespace()"
nameWithType: "MetricDefinition.getNamespace()"
summary: "Returns the namespace the metric belongs to."
syntax: "public String getNamespace()"
desc: "Returns the namespace the metric belongs to."
returns:
description: "the namespace the metric belongs to."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.monitor.query.models.MetricDefinition.getPrimaryAggregationType()"
fullName: "com.azure.monitor.query.models.MetricDefinition.getPrimaryAggregationType()"
name: "getPrimaryAggregationType()"
nameWithType: "MetricDefinition.getPrimaryAggregationType()"
summary: "Returns the primary aggregation type value defining how to use the values for display."
syntax: "public AggregationType getPrimaryAggregationType()"
desc: "Returns the primary aggregation type value defining how to use the values for display."
returns:
description: "the primary aggregation type value defining how to use the values for display."
type: "<xref href=\"com.azure.monitor.query.models.AggregationType?alt=com.azure.monitor.query.models.AggregationType&text=AggregationType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.monitor.query.models.MetricDefinition.getResourceId()"
fullName: "com.azure.monitor.query.models.MetricDefinition.getResourceId()"
name: "getResourceId()"
nameWithType: "MetricDefinition.getResourceId()"
summary: "Returns the resource identifier of the resource that emitted the metric."
syntax: "public String getResourceId()"
desc: "Returns the resource identifier of the resource that emitted the metric."
returns:
description: "the resource identifier of the resource that emitted the metric."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.monitor.query.models.MetricDefinition.getSupportedAggregationTypes()"
fullName: "com.azure.monitor.query.models.MetricDefinition.getSupportedAggregationTypes()"
name: "getSupportedAggregationTypes()"
nameWithType: "MetricDefinition.getSupportedAggregationTypes()"
summary: "Returns the collection of what aggregation types are supported."
syntax: "public List<AggregationType> getSupportedAggregationTypes()"
desc: "Returns the collection of what aggregation types are supported."
returns:
description: "the collection of what aggregation types are supported."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.monitor.query.models.AggregationType?alt=com.azure.monitor.query.models.AggregationType&text=AggregationType\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.monitor.query.models.MetricDefinition.getUnit()"
fullName: "com.azure.monitor.query.models.MetricDefinition.getUnit()"
name: "getUnit()"
nameWithType: "MetricDefinition.getUnit()"
summary: "Returns the unit of the metric."
syntax: "public MetricUnit getUnit()"
desc: "Returns the unit of the metric."
returns:
description: "the unit of the metric."
type: "<xref href=\"com.azure.monitor.query.models.MetricUnit?alt=com.azure.monitor.query.models.MetricUnit&text=MetricUnit\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.monitor.query.models.MetricDefinition.isDimensionRequired()"
fullName: "com.azure.monitor.query.models.MetricDefinition.isDimensionRequired()"
name: "isDimensionRequired()"
nameWithType: "MetricDefinition.isDimensionRequired()"
summary: "Returns a flag to indicate whether the dimension is required."
syntax: "public Boolean isDimensionRequired()"
desc: "Returns a flag to indicate whether the dimension is required."
returns:
description: "Flag to indicate whether the dimension is required."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
type: "class"
desc: "Metric definition class specifies the metadata for a metric."
metadata: {}
package: "com.azure.monitor.query.models"
artifact: com.azure:azure-monitor-query:1.5.3