174 строки
12 KiB
YAML
174 строки
12 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.monitor.models.MetricSettings"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricSettings"
|
|
name: "MetricSettings"
|
|
nameWithType: "MetricSettings"
|
|
summary: "Part of Multi<wbr>Tenant<wbr>Diagnostic<wbr>Settings."
|
|
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 **MetricSettings**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.monitor.models.MetricSettings?alt=com.azure.resourcemanager.monitor.models.MetricSettings&text=MetricSettings\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricSettings.MetricSettings()"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricSettings.MetricSettings()"
|
|
name: "MetricSettings()"
|
|
nameWithType: "MetricSettings.MetricSettings()"
|
|
summary: "Creates an instance of Metric<wbr>Settings class."
|
|
syntax: "public MetricSettings()"
|
|
desc: "Creates an instance of MetricSettings class."
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricSettings.category()"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricSettings.category()"
|
|
name: "category()"
|
|
nameWithType: "MetricSettings.category()"
|
|
summary: "Get the category property: Name of a Diagnostic Metric category for a resource type this setting is applied to."
|
|
syntax: "public String category()"
|
|
desc: "Get the category property: Name of a Diagnostic Metric category for a resource type this setting is applied to. To obtain the list of Diagnostic metric categories for a resource, first perform a GET diagnostic settings operation."
|
|
returns:
|
|
description: "the category value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricSettings.enabled()"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricSettings.enabled()"
|
|
name: "enabled()"
|
|
nameWithType: "MetricSettings.enabled()"
|
|
summary: "Get the enabled property: a value indicating whether this category is enabled."
|
|
syntax: "public boolean enabled()"
|
|
desc: "Get the enabled property: a value indicating whether this category is enabled."
|
|
returns:
|
|
description: "the enabled value."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricSettings.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricSettings.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "MetricSettings.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads an instance of Metric<wbr>Settings from the Json<wbr>Reader."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "The JsonReader being read."
|
|
name: "jsonReader"
|
|
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static MetricSettings fromJson(JsonReader jsonReader)"
|
|
exceptions:
|
|
- description: "If the deserialized JSON object was missing any required properties."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reads an instance of MetricSettings from the JsonReader."
|
|
returns:
|
|
description: "An instance of MetricSettings if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.MetricSettings?alt=com.azure.resourcemanager.monitor.models.MetricSettings&text=MetricSettings\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricSettings.retentionPolicy()"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricSettings.retentionPolicy()"
|
|
name: "retentionPolicy()"
|
|
nameWithType: "MetricSettings.retentionPolicy()"
|
|
summary: "Get the retention<wbr>Policy property: the retention policy for this category."
|
|
syntax: "public RetentionPolicy retentionPolicy()"
|
|
desc: "Get the retentionPolicy property: the retention policy for this category."
|
|
returns:
|
|
description: "the retentionPolicy value."
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.RetentionPolicy?alt=com.azure.resourcemanager.monitor.models.RetentionPolicy&text=RetentionPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricSettings.timeGrain()"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricSettings.timeGrain()"
|
|
name: "timeGrain()"
|
|
nameWithType: "MetricSettings.timeGrain()"
|
|
summary: "Get the time<wbr>Grain property: the timegrain of the metric in ISO8601 format."
|
|
syntax: "public Duration timeGrain()"
|
|
desc: "Get the timeGrain property: the timegrain of the metric in ISO8601 format."
|
|
returns:
|
|
description: "the timeGrain value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricSettings.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricSettings.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "MetricSettings.toJson(JsonWriter jsonWriter)"
|
|
parameters:
|
|
- name: "jsonWriter"
|
|
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
|
exceptions:
|
|
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
returns:
|
|
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricSettings.validate()"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricSettings.validate()"
|
|
name: "validate()"
|
|
nameWithType: "MetricSettings.validate()"
|
|
summary: "Validates the instance."
|
|
syntax: "public void validate()"
|
|
desc: "Validates the instance."
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricSettings.withCategory(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricSettings.withCategory(String category)"
|
|
name: "withCategory(String category)"
|
|
nameWithType: "MetricSettings.withCategory(String category)"
|
|
summary: "Set the category property: Name of a Diagnostic Metric category for a resource type this setting is applied to."
|
|
parameters:
|
|
- description: "the category value to set."
|
|
name: "category"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public MetricSettings withCategory(String category)"
|
|
desc: "Set the category property: Name of a Diagnostic Metric category for a resource type this setting is applied to. To obtain the list of Diagnostic metric categories for a resource, first perform a GET diagnostic settings operation."
|
|
returns:
|
|
description: "the MetricSettings object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.MetricSettings?alt=com.azure.resourcemanager.monitor.models.MetricSettings&text=MetricSettings\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricSettings.withEnabled(boolean)"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricSettings.withEnabled(boolean enabled)"
|
|
name: "withEnabled(boolean enabled)"
|
|
nameWithType: "MetricSettings.withEnabled(boolean enabled)"
|
|
summary: "Set the enabled property: a value indicating whether this category is enabled."
|
|
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 MetricSettings withEnabled(boolean enabled)"
|
|
desc: "Set the enabled property: a value indicating whether this category is enabled."
|
|
returns:
|
|
description: "the MetricSettings object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.MetricSettings?alt=com.azure.resourcemanager.monitor.models.MetricSettings&text=MetricSettings\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricSettings.withRetentionPolicy(com.azure.resourcemanager.monitor.models.RetentionPolicy)"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricSettings.withRetentionPolicy(RetentionPolicy retentionPolicy)"
|
|
name: "withRetentionPolicy(RetentionPolicy retentionPolicy)"
|
|
nameWithType: "MetricSettings.withRetentionPolicy(RetentionPolicy retentionPolicy)"
|
|
summary: "Set the retention<wbr>Policy property: the retention policy for this category."
|
|
parameters:
|
|
- description: "the retentionPolicy value to set."
|
|
name: "retentionPolicy"
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.RetentionPolicy?alt=com.azure.resourcemanager.monitor.models.RetentionPolicy&text=RetentionPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public MetricSettings withRetentionPolicy(RetentionPolicy retentionPolicy)"
|
|
desc: "Set the retentionPolicy property: the retention policy for this category."
|
|
returns:
|
|
description: "the MetricSettings object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.MetricSettings?alt=com.azure.resourcemanager.monitor.models.MetricSettings&text=MetricSettings\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricSettings.withTimeGrain(java.time.Duration)"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricSettings.withTimeGrain(Duration timeGrain)"
|
|
name: "withTimeGrain(Duration timeGrain)"
|
|
nameWithType: "MetricSettings.withTimeGrain(Duration timeGrain)"
|
|
summary: "Set the time<wbr>Grain property: the timegrain of the metric in ISO8601 format."
|
|
parameters:
|
|
- description: "the timeGrain value to set."
|
|
name: "timeGrain"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
syntax: "public MetricSettings withTimeGrain(Duration timeGrain)"
|
|
desc: "Set the timeGrain property: the timegrain of the metric in ISO8601 format."
|
|
returns:
|
|
description: "the MetricSettings object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.MetricSettings?alt=com.azure.resourcemanager.monitor.models.MetricSettings&text=MetricSettings\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Part of MultiTenantDiagnosticSettings. Specifies the settings for a particular metric."
|
|
implements:
|
|
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.monitor.models.MetricSettings?alt=com.azure.resourcemanager.monitor.models.MetricSettings&text=MetricSettings\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.monitor.models"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-monitor:2.42.0
|