Class: Azure::IotHub::Mgmt::V2017_07_01::Models::EventHubProperties

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

Overview

The properties of the provisioned Event Hub-compatible endpoint used by the IoT hub.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#endpoint ⇒ String

Returns The Event Hub-compatible endpoint.

Returns:

  • (String) —

    The Event Hub-compatible endpoint.



34
35
36
 
# File 'lib/2017-07-01/generated/azure_mgmt_iot_hub/models/event_hub_properties.rb', line 34

def endpoint
  @endpoint
end

#partition_count ⇒ Integer

device-to-cloud messages in the Event Hub-compatible endpoint. See: docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.

Returns:

  • (Integer) —

    The number of partitions for receiving



24
25
26
 
# File 'lib/2017-07-01/generated/azure_mgmt_iot_hub/models/event_hub_properties.rb', line 24

def partition_count
  @partition_count
end

#partition_ids ⇒ Array<String>

endpoint.

Returns:

  • (Array<String>) —

    The partition ids in the Event Hub-compatible



28
29
30
 
# File 'lib/2017-07-01/generated/azure_mgmt_iot_hub/models/event_hub_properties.rb', line 28

def partition_ids
  @partition_ids
end

#path ⇒ String

Returns The Event Hub-compatible name.

Returns:

  • (String) —

    The Event Hub-compatible name.



31
32
33
 
# File 'lib/2017-07-01/generated/azure_mgmt_iot_hub/models/event_hub_properties.rb', line 31

def path
  @path
end

#retention_time_in_days ⇒ Integer

days. See: docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages

Returns:

  • (Integer) —

    The retention time for device-to-cloud messages in



19
20
21
 
# File 'lib/2017-07-01/generated/azure_mgmt_iot_hub/models/event_hub_properties.rb', line 19

def retention_time_in_days
  @retention_time_in_days
end

Class Method Details

.mapper ⇒ Object

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



41
42
43
44
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
 
# File 'lib/2017-07-01/generated/azure_mgmt_iot_hub/models/event_hub_properties.rb', line 41

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'EventHubProperties',
    type: {
      name: 'Composite',
      class_name: 'EventHubProperties',
      model_properties: {
        retention_time_in_days: {
          client_side_validation: true,
          required: false,
          serialized_name: 'retentionTimeInDays',
          type: {
            name: 'Number'
          }
        },
        partition_count: {
          client_side_validation: true,
          required: false,
          serialized_name: 'partitionCount',
          type: {
            name: 'Number'
          }
        },
        partition_ids: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'partitionIds',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        path: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'path',
          type: {
            name: 'String'
          }
        },
        endpoint: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'endpoint',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end