Class: Azure::ARM::IotHub::Models::IotHubNameAvailabilityInfo

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/generated/azure_mgmt_iot_hub/models/iot_hub_name_availability_info.rb

Overview

The properties indicating whether a given iothub name is available.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#message ⇒ String

Returns The message describing the detailed reason.

Returns:

  • (String) —

    The message describing the detailed reason.



24
25
26
 
# File 'lib/generated/azure_mgmt_iot_hub/models/iot_hub_name_availability_info.rb', line 24

def message
  @message
end

#name_available ⇒ Boolean

is available.

Returns:

  • (Boolean) —

    The value which indicates whether the provided name



17
18
19
 
# File 'lib/generated/azure_mgmt_iot_hub/models/iot_hub_name_availability_info.rb', line 17

def name_available
  @name_available
end

#reason ⇒ IotHubNameUnavailabilityReason

unavailability. Possible values include: ‘Invalid’, ‘AlreadyExists’

Returns:



21
22
23
 
# File 'lib/generated/azure_mgmt_iot_hub/models/iot_hub_name_availability_info.rb', line 21

def reason
  @reason
end

Class Method Details

.mapper ⇒ Object

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



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/generated/azure_mgmt_iot_hub/models/iot_hub_name_availability_info.rb', line 31

def self.mapper()
  {
    required: false,
    serialized_name: 'IotHubNameAvailabilityInfo',
    type: {
      name: 'Composite',
      class_name: 'IotHubNameAvailabilityInfo',
      model_properties: {
        name_available: {
          required: false,
          serialized_name: 'nameAvailable',
          type: {
            name: 'Boolean'
          }
        },
        reason: {
          required: false,
          serialized_name: 'reason',
          type: {
            name: 'Enum',
            module: 'IotHubNameUnavailabilityReason'
          }
        },
        message: {
          required: false,
          serialized_name: 'message',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end