class Azure::IotHub::Mgmt::V2018_01_22::Models::FallbackRouteProperties

The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.

Attributes

condition[RW]

@return [String] The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language

endpoint_names[RW]

@return [Array<String>] The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.

is_enabled[RW]

@return [Boolean] Used to specify whether the fallback route is enabled.

name[RW]

@return [String] The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.

source[RW]

@return [String] The source to which the routing rule is to be applied to. For example, DeviceMessages. Default value: 'DeviceMessages' .

Public Class Methods

mapper() click to toggle source

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

# File lib/2018-01-22/generated/azure_mgmt_iot_hub/models/fallback_route_properties.rb, line 45
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'FallbackRouteProperties',
    type: {
      name: 'Composite',
      class_name: 'FallbackRouteProperties',
      model_properties: {
        name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        source: {
          client_side_validation: true,
          required: true,
          is_constant: true,
          serialized_name: 'source',
          default_value: 'DeviceMessages',
          type: {
            name: 'String'
          }
        },
        condition: {
          client_side_validation: true,
          required: false,
          serialized_name: 'condition',
          type: {
            name: 'String'
          }
        },
        endpoint_names: {
          client_side_validation: true,
          required: true,
          serialized_name: 'endpointNames',
          constraints: {
            MaxItems: 1,
            MinItems: 1
          },
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        is_enabled: {
          client_side_validation: true,
          required: true,
          serialized_name: 'isEnabled',
          type: {
            name: 'Boolean'
          }
        }
      }
    }
  }
end