class Azure::IotHub::Mgmt::V2019_07_01_preview::Models::RouteProperties

The properties of a routing rule that your IoT hub uses to route messages to endpoints.

Attributes

condition[RW]

@return [String] The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates 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 messages that satisfy the condition are routed. Currently only one endpoint is allowed.

is_enabled[RW]

@return [Boolean] Used to specify whether a 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 [RoutingSource] The source that the routing rule is to be applied to, such as DeviceMessages. Possible values include: 'Invalid', 'DeviceMessages', 'TwinChangeEvents', 'DeviceLifecycleEvents', 'DeviceJobLifecycleEvents', 'DigitalTwinChangeEvents'

Public Class Methods

mapper() click to toggle source

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

# File lib/2019-07-01-preview/generated/azure_mgmt_iot_hub/models/route_properties.rb, line 46
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'RouteProperties',
    type: {
      name: 'Composite',
      class_name: 'RouteProperties',
      model_properties: {
        name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'name',
          constraints: {
            Pattern: '^[A-Za-z0-9-._]{1,64}$'
          },
          type: {
            name: 'String'
          }
        },
        source: {
          client_side_validation: true,
          required: true,
          serialized_name: 'source',
          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