Class: Azure::IotHub::Mgmt::V2019_07_01_preview::Models::RouteProperties

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

Overview

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#condition ⇒ String

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

Returns:

  • (String) —

    The condition that is evaluated to apply the routing



31
32
33
 
# File 'lib/2019-07-01-preview/generated/azure_mgmt_iot_hub/models/route_properties.rb', line 31

def condition
  @condition
end

#endpoint_names ⇒ Array<String>

satisfy the condition are routed. Currently only one endpoint is allowed.

Returns:

  • (Array<String>) —

    The list of endpoints to which messages that



36
37
38
 
# File 'lib/2019-07-01-preview/generated/azure_mgmt_iot_hub/models/route_properties.rb', line 36

def endpoint_names
  @endpoint_names
end

#is_enabled ⇒ Boolean

Returns Used to specify whether a route is enabled.

Returns:

  • (Boolean) —

    Used to specify whether a route is enabled.



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

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/route_properties.rb', line 19

def name
  @name
end

#source ⇒ RoutingSource

applied to, such as DeviceMessages. Possible values include: ‘Invalid’, ‘DeviceMessages’, ‘TwinChangeEvents’, ‘DeviceLifecycleEvents’, ‘DeviceJobLifecycleEvents’, ‘DigitalTwinChangeEvents’

Returns:



25
26
27
 
# File 'lib/2019-07-01-preview/generated/azure_mgmt_iot_hub/models/route_properties.rb', line 25

def source
  @source
end

Class Method Details

.mapper ⇒ Object

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



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
112
113
 
# 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