Class: Azure::Web::Mgmt::V2018_02_01::Models::RecommendationRule

Inherits:
ProxyOnlyResource show all
Includes:
MsRestAzure
Defined in:
lib/2018-02-01/generated/azure_mgmt_web/models/recommendation_rule.rb

Overview

Represents a recommendation rule that the recommendation engine can perform.

Instance Attribute Summary collapse

Attributes inherited from ProxyOnlyResource

#id, #kind, #name, #type

Class Method Summary collapse

Instance Attribute Details

#action_name ⇒ String

string.

Returns:

  • (String) —

    Name of action that is recommended by this rule in



35
36
37
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation_rule.rb', line 35

def action_name
  @action_name
end

#blade_name ⇒ String

dynamic rule only.

Returns:

  • (String) —

    Deep link to a blade on the portal. Applicable to



61
62
63
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation_rule.rb', line 61

def blade_name
  @blade_name
end

#category_tags ⇒ Array<String>

recommendation rule belongs to.

Returns:

  • (Array<String>) —

    The list of category tags that this



49
50
51
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation_rule.rb', line 49

def category_tags
  @category_tags
end

#channels ⇒ Channels

Possible values include: ‘Notification’, ‘Api’, ‘Email’, ‘Webhook’, ‘All’

Returns:

  • (Channels) —

    List of available channels that this rule applies.



45
46
47
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation_rule.rb', line 45

def channels
  @channels
end

#description ⇒ String

Returns Localized detailed description of the rule.

Returns:

  • (String) —

    Localized detailed description of the rule.



31
32
33
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation_rule.rb', line 31

def description
  @description
end

#display_name ⇒ String

Returns UI friendly name of the rule.

Returns:

  • (String) —

    UI friendly name of the rule.



20
21
22
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation_rule.rb', line 20

def display_name
  @display_name
end

#extension_name ⇒ String

dynamic rule only.

Returns:

  • (String) —

    Extension name of the portal if exists. Applicable to



57
58
59
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation_rule.rb', line 57

def extension_name
  @extension_name
end

#forward_link ⇒ String

the rule. Applicable to dynamic rule only.

Returns:

  • (String) —

    Forward link to an external document associated with



65
66
67
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation_rule.rb', line 65

def forward_link
  @forward_link
end

#is_dynamic ⇒ Boolean

rule

Returns:

  • (Boolean) —

    True if this is associated with a dynamically added



53
54
55
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation_rule.rb', line 53

def is_dynamic
  @is_dynamic
end

#level ⇒ NotificationLevel

this rule is. Possible values include: ‘Critical’, ‘Warning’, ‘Information’, ‘NonUrgentSuggestion’

Returns:



40
41
42
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation_rule.rb', line 40

def level
  @level
end

#message ⇒ String

Returns Localized name of the rule (Good for UI).

Returns:

  • (String) —

    Localized name of the rule (Good for UI).



23
24
25
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation_rule.rb', line 23

def message
  @message
end

#recommendation_id ⇒ Object

to the rule, if exists. If such an object doesn’t exist, it is set to null.

Returns:

  • Recommendation ID of an associated recommendation object tied



28
29
30
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation_rule.rb', line 28

def recommendation_id
  @recommendation_id
end

#recommendation_name ⇒ String

Returns Unique name of the rule.

Returns:

  • (String) —

    Unique name of the rule.



17
18
19
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation_rule.rb', line 17

def recommendation_name
  @recommendation_name
end

Class Method Details

.mapper ⇒ Object

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



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
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/recommendation_rule.rb', line 72

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'RecommendationRule',
    type: {
      name: 'Composite',
      class_name: 'RecommendationRule',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        kind: {
          client_side_validation: true,
          required: false,
          serialized_name: 'kind',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        recommendation_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.recommendationName',
          type: {
            name: 'String'
          }
        },
        display_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.displayName',
          type: {
            name: 'String'
          }
        },
        message: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.message',
          type: {
            name: 'String'
          }
        },
        recommendation_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.recommendationId',
          type: {
            name: 'String'
          }
        },
        description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.description',
          type: {
            name: 'String'
          }
        },
        action_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.actionName',
          type: {
            name: 'String'
          }
        },
        level: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.level',
          type: {
            name: 'Enum',
            module: 'NotificationLevel'
          }
        },
        channels: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.channels',
          type: {
            name: 'Enum',
            module: 'Channels'
          }
        },
        category_tags: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.categoryTags',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        is_dynamic: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.isDynamic',
          type: {
            name: 'Boolean'
          }
        },
        extension_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.extensionName',
          type: {
            name: 'String'
          }
        },
        blade_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.bladeName',
          type: {
            name: 'String'
          }
        },
        forward_link: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.forwardLink',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end