/
com.microsoft.azure.management.sql.RecommendedIndex.yml
161 lines (161 loc) · 11.2 KB
/
com.microsoft.azure.management.sql.RecommendedIndex.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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
### YamlMime:JavaType
uid: "com.microsoft.azure.management.sql.RecommendedIndex"
fullName: "com.microsoft.azure.management.sql.RecommendedIndex"
name: "RecommendedIndex"
nameWithType: "RecommendedIndex"
summary: "Represents a database recommended index."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.ProxyResource?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.microsoft.azure.ProxyResource?alt=com.microsoft.azure.ProxyResource&text=ProxyResource\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.microsoft.azure.ProxyResource.id()?alt=com.microsoft.azure.ProxyResource.id&text=id\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.ProxyResource.name()?alt=com.microsoft.azure.ProxyResource.name&text=name\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.ProxyResource.type()?alt=com.microsoft.azure.ProxyResource.type&text=type\" data-throw-if-not-resolved=\"False\" />"
- 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 **RecommendedIndex**</br> extends <xref href=\"com.microsoft.azure.ProxyResource?alt=com.microsoft.azure.ProxyResource&text=ProxyResource\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.microsoft.azure.management.sql.RecommendedIndex.RecommendedIndex()"
fullName: "com.microsoft.azure.management.sql.RecommendedIndex.RecommendedIndex()"
name: "RecommendedIndex()"
nameWithType: "RecommendedIndex.RecommendedIndex()"
syntax: "public RecommendedIndex()"
methods:
- uid: "com.microsoft.azure.management.sql.RecommendedIndex.action()"
fullName: "com.microsoft.azure.management.sql.RecommendedIndex.action()"
name: "action()"
nameWithType: "RecommendedIndex.action()"
summary: "Get the proposed index action."
syntax: "public RecommendedIndexAction action()"
desc: "Get the proposed index action. You can create a missing index, drop an unused index, or rebuild an existing index to improve its performance. Possible values include: 'Create', 'Drop', 'Rebuild'."
returns:
description: "the action value"
type: "<xref href=\"com.microsoft.azure.management.sql.RecommendedIndexAction?alt=com.microsoft.azure.management.sql.RecommendedIndexAction&text=RecommendedIndexAction\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.sql.RecommendedIndex.columns()"
fullName: "com.microsoft.azure.management.sql.RecommendedIndex.columns()"
name: "columns()"
nameWithType: "RecommendedIndex.columns()"
summary: "Get columns over which to build index."
syntax: "public List<String> columns()"
desc: "Get columns over which to build index."
returns:
description: "the columns 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.sql.RecommendedIndex.created()"
fullName: "com.microsoft.azure.management.sql.RecommendedIndex.created()"
name: "created()"
nameWithType: "RecommendedIndex.created()"
summary: "Get the UTC datetime showing when this resource was created (ISO8601 format)."
syntax: "public DateTime created()"
desc: "Get the UTC datetime showing when this resource was created (ISO8601 format)."
returns:
description: "the created value"
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.sql.RecommendedIndex.estimatedImpact()"
fullName: "com.microsoft.azure.management.sql.RecommendedIndex.estimatedImpact()"
name: "estimatedImpact()"
nameWithType: "RecommendedIndex.estimatedImpact()"
summary: "Get the estimated impact of doing recommended index action."
syntax: "public List<OperationImpact> estimatedImpact()"
desc: "Get the estimated impact of doing recommended index action."
returns:
description: "the estimatedImpact 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.sql.OperationImpact?alt=com.microsoft.azure.management.sql.OperationImpact&text=OperationImpact\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.management.sql.RecommendedIndex.includedColumns()"
fullName: "com.microsoft.azure.management.sql.RecommendedIndex.includedColumns()"
name: "includedColumns()"
nameWithType: "RecommendedIndex.includedColumns()"
summary: "Get the list of column names to be included in the index."
syntax: "public List<String> includedColumns()"
desc: "Get the list of column names to be included in the index."
returns:
description: "the includedColumns 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.sql.RecommendedIndex.indexScript()"
fullName: "com.microsoft.azure.management.sql.RecommendedIndex.indexScript()"
name: "indexScript()"
nameWithType: "RecommendedIndex.indexScript()"
summary: "Get the full build index script."
syntax: "public String indexScript()"
desc: "Get the full build index script."
returns:
description: "the indexScript value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.sql.RecommendedIndex.indexType()"
fullName: "com.microsoft.azure.management.sql.RecommendedIndex.indexType()"
name: "indexType()"
nameWithType: "RecommendedIndex.indexType()"
summary: "Get the type of index (CLUSTERED, NONCLUSTERED, COLUMNSTORE, CLUSTERED COLUMNSTORE)."
syntax: "public RecommendedIndexType indexType()"
desc: "Get the type of index (CLUSTERED, NONCLUSTERED, COLUMNSTORE, CLUSTERED COLUMNSTORE). Possible values include: 'CLUSTERED', 'NONCLUSTERED', 'COLUMNSTORE', 'CLUSTERED COLUMNSTORE'."
returns:
description: "the indexType value"
type: "<xref href=\"com.microsoft.azure.management.sql.RecommendedIndexType?alt=com.microsoft.azure.management.sql.RecommendedIndexType&text=RecommendedIndexType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.sql.RecommendedIndex.lastModified()"
fullName: "com.microsoft.azure.management.sql.RecommendedIndex.lastModified()"
name: "lastModified()"
nameWithType: "RecommendedIndex.lastModified()"
summary: "Get the UTC datetime of when was this resource last changed (ISO8601 format)."
syntax: "public DateTime lastModified()"
desc: "Get the UTC datetime of when was this resource last changed (ISO8601 format)."
returns:
description: "the lastModified value"
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.sql.RecommendedIndex.reportedImpact()"
fullName: "com.microsoft.azure.management.sql.RecommendedIndex.reportedImpact()"
name: "reportedImpact()"
nameWithType: "RecommendedIndex.reportedImpact()"
summary: "Get the values reported after index action is complete."
syntax: "public List<OperationImpact> reportedImpact()"
desc: "Get the values reported after index action is complete."
returns:
description: "the reportedImpact 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.sql.OperationImpact?alt=com.microsoft.azure.management.sql.OperationImpact&text=OperationImpact\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.management.sql.RecommendedIndex.schema()"
fullName: "com.microsoft.azure.management.sql.RecommendedIndex.schema()"
name: "schema()"
nameWithType: "RecommendedIndex.schema()"
summary: "Get the schema where table to build index over resides."
syntax: "public String schema()"
desc: "Get the schema where table to build index over resides."
returns:
description: "the schema value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.sql.RecommendedIndex.state()"
fullName: "com.microsoft.azure.management.sql.RecommendedIndex.state()"
name: "state()"
nameWithType: "RecommendedIndex.state()"
summary: "Get the current recommendation state."
syntax: "public RecommendedIndexState state()"
desc: "Get the current recommendation state. Possible values include: 'Active', 'Pending', 'Executing', 'Verifying', 'Pending Revert', 'Reverting', 'Reverted', 'Ignored', 'Expired', 'Blocked', 'Success'."
returns:
description: "the state value"
type: "<xref href=\"com.microsoft.azure.management.sql.RecommendedIndexState?alt=com.microsoft.azure.management.sql.RecommendedIndexState&text=RecommendedIndexState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.sql.RecommendedIndex.table()"
fullName: "com.microsoft.azure.management.sql.RecommendedIndex.table()"
name: "table()"
nameWithType: "RecommendedIndex.table()"
summary: "Get the table on which to build index."
syntax: "public String table()"
desc: "Get the table on which to build index."
returns:
description: "the table value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Represents a database recommended index."
metadata: {}
package: "com.microsoft.azure.management.sql"
artifact: com.microsoft.azure:azure-mgmt-sql:1.41.4