Class: Azure::IotHub::Mgmt::V2019_07_01_preview::Models::FallbackRouteProperties

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-07-01-preview/generated/azure_mgmt_iot_hub/models/fallback_route_properties.rb

Overview

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#condition ⇒ String

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

Returns:

  • (String) —

    The condition which is evaluated in order to apply the



29
30
31
 
# File 'lib/2019-07-01-preview/generated/azure_mgmt_iot_hub/models/fallback_route_properties.rb', line 29

def condition
  @condition
end

#endpoint_names ⇒ Array<String>

that satisfy the condition are routed to. Currently only 1 endpoint is allowed.

Returns:

  • (Array<String>) —

    The list of endpoints to which the messages



34
35
36
 
# File 'lib/2019-07-01-preview/generated/azure_mgmt_iot_hub/models/fallback_route_properties.rb', line 34

def endpoint_names
  @endpoint_names
end

#is_enabled ⇒ Boolean

enabled.

Returns:

  • (Boolean) —

    Used to specify whether the fallback route is



38
39
40
 
# File 'lib/2019-07-01-preview/generated/azure_mgmt_iot_hub/models/fallback_route_properties.rb', line 38

def is_enabled
  @is_enabled
end

#name ⇒ String

alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.

Returns:

  • (String) —

    The name of the route. The name can only include



19
20
21
 
# File 'lib/2019-07-01-preview/generated/azure_mgmt_iot_hub/models/fallback_route_properties.rb', line 19

def name
  @name
end

#source ⇒ String

to. For example, DeviceMessages. Default value: ‘DeviceMessages’ .

Returns:

  • (String) —

    The source to which the routing rule is to be applied



23
24
25
 
# File 'lib/2019-07-01-preview/generated/azure_mgmt_iot_hub/models/fallback_route_properties.rb', line 23

def source
  @source
end

Class Method Details

.mapper ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
58
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
 
# File 'lib/2019-07-01-preview/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