Class: Azure::ARM::SQL::Models::RecommendedIndex

Inherits:
ProxyResource
  • Object
show all
Includes:
MsRest::JSONable, MsRestAzure
Defined in:
lib/generated/azure_mgmt_sql/models/recommended_index.rb

Overview

Represents a database recommended index.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#action ⇒ RecommendedIndexAction

create a missing index, drop an unused index, or rebuild an existing index to improve its performance. Possible values include: ‘Create’, ‘Drop’, ‘Rebuild’

Returns:



20
21
22
 
# File 'lib/generated/azure_mgmt_sql/models/recommended_index.rb', line 20

def action
  @action
end

#columns ⇒ Array<String>

Returns Columns over which to build index.

Returns:

  • (Array<String>) —

    Columns over which to build index



49
50
51
 
# File 'lib/generated/azure_mgmt_sql/models/recommended_index.rb', line 49

def columns
  @columns
end

#created ⇒ DateTime

created (ISO8601 format).

Returns:

  • (DateTime) —

    The UTC datetime showing when this resource was



30
31
32
 
# File 'lib/generated/azure_mgmt_sql/models/recommended_index.rb', line 30

def created
  @created
end

#estimated_impact ⇒ Array<OperationImpact>

recommended index action.

Returns:



60
61
62
 
# File 'lib/generated/azure_mgmt_sql/models/recommended_index.rb', line 60

def estimated_impact
  @estimated_impact
end

#included_columns ⇒ Array<String>

index

Returns:

  • (Array<String>) —

    The list of column names to be included in the



53
54
55
 
# File 'lib/generated/azure_mgmt_sql/models/recommended_index.rb', line 53

def included_columns
  @included_columns
end

#index_script ⇒ String

Returns The full build index script.

Returns:

  • (String) —

    The full build index script



56
57
58
 
# File 'lib/generated/azure_mgmt_sql/models/recommended_index.rb', line 56

def index_script
  @index_script
end

#index_type ⇒ RecommendedIndexType

NONCLUSTERED, COLUMNSTORE, CLUSTERED COLUMNSTORE). Possible values include: ‘CLUSTERED’, ‘NONCLUSTERED’, ‘COLUMNSTORE’, ‘CLUSTERED COLUMNSTORE’

Returns:



40
41
42
 
# File 'lib/generated/azure_mgmt_sql/models/recommended_index.rb', line 40

def index_type
  @index_type
end

#last_modified ⇒ DateTime

changed (ISO8601 format).

Returns:

  • (DateTime) —

    The UTC datetime of when was this resource last



34
35
36
 
# File 'lib/generated/azure_mgmt_sql/models/recommended_index.rb', line 34

def last_modified
  @last_modified
end

#reported_impact ⇒ Array<OperationImpact>

is complete.

Returns:



64
65
66
 
# File 'lib/generated/azure_mgmt_sql/models/recommended_index.rb', line 64

def reported_impact
  @reported_impact
end

#schema ⇒ String

Returns The schema where table to build index over resides.

Returns:

  • (String) —

    The schema where table to build index over resides



43
44
45
 
# File 'lib/generated/azure_mgmt_sql/models/recommended_index.rb', line 43

def schema
  @schema
end

#state ⇒ RecommendedIndexState

Possible values include: ‘Active’, ‘Pending’, ‘Executing’, ‘Verifying’, ‘Pending Revert’, ‘Reverting’, ‘Reverted’, ‘Ignored’, ‘Expired’, ‘Blocked’, ‘Success’

Returns:



26
27
28
 
# File 'lib/generated/azure_mgmt_sql/models/recommended_index.rb', line 26

def state
  @state
end

#table ⇒ String

Returns The table on which to build index.

Returns:

  • (String) —

    The table on which to build index.



46
47
48
 
# File 'lib/generated/azure_mgmt_sql/models/recommended_index.rb', line 46

def table
  @table
end

Class Method Details

.mapper ⇒ Object

Mapper for RecommendedIndex class as Ruby Hash. This will be used for serialization/deserialization.



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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/generated/azure_mgmt_sql/models/recommended_index.rb', line 71

def self.mapper()
  {
    required: false,
    serialized_name: 'RecommendedIndex',
    type: {
      name: 'Composite',
      class_name: 'RecommendedIndex',
      model_properties: {
        id: {
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        action: {
          required: false,
          read_only: true,
          serialized_name: 'properties.action',
          type: {
            name: 'Enum',
            module: 'RecommendedIndexAction'
          }
        },
        state: {
          required: false,
          read_only: true,
          serialized_name: 'properties.state',
          type: {
            name: 'Enum',
            module: 'RecommendedIndexState'
          }
        },
        created: {
          required: false,
          read_only: true,
          serialized_name: 'properties.created',
          type: {
            name: 'DateTime'
          }
        },
        last_modified: {
          required: false,
          read_only: true,
          serialized_name: 'properties.lastModified',
          type: {
            name: 'DateTime'
          }
        },
        index_type: {
          required: false,
          read_only: true,
          serialized_name: 'properties.indexType',
          type: {
            name: 'Enum',
            module: 'RecommendedIndexType'
          }
        },
        schema: {
          required: false,
          read_only: true,
          serialized_name: 'properties.schema',
          type: {
            name: 'String'
          }
        },
        table: {
          required: false,
          read_only: true,
          serialized_name: 'properties.table',
          type: {
            name: 'String'
          }
        },
        columns: {
          required: false,
          read_only: true,
          serialized_name: 'properties.columns',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        included_columns: {
          required: false,
          read_only: true,
          serialized_name: 'properties.includedColumns',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        index_script: {
          required: false,
          read_only: true,
          serialized_name: 'properties.indexScript',
          type: {
            name: 'String'
          }
        },
        estimated_impact: {
          required: false,
          read_only: true,
          serialized_name: 'properties.estimatedImpact',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'OperationImpactElementType',
                type: {
                  name: 'Composite',
                  class_name: 'OperationImpact'
                }
            }
          }
        },
        reported_impact: {
          required: false,
          read_only: true,
          serialized_name: 'properties.reportedImpact',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'OperationImpactElementType',
                type: {
                  name: 'Composite',
                  class_name: 'OperationImpact'
                }
            }
          }
        }
      }
    }
  }
end