Class: Azure::Kusto::Mgmt::V2019_05_15::Models::IotHubDataConnection

Inherits:
DataConnection show all
Includes:
MsRestAzure
Defined in:
lib/2019-05-15/generated/azure_mgmt_kusto/models/iot_hub_data_connection.rb

Overview

Class representing an iot hub data connection.

Instance Attribute Summary collapse

Attributes inherited from DataConnection

#location

Attributes inherited from Resource

#id, #name, #type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Resource

#resource_group

Constructor Details

#initializeIotHubDataConnection

Returns a new instance of IotHubDataConnection.



16
17
18
# File 'lib/2019-05-15/generated/azure_mgmt_kusto/models/iot_hub_data_connection.rb', line 16

def initialize
  @kind = "IotHub"
end

Instance Attribute Details

#consumer_groupString

Returns The iot hub consumer group.

Returns:

  • (String)

    The iot hub consumer group.



27
28
29
# File 'lib/2019-05-15/generated/azure_mgmt_kusto/models/iot_hub_data_connection.rb', line 27

def consumer_group
  @consumer_group
end

#data_formatDataFormat

data format can be added to each message. Possible values include: ‘MULTIJSON’, ‘JSON’, ‘CSV’, ‘TSV’, ‘SCSV’, ‘SOHSV’, ‘PSV’, ‘TXT’, ‘RAW’, ‘SINGLEJSON’, ‘AVRO’

Returns:

  • (DataFormat)

    The data format of the message. Optionally the



41
42
43
# File 'lib/2019-05-15/generated/azure_mgmt_kusto/models/iot_hub_data_connection.rb', line 41

def data_format
  @data_format
end

#event_system_propertiesArray<String>

Returns System properties of the iot hub.

Returns:

  • (Array<String>)

    System properties of the iot hub



44
45
46
# File 'lib/2019-05-15/generated/azure_mgmt_kusto/models/iot_hub_data_connection.rb', line 44

def event_system_properties
  @event_system_properties
end

#iot_hub_resource_idString

data connection.

Returns:

  • (String)

    The resource ID of the Iot hub to be used to create a



24
25
26
# File 'lib/2019-05-15/generated/azure_mgmt_kusto/models/iot_hub_data_connection.rb', line 24

def iot_hub_resource_id
  @iot_hub_resource_id
end

#kindObject

Returns the value of attribute kind.



20
21
22
# File 'lib/2019-05-15/generated/azure_mgmt_kusto/models/iot_hub_data_connection.rb', line 20

def kind
  @kind
end

#mapping_rule_nameString

Optionally the mapping information can be added to each message.

Returns:

  • (String)

    The mapping rule to be used to ingest the data.



35
36
37
# File 'lib/2019-05-15/generated/azure_mgmt_kusto/models/iot_hub_data_connection.rb', line 35

def mapping_rule_name
  @mapping_rule_name
end

#shared_access_policy_nameString

Returns The name of the share access policy name.

Returns:

  • (String)

    The name of the share access policy name



47
48
49
# File 'lib/2019-05-15/generated/azure_mgmt_kusto/models/iot_hub_data_connection.rb', line 47

def shared_access_policy_name
  @shared_access_policy_name
end

#table_nameString

Optionally the table information can be added to each message.

Returns:

  • (String)

    The table where the data should be ingested.



31
32
33
# File 'lib/2019-05-15/generated/azure_mgmt_kusto/models/iot_hub_data_connection.rb', line 31

def table_name
  @table_name
end

Class Method Details

.mapperObject

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



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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/2019-05-15/generated/azure_mgmt_kusto/models/iot_hub_data_connection.rb', line 54

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'IotHub',
    type: {
      name: 'Composite',
      class_name: 'IotHubDataConnection',
      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'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        location: {
          client_side_validation: true,
          required: false,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        kind: {
          client_side_validation: true,
          required: true,
          serialized_name: 'kind',
          type: {
            name: 'String'
          }
        },
        iot_hub_resource_id: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.iotHubResourceId',
          type: {
            name: 'String'
          }
        },
        consumer_group: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.consumerGroup',
          type: {
            name: 'String'
          }
        },
        table_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.tableName',
          type: {
            name: 'String'
          }
        },
        mapping_rule_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.mappingRuleName',
          type: {
            name: 'String'
          }
        },
        data_format: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.dataFormat',
          type: {
            name: 'String'
          }
        },
        event_system_properties: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.eventSystemProperties',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        shared_access_policy_name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.sharedAccessPolicyName',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end