/
com.azure.ai.metricsadvisor.models.DimensionKey.yml
122 lines (122 loc) · 9.13 KB
/
com.azure.ai.metricsadvisor.models.DimensionKey.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
### YamlMime:JavaType
uid: "com.azure.ai.metricsadvisor.models.DimensionKey"
fullName: "com.azure.ai.metricsadvisor.models.DimensionKey"
name: "DimensionKey"
nameWithType: "DimensionKey"
summary: "Describes a Data Feed Metric dimension name-value pairs."
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 **DimensionKey**"
constructors:
- uid: "com.azure.ai.metricsadvisor.models.DimensionKey.DimensionKey()"
fullName: "com.azure.ai.metricsadvisor.models.DimensionKey.DimensionKey()"
name: "DimensionKey()"
nameWithType: "DimensionKey.DimensionKey()"
summary: "Creates a new instance of Dimension<wbr>Key."
syntax: "public DimensionKey()"
desc: "Creates a new instance of DimensionKey."
- uid: "com.azure.ai.metricsadvisor.models.DimensionKey.DimensionKey(java.util.Map<java.lang.String,java.lang.String>)"
fullName: "com.azure.ai.metricsadvisor.models.DimensionKey.DimensionKey(Map<String,String> dimensionNameValue)"
name: "DimensionKey(Map<String,String> dimensionNameValue)"
nameWithType: "DimensionKey.DimensionKey(Map<String,String> dimensionNameValue)"
summary: "Creates a new instance of Dimension<wbr>Key that is initialized with the provided map of dimension name-value pairs."
parameters:
- description: "The map of dimension name values."
name: "dimensionNameValue"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
syntax: "public DimensionKey(Map<String,String> dimensionNameValue)"
desc: "Creates a new instance of DimensionKey that is initialized with the provided map of dimension name-value pairs."
methods:
- uid: "com.azure.ai.metricsadvisor.models.DimensionKey.asMap()"
fullName: "com.azure.ai.metricsadvisor.models.DimensionKey.asMap()"
name: "asMap()"
nameWithType: "DimensionKey.asMap()"
summary: "Gets the dimension name-value pairs in the key as a map."
syntax: "public Map<String,String> asMap()"
desc: "Gets the dimension name-value pairs in the key as a map."
returns:
description: "The dimension name-value map."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
- uid: "com.azure.ai.metricsadvisor.models.DimensionKey.equals(java.lang.Object)"
fullName: "com.azure.ai.metricsadvisor.models.DimensionKey.equals(Object o)"
name: "equals(Object o)"
nameWithType: "DimensionKey.equals(Object o)"
overridden: "java.lang.Object.equals(java.lang.Object)"
parameters:
- name: "o"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
syntax: "public boolean equals(Object o)"
returns:
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.metricsadvisor.models.DimensionKey.get(java.lang.String)"
fullName: "com.azure.ai.metricsadvisor.models.DimensionKey.get(String dimensionName)"
name: "get(String dimensionName)"
nameWithType: "DimensionKey.get(String dimensionName)"
summary: "Gets dimension value for the given `dimensionName`."
parameters:
- description: "The dimension name."
name: "dimensionName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public String get(String dimensionName)"
desc: "Gets dimension value for the given `dimensionName`."
returns:
description: "The dimension value if exists, <code>null</code> otherwise."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.ai.metricsadvisor.models.DimensionKey.hashCode()"
fullName: "com.azure.ai.metricsadvisor.models.DimensionKey.hashCode()"
name: "hashCode()"
nameWithType: "DimensionKey.hashCode()"
overridden: "java.lang.Object.hashCode()"
syntax: "public int hashCode()"
returns:
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.metricsadvisor.models.DimensionKey.put(java.lang.String,java.lang.String)"
fullName: "com.azure.ai.metricsadvisor.models.DimensionKey.put(String dimensionName, String dimensionValue)"
name: "put(String dimensionName, String dimensionValue)"
nameWithType: "DimensionKey.put(String dimensionName, String dimensionValue)"
summary: "Adds a dimension name-value to the key."
parameters:
- description: "The dimension name."
name: "dimensionName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The dimension value."
name: "dimensionValue"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public DimensionKey put(String dimensionName, String dimensionValue)"
desc: "Adds a dimension name-value to the key."
returns:
description: "The DimensionKey object itself."
type: "<xref href=\"com.azure.ai.metricsadvisor.models.DimensionKey?alt=com.azure.ai.metricsadvisor.models.DimensionKey&text=DimensionKey\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.metricsadvisor.models.DimensionKey.remove(java.lang.String)"
fullName: "com.azure.ai.metricsadvisor.models.DimensionKey.remove(String dimensionName)"
name: "remove(String dimensionName)"
nameWithType: "DimensionKey.remove(String dimensionName)"
summary: "Removes a dimension name-value from the key."
parameters:
- description: "The name of the dimension to remove."
name: "dimensionName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public DimensionKey remove(String dimensionName)"
desc: "Removes a dimension name-value from the key."
returns:
description: "The DimensionKey object itself."
type: "<xref href=\"com.azure.ai.metricsadvisor.models.DimensionKey?alt=com.azure.ai.metricsadvisor.models.DimensionKey&text=DimensionKey\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Describes a Data Feed Metric dimension name-value pairs.\n\nA metric advisor data feed schema <xref uid=\"com.azure.ai.metricsadvisor.administration.models.DataFeedSchema\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DataFeedSchema\"></xref> defines dimension names and metric for a data source, For example, a SQL data source for a wholesale company can have \"product\\_category\" and \"city\" as dimension names and \"revenue\" as a metric.\n\nA combination of value for all dimension names identifies a metric time-series. A <xref uid=\"com.azure.ai.metricsadvisor.models.DimensionKey\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DimensionKey\"></xref> can hold such a combination, for example, \\[ product\\_category=men-shoes, city=redmond \\] identifies one specific time-series.\n\nA <xref uid=\"com.azure.ai.metricsadvisor.models.DimensionKey\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DimensionKey\"></xref> can also have partial dimensions, for example, \\[ city=redmond \\] identifying a group of time-series having value for \"city\" dimension as \"redmond\".\n\nTwo <xref uid=\"com.azure.ai.metricsadvisor.models.DimensionKey\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DimensionKey\"></xref> with same dimension name-value pairs identifies the same time-series or time-series group, this means <xref uid=\"com.azure.ai.metricsadvisor.models.DimensionKey.equals(java.lang.Object)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DimensionKey#equals(Object)\"></xref> return `true`."
metadata: {}
package: "com.azure.ai.metricsadvisor.models"
artifact: com.azure:azure-ai-metricsadvisor:1.1.24