276 строки
20 KiB
YAML
276 строки
20 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification"
|
|
fullName: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification"
|
|
name: "MetricSpecification"
|
|
nameWithType: "MetricSpecification"
|
|
summary: "Specifications of the Metrics for Azure Monitoring."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public class **MetricSpecification**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.MetricSpecification()"
|
|
fullName: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.MetricSpecification()"
|
|
name: "MetricSpecification()"
|
|
nameWithType: "MetricSpecification.MetricSpecification()"
|
|
syntax: "public MetricSpecification()"
|
|
methods:
|
|
- uid: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.aggregationType()"
|
|
fullName: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.aggregationType()"
|
|
name: "aggregationType()"
|
|
nameWithType: "MetricSpecification.aggregationType()"
|
|
summary: "Get only provide one value for this field."
|
|
syntax: "public String aggregationType()"
|
|
desc: "Get only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count."
|
|
returns:
|
|
description: "the aggregationType value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.category()"
|
|
fullName: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.category()"
|
|
name: "category()"
|
|
nameWithType: "MetricSpecification.category()"
|
|
summary: "Get name of the metric category that the metric belongs to."
|
|
syntax: "public String category()"
|
|
desc: "Get name of the metric category that the metric belongs to. A metric can only belong to a single category."
|
|
returns:
|
|
description: "the category value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.dimensions()"
|
|
fullName: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.dimensions()"
|
|
name: "dimensions()"
|
|
nameWithType: "MetricSpecification.dimensions()"
|
|
summary: "Get dimensions of the metric."
|
|
syntax: "public List<MetricDimension> dimensions()"
|
|
desc: "Get dimensions of the metric."
|
|
returns:
|
|
description: "the dimensions value"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.appplatform.v2020_07_01.MetricDimension?alt=com.microsoft.azure.management.appplatform.v2020_07_01.MetricDimension&text=MetricDimension\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.displayDescription()"
|
|
fullName: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.displayDescription()"
|
|
name: "displayDescription()"
|
|
nameWithType: "MetricSpecification.displayDescription()"
|
|
summary: "Get localized friendly description of the metric."
|
|
syntax: "public String displayDescription()"
|
|
desc: "Get localized friendly description of the metric."
|
|
returns:
|
|
description: "the displayDescription value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.displayName()"
|
|
fullName: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.displayName()"
|
|
name: "displayName()"
|
|
nameWithType: "MetricSpecification.displayName()"
|
|
summary: "Get localized friendly display name of the metric."
|
|
syntax: "public String displayName()"
|
|
desc: "Get localized friendly display name of the metric."
|
|
returns:
|
|
description: "the displayName value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.fillGapWithZero()"
|
|
fullName: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.fillGapWithZero()"
|
|
name: "fillGapWithZero()"
|
|
nameWithType: "MetricSpecification.fillGapWithZero()"
|
|
summary: "Get optional."
|
|
syntax: "public Boolean fillGapWithZero()"
|
|
desc: "Get optional. If set to true, then zero will be returned for time duration where no metric is emitted/published."
|
|
returns:
|
|
description: "the fillGapWithZero value"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.name()"
|
|
fullName: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.name()"
|
|
name: "name()"
|
|
nameWithType: "MetricSpecification.name()"
|
|
summary: "Get name of the metric."
|
|
syntax: "public String name()"
|
|
desc: "Get name of the metric."
|
|
returns:
|
|
description: "the name value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.supportedAggregationTypes()"
|
|
fullName: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.supportedAggregationTypes()"
|
|
name: "supportedAggregationTypes()"
|
|
nameWithType: "MetricSpecification.supportedAggregationTypes()"
|
|
summary: "Get supported aggregation types."
|
|
syntax: "public List<String> supportedAggregationTypes()"
|
|
desc: "Get supported aggregation types."
|
|
returns:
|
|
description: "the supportedAggregationTypes value"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.supportedTimeGrainTypes()"
|
|
fullName: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.supportedTimeGrainTypes()"
|
|
name: "supportedTimeGrainTypes()"
|
|
nameWithType: "MetricSpecification.supportedTimeGrainTypes()"
|
|
summary: "Get supported time grain types."
|
|
syntax: "public List<String> supportedTimeGrainTypes()"
|
|
desc: "Get supported time grain types."
|
|
returns:
|
|
description: "the supportedTimeGrainTypes value"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.unit()"
|
|
fullName: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.unit()"
|
|
name: "unit()"
|
|
nameWithType: "MetricSpecification.unit()"
|
|
summary: "Get unit that makes sense for the metric."
|
|
syntax: "public String unit()"
|
|
desc: "Get unit that makes sense for the metric."
|
|
returns:
|
|
description: "the unit value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.withAggregationType(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.withAggregationType(String aggregationType)"
|
|
name: "withAggregationType(String aggregationType)"
|
|
nameWithType: "MetricSpecification.withAggregationType(String aggregationType)"
|
|
summary: "Set only provide one value for this field."
|
|
parameters:
|
|
- description: "the aggregationType value to set"
|
|
name: "aggregationType"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public MetricSpecification withAggregationType(String aggregationType)"
|
|
desc: "Set only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count."
|
|
returns:
|
|
description: "the MetricSpecification object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification?alt=com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification&text=MetricSpecification\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.withCategory(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.withCategory(String category)"
|
|
name: "withCategory(String category)"
|
|
nameWithType: "MetricSpecification.withCategory(String category)"
|
|
summary: "Set name of the metric category that the metric belongs to."
|
|
parameters:
|
|
- description: "the category value to set"
|
|
name: "category"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public MetricSpecification withCategory(String category)"
|
|
desc: "Set name of the metric category that the metric belongs to. A metric can only belong to a single category."
|
|
returns:
|
|
description: "the MetricSpecification object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification?alt=com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification&text=MetricSpecification\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.withDimensions(java.util.List<com.microsoft.azure.management.appplatform.v2020_07_01.MetricDimension>)"
|
|
fullName: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.withDimensions(List<MetricDimension> dimensions)"
|
|
name: "withDimensions(List<MetricDimension> dimensions)"
|
|
nameWithType: "MetricSpecification.withDimensions(List<MetricDimension> dimensions)"
|
|
summary: "Set dimensions of the metric."
|
|
parameters:
|
|
- description: "the dimensions value to set"
|
|
name: "dimensions"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.appplatform.v2020_07_01.MetricDimension?alt=com.microsoft.azure.management.appplatform.v2020_07_01.MetricDimension&text=MetricDimension\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public MetricSpecification withDimensions(List<MetricDimension> dimensions)"
|
|
desc: "Set dimensions of the metric."
|
|
returns:
|
|
description: "the MetricSpecification object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification?alt=com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification&text=MetricSpecification\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.withDisplayDescription(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.withDisplayDescription(String displayDescription)"
|
|
name: "withDisplayDescription(String displayDescription)"
|
|
nameWithType: "MetricSpecification.withDisplayDescription(String displayDescription)"
|
|
summary: "Set localized friendly description of the metric."
|
|
parameters:
|
|
- description: "the displayDescription value to set"
|
|
name: "displayDescription"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public MetricSpecification withDisplayDescription(String displayDescription)"
|
|
desc: "Set localized friendly description of the metric."
|
|
returns:
|
|
description: "the MetricSpecification object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification?alt=com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification&text=MetricSpecification\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.withDisplayName(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.withDisplayName(String displayName)"
|
|
name: "withDisplayName(String displayName)"
|
|
nameWithType: "MetricSpecification.withDisplayName(String displayName)"
|
|
summary: "Set localized friendly display name of the metric."
|
|
parameters:
|
|
- description: "the displayName value to set"
|
|
name: "displayName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public MetricSpecification withDisplayName(String displayName)"
|
|
desc: "Set localized friendly display name of the metric."
|
|
returns:
|
|
description: "the MetricSpecification object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification?alt=com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification&text=MetricSpecification\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.withFillGapWithZero(java.lang.Boolean)"
|
|
fullName: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.withFillGapWithZero(Boolean fillGapWithZero)"
|
|
name: "withFillGapWithZero(Boolean fillGapWithZero)"
|
|
nameWithType: "MetricSpecification.withFillGapWithZero(Boolean fillGapWithZero)"
|
|
summary: "Set optional."
|
|
parameters:
|
|
- description: "the fillGapWithZero value to set"
|
|
name: "fillGapWithZero"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public MetricSpecification withFillGapWithZero(Boolean fillGapWithZero)"
|
|
desc: "Set optional. If set to true, then zero will be returned for time duration where no metric is emitted/published."
|
|
returns:
|
|
description: "the MetricSpecification object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification?alt=com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification&text=MetricSpecification\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.withName(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.withName(String name)"
|
|
name: "withName(String name)"
|
|
nameWithType: "MetricSpecification.withName(String name)"
|
|
summary: "Set name of the metric."
|
|
parameters:
|
|
- description: "the name value to set"
|
|
name: "name"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public MetricSpecification withName(String name)"
|
|
desc: "Set name of the metric."
|
|
returns:
|
|
description: "the MetricSpecification object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification?alt=com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification&text=MetricSpecification\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.withSupportedAggregationTypes(java.util.List<java.lang.String>)"
|
|
fullName: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.withSupportedAggregationTypes(List<String> supportedAggregationTypes)"
|
|
name: "withSupportedAggregationTypes(List<String> supportedAggregationTypes)"
|
|
nameWithType: "MetricSpecification.withSupportedAggregationTypes(List<String> supportedAggregationTypes)"
|
|
summary: "Set supported aggregation types."
|
|
parameters:
|
|
- description: "the supportedAggregationTypes value to set"
|
|
name: "supportedAggregationTypes"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public MetricSpecification withSupportedAggregationTypes(List<String> supportedAggregationTypes)"
|
|
desc: "Set supported aggregation types."
|
|
returns:
|
|
description: "the MetricSpecification object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification?alt=com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification&text=MetricSpecification\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.withSupportedTimeGrainTypes(java.util.List<java.lang.String>)"
|
|
fullName: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.withSupportedTimeGrainTypes(List<String> supportedTimeGrainTypes)"
|
|
name: "withSupportedTimeGrainTypes(List<String> supportedTimeGrainTypes)"
|
|
nameWithType: "MetricSpecification.withSupportedTimeGrainTypes(List<String> supportedTimeGrainTypes)"
|
|
summary: "Set supported time grain types."
|
|
parameters:
|
|
- description: "the supportedTimeGrainTypes value to set"
|
|
name: "supportedTimeGrainTypes"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public MetricSpecification withSupportedTimeGrainTypes(List<String> supportedTimeGrainTypes)"
|
|
desc: "Set supported time grain types."
|
|
returns:
|
|
description: "the MetricSpecification object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification?alt=com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification&text=MetricSpecification\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.withUnit(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification.withUnit(String unit)"
|
|
name: "withUnit(String unit)"
|
|
nameWithType: "MetricSpecification.withUnit(String unit)"
|
|
summary: "Set unit that makes sense for the metric."
|
|
parameters:
|
|
- description: "the unit value to set"
|
|
name: "unit"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public MetricSpecification withUnit(String unit)"
|
|
desc: "Set unit that makes sense for the metric."
|
|
returns:
|
|
description: "the MetricSpecification object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification?alt=com.microsoft.azure.management.appplatform.v2020_07_01.MetricSpecification&text=MetricSpecification\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Specifications of the Metrics for Azure Monitoring."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.management.appplatform.v2020_07_01"
|
|
artifact: com.microsoft.azure.appplatform.v2020_07_01:azure-mgmt-appplatform:1.0.0-beta
|