366 строки
28 KiB
YAML
366 строки
28 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.monitor.models.MetricTrigger"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricTrigger"
|
|
name: "MetricTrigger"
|
|
nameWithType: "MetricTrigger"
|
|
summary: "The trigger that results in a scaling action."
|
|
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 **MetricTrigger**</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.MetricTrigger?alt=com.azure.resourcemanager.monitor.models.MetricTrigger&text=MetricTrigger\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricTrigger.MetricTrigger()"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricTrigger.MetricTrigger()"
|
|
name: "MetricTrigger()"
|
|
nameWithType: "MetricTrigger.MetricTrigger()"
|
|
summary: "Creates an instance of Metric<wbr>Trigger class."
|
|
syntax: "public MetricTrigger()"
|
|
desc: "Creates an instance of MetricTrigger class."
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricTrigger.dimensions()"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricTrigger.dimensions()"
|
|
name: "dimensions()"
|
|
nameWithType: "MetricTrigger.dimensions()"
|
|
summary: "Get the dimensions property: List of dimension conditions."
|
|
syntax: "public List<ScaleRuleMetricDimension> dimensions()"
|
|
desc: "Get the dimensions property: List of dimension conditions. For example: \\[\\{\"DimensionName\":\"AppName\",\"Operator\":\"Equals\",\"Values\":\\[\"App1\"\\]\\},\\{\"DimensionName\":\"Deployment\",\"Operator\":\"Equals\",\"Values\":\\[\"default\"\\]\\}\\]."
|
|
returns:
|
|
description: "the dimensions value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.monitor.models.ScaleRuleMetricDimension?alt=com.azure.resourcemanager.monitor.models.ScaleRuleMetricDimension&text=ScaleRuleMetricDimension\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricTrigger.dividePerInstance()"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricTrigger.dividePerInstance()"
|
|
name: "dividePerInstance()"
|
|
nameWithType: "MetricTrigger.dividePerInstance()"
|
|
summary: "Get the divide<wbr>Per<wbr>Instance property: a value indicating whether metric should divide per instance."
|
|
syntax: "public Boolean dividePerInstance()"
|
|
desc: "Get the dividePerInstance property: a value indicating whether metric should divide per instance."
|
|
returns:
|
|
description: "the dividePerInstance value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricTrigger.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricTrigger.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "MetricTrigger.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads an instance of Metric<wbr>Trigger 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 MetricTrigger 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 MetricTrigger from the JsonReader."
|
|
returns:
|
|
description: "An instance of MetricTrigger 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.MetricTrigger?alt=com.azure.resourcemanager.monitor.models.MetricTrigger&text=MetricTrigger\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricTrigger.metricName()"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricTrigger.metricName()"
|
|
name: "metricName()"
|
|
nameWithType: "MetricTrigger.metricName()"
|
|
summary: "Get the metric<wbr>Name property: the name of the metric that defines what the rule monitors."
|
|
syntax: "public String metricName()"
|
|
desc: "Get the metricName property: the name of the metric that defines what the rule monitors."
|
|
returns:
|
|
description: "the metricName value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricTrigger.metricNamespace()"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricTrigger.metricNamespace()"
|
|
name: "metricNamespace()"
|
|
nameWithType: "MetricTrigger.metricNamespace()"
|
|
summary: "Get the metric<wbr>Namespace property: the namespace of the metric that defines what the rule monitors."
|
|
syntax: "public String metricNamespace()"
|
|
desc: "Get the metricNamespace property: the namespace of the metric that defines what the rule monitors."
|
|
returns:
|
|
description: "the metricNamespace value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricTrigger.metricResourceLocation()"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricTrigger.metricResourceLocation()"
|
|
name: "metricResourceLocation()"
|
|
nameWithType: "MetricTrigger.metricResourceLocation()"
|
|
summary: "Get the metric<wbr>Resource<wbr>Location property: the location of the resource the rule monitors."
|
|
syntax: "public String metricResourceLocation()"
|
|
desc: "Get the metricResourceLocation property: the location of the resource the rule monitors."
|
|
returns:
|
|
description: "the metricResourceLocation value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricTrigger.metricResourceUri()"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricTrigger.metricResourceUri()"
|
|
name: "metricResourceUri()"
|
|
nameWithType: "MetricTrigger.metricResourceUri()"
|
|
summary: "Get the metric<wbr>Resource<wbr>Uri property: the resource identifier of the resource the rule monitors."
|
|
syntax: "public String metricResourceUri()"
|
|
desc: "Get the metricResourceUri property: the resource identifier of the resource the rule monitors."
|
|
returns:
|
|
description: "the metricResourceUri value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricTrigger.operator()"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricTrigger.operator()"
|
|
name: "operator()"
|
|
nameWithType: "MetricTrigger.operator()"
|
|
summary: "Get the operator property: the operator that is used to compare the metric data and the threshold."
|
|
syntax: "public ComparisonOperationType operator()"
|
|
desc: "Get the operator property: the operator that is used to compare the metric data and the threshold."
|
|
returns:
|
|
description: "the operator value."
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.ComparisonOperationType?alt=com.azure.resourcemanager.monitor.models.ComparisonOperationType&text=ComparisonOperationType\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricTrigger.statistic()"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricTrigger.statistic()"
|
|
name: "statistic()"
|
|
nameWithType: "MetricTrigger.statistic()"
|
|
summary: "Get the statistic property: the metric statistic type."
|
|
syntax: "public MetricStatisticType statistic()"
|
|
desc: "Get the statistic property: the metric statistic type. How the metrics from multiple instances are combined."
|
|
returns:
|
|
description: "the statistic value."
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.MetricStatisticType?alt=com.azure.resourcemanager.monitor.models.MetricStatisticType&text=MetricStatisticType\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricTrigger.threshold()"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricTrigger.threshold()"
|
|
name: "threshold()"
|
|
nameWithType: "MetricTrigger.threshold()"
|
|
summary: "Get the threshold property: the threshold of the metric that triggers the scale action."
|
|
syntax: "public double threshold()"
|
|
desc: "Get the threshold property: the threshold of the metric that triggers the scale action."
|
|
returns:
|
|
description: "the threshold value."
|
|
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricTrigger.timeAggregation()"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricTrigger.timeAggregation()"
|
|
name: "timeAggregation()"
|
|
nameWithType: "MetricTrigger.timeAggregation()"
|
|
summary: "Get the time<wbr>Aggregation property: time aggregation type."
|
|
syntax: "public TimeAggregationType timeAggregation()"
|
|
desc: "Get the timeAggregation property: time aggregation type. How the data that is collected should be combined over time. The default value is Average."
|
|
returns:
|
|
description: "the timeAggregation value."
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.TimeAggregationType?alt=com.azure.resourcemanager.monitor.models.TimeAggregationType&text=TimeAggregationType\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricTrigger.timeGrain()"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricTrigger.timeGrain()"
|
|
name: "timeGrain()"
|
|
nameWithType: "MetricTrigger.timeGrain()"
|
|
summary: "Get the time<wbr>Grain property: the granularity of metrics the rule monitors."
|
|
syntax: "public Duration timeGrain()"
|
|
desc: "Get the timeGrain property: the granularity of metrics the rule monitors. Must be one of the predefined values returned from metric definitions for the metric. Must be between 12 hours and 1 minute."
|
|
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.MetricTrigger.timeWindow()"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricTrigger.timeWindow()"
|
|
name: "timeWindow()"
|
|
nameWithType: "MetricTrigger.timeWindow()"
|
|
summary: "Get the time<wbr>Window property: the range of time in which instance data is collected."
|
|
syntax: "public Duration timeWindow()"
|
|
desc: "Get the timeWindow property: the range of time in which instance data is collected. This value must be greater than the delay in metric collection, which can vary from resource-to-resource. Must be between 12 hours and 5 minutes."
|
|
returns:
|
|
description: "the timeWindow value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricTrigger.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricTrigger.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "MetricTrigger.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.MetricTrigger.validate()"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricTrigger.validate()"
|
|
name: "validate()"
|
|
nameWithType: "MetricTrigger.validate()"
|
|
summary: "Validates the instance."
|
|
syntax: "public void validate()"
|
|
desc: "Validates the instance."
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricTrigger.withDimensions(java.util.List<com.azure.resourcemanager.monitor.models.ScaleRuleMetricDimension>)"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricTrigger.withDimensions(List<ScaleRuleMetricDimension> dimensions)"
|
|
name: "withDimensions(List<ScaleRuleMetricDimension> dimensions)"
|
|
nameWithType: "MetricTrigger.withDimensions(List<ScaleRuleMetricDimension> dimensions)"
|
|
summary: "Set the dimensions property: List of dimension conditions."
|
|
parameters:
|
|
- description: "the dimensions value to set."
|
|
name: "dimensions"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.monitor.models.ScaleRuleMetricDimension?alt=com.azure.resourcemanager.monitor.models.ScaleRuleMetricDimension&text=ScaleRuleMetricDimension\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public MetricTrigger withDimensions(List<ScaleRuleMetricDimension> dimensions)"
|
|
desc: "Set the dimensions property: List of dimension conditions. For example: \\[\\{\"DimensionName\":\"AppName\",\"Operator\":\"Equals\",\"Values\":\\[\"App1\"\\]\\},\\{\"DimensionName\":\"Deployment\",\"Operator\":\"Equals\",\"Values\":\\[\"default\"\\]\\}\\]."
|
|
returns:
|
|
description: "the MetricTrigger object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.MetricTrigger?alt=com.azure.resourcemanager.monitor.models.MetricTrigger&text=MetricTrigger\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricTrigger.withDividePerInstance(java.lang.Boolean)"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricTrigger.withDividePerInstance(Boolean dividePerInstance)"
|
|
name: "withDividePerInstance(Boolean dividePerInstance)"
|
|
nameWithType: "MetricTrigger.withDividePerInstance(Boolean dividePerInstance)"
|
|
summary: "Set the divide<wbr>Per<wbr>Instance property: a value indicating whether metric should divide per instance."
|
|
parameters:
|
|
- description: "the dividePerInstance value to set."
|
|
name: "dividePerInstance"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public MetricTrigger withDividePerInstance(Boolean dividePerInstance)"
|
|
desc: "Set the dividePerInstance property: a value indicating whether metric should divide per instance."
|
|
returns:
|
|
description: "the MetricTrigger object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.MetricTrigger?alt=com.azure.resourcemanager.monitor.models.MetricTrigger&text=MetricTrigger\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricTrigger.withMetricName(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricTrigger.withMetricName(String metricName)"
|
|
name: "withMetricName(String metricName)"
|
|
nameWithType: "MetricTrigger.withMetricName(String metricName)"
|
|
summary: "Set the metric<wbr>Name property: the name of the metric that defines what the rule monitors."
|
|
parameters:
|
|
- description: "the metricName value to set."
|
|
name: "metricName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public MetricTrigger withMetricName(String metricName)"
|
|
desc: "Set the metricName property: the name of the metric that defines what the rule monitors."
|
|
returns:
|
|
description: "the MetricTrigger object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.MetricTrigger?alt=com.azure.resourcemanager.monitor.models.MetricTrigger&text=MetricTrigger\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricTrigger.withMetricNamespace(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricTrigger.withMetricNamespace(String metricNamespace)"
|
|
name: "withMetricNamespace(String metricNamespace)"
|
|
nameWithType: "MetricTrigger.withMetricNamespace(String metricNamespace)"
|
|
summary: "Set the metric<wbr>Namespace property: the namespace of the metric that defines what the rule monitors."
|
|
parameters:
|
|
- description: "the metricNamespace value to set."
|
|
name: "metricNamespace"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public MetricTrigger withMetricNamespace(String metricNamespace)"
|
|
desc: "Set the metricNamespace property: the namespace of the metric that defines what the rule monitors."
|
|
returns:
|
|
description: "the MetricTrigger object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.MetricTrigger?alt=com.azure.resourcemanager.monitor.models.MetricTrigger&text=MetricTrigger\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricTrigger.withMetricResourceLocation(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricTrigger.withMetricResourceLocation(String metricResourceLocation)"
|
|
name: "withMetricResourceLocation(String metricResourceLocation)"
|
|
nameWithType: "MetricTrigger.withMetricResourceLocation(String metricResourceLocation)"
|
|
summary: "Set the metric<wbr>Resource<wbr>Location property: the location of the resource the rule monitors."
|
|
parameters:
|
|
- description: "the metricResourceLocation value to set."
|
|
name: "metricResourceLocation"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public MetricTrigger withMetricResourceLocation(String metricResourceLocation)"
|
|
desc: "Set the metricResourceLocation property: the location of the resource the rule monitors."
|
|
returns:
|
|
description: "the MetricTrigger object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.MetricTrigger?alt=com.azure.resourcemanager.monitor.models.MetricTrigger&text=MetricTrigger\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricTrigger.withMetricResourceUri(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricTrigger.withMetricResourceUri(String metricResourceUri)"
|
|
name: "withMetricResourceUri(String metricResourceUri)"
|
|
nameWithType: "MetricTrigger.withMetricResourceUri(String metricResourceUri)"
|
|
summary: "Set the metric<wbr>Resource<wbr>Uri property: the resource identifier of the resource the rule monitors."
|
|
parameters:
|
|
- description: "the metricResourceUri value to set."
|
|
name: "metricResourceUri"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public MetricTrigger withMetricResourceUri(String metricResourceUri)"
|
|
desc: "Set the metricResourceUri property: the resource identifier of the resource the rule monitors."
|
|
returns:
|
|
description: "the MetricTrigger object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.MetricTrigger?alt=com.azure.resourcemanager.monitor.models.MetricTrigger&text=MetricTrigger\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricTrigger.withOperator(com.azure.resourcemanager.monitor.models.ComparisonOperationType)"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricTrigger.withOperator(ComparisonOperationType operator)"
|
|
name: "withOperator(ComparisonOperationType operator)"
|
|
nameWithType: "MetricTrigger.withOperator(ComparisonOperationType operator)"
|
|
summary: "Set the operator property: the operator that is used to compare the metric data and the threshold."
|
|
parameters:
|
|
- description: "the operator value to set."
|
|
name: "operator"
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.ComparisonOperationType?alt=com.azure.resourcemanager.monitor.models.ComparisonOperationType&text=ComparisonOperationType\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public MetricTrigger withOperator(ComparisonOperationType operator)"
|
|
desc: "Set the operator property: the operator that is used to compare the metric data and the threshold."
|
|
returns:
|
|
description: "the MetricTrigger object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.MetricTrigger?alt=com.azure.resourcemanager.monitor.models.MetricTrigger&text=MetricTrigger\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricTrigger.withStatistic(com.azure.resourcemanager.monitor.models.MetricStatisticType)"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricTrigger.withStatistic(MetricStatisticType statistic)"
|
|
name: "withStatistic(MetricStatisticType statistic)"
|
|
nameWithType: "MetricTrigger.withStatistic(MetricStatisticType statistic)"
|
|
summary: "Set the statistic property: the metric statistic type."
|
|
parameters:
|
|
- description: "the statistic value to set."
|
|
name: "statistic"
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.MetricStatisticType?alt=com.azure.resourcemanager.monitor.models.MetricStatisticType&text=MetricStatisticType\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public MetricTrigger withStatistic(MetricStatisticType statistic)"
|
|
desc: "Set the statistic property: the metric statistic type. How the metrics from multiple instances are combined."
|
|
returns:
|
|
description: "the MetricTrigger object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.MetricTrigger?alt=com.azure.resourcemanager.monitor.models.MetricTrigger&text=MetricTrigger\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricTrigger.withThreshold(double)"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricTrigger.withThreshold(double threshold)"
|
|
name: "withThreshold(double threshold)"
|
|
nameWithType: "MetricTrigger.withThreshold(double threshold)"
|
|
summary: "Set the threshold property: the threshold of the metric that triggers the scale action."
|
|
parameters:
|
|
- description: "the threshold value to set."
|
|
name: "threshold"
|
|
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public MetricTrigger withThreshold(double threshold)"
|
|
desc: "Set the threshold property: the threshold of the metric that triggers the scale action."
|
|
returns:
|
|
description: "the MetricTrigger object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.MetricTrigger?alt=com.azure.resourcemanager.monitor.models.MetricTrigger&text=MetricTrigger\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricTrigger.withTimeAggregation(com.azure.resourcemanager.monitor.models.TimeAggregationType)"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricTrigger.withTimeAggregation(TimeAggregationType timeAggregation)"
|
|
name: "withTimeAggregation(TimeAggregationType timeAggregation)"
|
|
nameWithType: "MetricTrigger.withTimeAggregation(TimeAggregationType timeAggregation)"
|
|
summary: "Set the time<wbr>Aggregation property: time aggregation type."
|
|
parameters:
|
|
- description: "the timeAggregation value to set."
|
|
name: "timeAggregation"
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.TimeAggregationType?alt=com.azure.resourcemanager.monitor.models.TimeAggregationType&text=TimeAggregationType\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public MetricTrigger withTimeAggregation(TimeAggregationType timeAggregation)"
|
|
desc: "Set the timeAggregation property: time aggregation type. How the data that is collected should be combined over time. The default value is Average."
|
|
returns:
|
|
description: "the MetricTrigger object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.MetricTrigger?alt=com.azure.resourcemanager.monitor.models.MetricTrigger&text=MetricTrigger\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricTrigger.withTimeGrain(java.time.Duration)"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricTrigger.withTimeGrain(Duration timeGrain)"
|
|
name: "withTimeGrain(Duration timeGrain)"
|
|
nameWithType: "MetricTrigger.withTimeGrain(Duration timeGrain)"
|
|
summary: "Set the time<wbr>Grain property: the granularity of metrics the rule monitors."
|
|
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 MetricTrigger withTimeGrain(Duration timeGrain)"
|
|
desc: "Set the timeGrain property: the granularity of metrics the rule monitors. Must be one of the predefined values returned from metric definitions for the metric. Must be between 12 hours and 1 minute."
|
|
returns:
|
|
description: "the MetricTrigger object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.MetricTrigger?alt=com.azure.resourcemanager.monitor.models.MetricTrigger&text=MetricTrigger\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.monitor.models.MetricTrigger.withTimeWindow(java.time.Duration)"
|
|
fullName: "com.azure.resourcemanager.monitor.models.MetricTrigger.withTimeWindow(Duration timeWindow)"
|
|
name: "withTimeWindow(Duration timeWindow)"
|
|
nameWithType: "MetricTrigger.withTimeWindow(Duration timeWindow)"
|
|
summary: "Set the time<wbr>Window property: the range of time in which instance data is collected."
|
|
parameters:
|
|
- description: "the timeWindow value to set."
|
|
name: "timeWindow"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
syntax: "public MetricTrigger withTimeWindow(Duration timeWindow)"
|
|
desc: "Set the timeWindow property: the range of time in which instance data is collected. This value must be greater than the delay in metric collection, which can vary from resource-to-resource. Must be between 12 hours and 5 minutes."
|
|
returns:
|
|
description: "the MetricTrigger object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.monitor.models.MetricTrigger?alt=com.azure.resourcemanager.monitor.models.MetricTrigger&text=MetricTrigger\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "The trigger that results in a scaling action."
|
|
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.MetricTrigger?alt=com.azure.resourcemanager.monitor.models.MetricTrigger&text=MetricTrigger\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.monitor.models"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-monitor:2.44.0
|