class Azure::Web::Mgmt::V2018_02_01::Models::RecommendationRule

Represents a recommendation rule that the recommendation engine can perform.

Attributes

action_name[RW]

@return [String] Name of action that is recommended by this rule in string.

blade_name[RW]

@return [String] Deep link to a blade on the portal. Applicable to dynamic rule only.

category_tags[RW]

@return [Array<String>] The list of category tags that this recommendation rule belongs to.

channels[RW]

@return [Channels] List of available channels that this rule applies. Possible values include: 'Notification', 'Api', 'Email', 'Webhook', 'All'

description[RW]

@return [String] Localized detailed description of the rule.

display_name[RW]

@return [String] UI friendly name of the rule.

extension_name[RW]

@return [String] Extension name of the portal if exists. Applicable to dynamic rule only.

is_dynamic[RW]

@return [Boolean] True if this is associated with a dynamically added rule

level[RW]

@return [NotificationLevel] Level of impact indicating how critical this rule is. Possible values include: 'Critical', 'Warning', 'Information', 'NonUrgentSuggestion'

message[RW]

@return [String] Localized name of the rule (Good for UI).

recommendation_id[RW]

@return Recommendation ID of an associated recommendation object tied to the rule, if exists. If such an object doesn't exist, it is set to null.

recommendation_name[RW]

@return [String] Unique name of the rule.

Private Class Methods

mapper() click to toggle source

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

# 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