Class: Azure::ARM::Web::Models::RecommendationRule

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/generated/azure_mgmt_web/models/recommendation_rule.rb

Overview

Represents a recommendation rule that the recommendation engine can perform

Instance Attribute Summary collapse

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/generated/azure_mgmt_web/models/recommendation_rule.rb', line 35

def action_name
  @action_name
end

#channels ⇒ Channels

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

Returns:

  • (Channels) —

    List of available channels that this rule applies.



48
49
50
 
# File 'lib/generated/azure_mgmt_web/models/recommendation_rule.rb', line 48

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/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/generated/azure_mgmt_web/models/recommendation_rule.rb', line 20

def display_name
  @display_name
end

#enabled ⇒ Integer

or disabled.

Returns:

  • (Integer) —

    On/off flag indicating the rule is currently enabled



39
40
41
 
# File 'lib/generated/azure_mgmt_web/models/recommendation_rule.rb', line 39

def enabled
  @enabled
end

#level ⇒ NotificationLevel

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

Returns:



44
45
46
 
# File 'lib/generated/azure_mgmt_web/models/recommendation_rule.rb', line 44

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/generated/azure_mgmt_web/models/recommendation_rule.rb', line 23

def message
  @message
end

#name ⇒ String

Returns Unique name of the rule.

Returns:

  • (String) —

    Unique name of the rule



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

def name
  @name
end

#recommendation_id ⇒ String

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

Returns:

  • (String) —

    Recommendation ID of an associated recommendation



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

def recommendation_id
  @recommendation_id
end

#tags ⇒ Array<String>

contains.

Returns:

  • (Array<String>) —

    An array of category tags that the rule



52
53
54
 
# File 'lib/generated/azure_mgmt_web/models/recommendation_rule.rb', line 52

def tags
  @tags
end

Class Method Details

.mapper ⇒ Object

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



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

def self.mapper()
  {
    required: false,
    serialized_name: 'RecommendationRule',
    type: {
      name: 'Composite',
      class_name: 'RecommendationRule',
      model_properties: {
        name: {
          required: false,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        display_name: {
          required: false,
          serialized_name: 'displayName',
          type: {
            name: 'String'
          }
        },
        message: {
          required: false,
          serialized_name: 'message',
          type: {
            name: 'String'
          }
        },
        recommendation_id: {
          required: false,
          serialized_name: 'recommendationId',
          type: {
            name: 'String'
          }
        },
        description: {
          required: false,
          serialized_name: 'description',
          type: {
            name: 'String'
          }
        },
        action_name: {
          required: false,
          serialized_name: 'actionName',
          type: {
            name: 'String'
          }
        },
        enabled: {
          required: false,
          serialized_name: 'enabled',
          type: {
            name: 'Number'
          }
        },
        level: {
          required: true,
          serialized_name: 'level',
          type: {
            name: 'Enum',
            module: 'NotificationLevel'
          }
        },
        channels: {
          required: true,
          serialized_name: 'channels',
          type: {
            name: 'Enum',
            module: 'Channels'
          }
        },
        tags: {
          required: false,
          serialized_name: 'tags',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        }
      }
    }
  }
end