Class: Azure::ARM::SQL::Models::CheckNameAvailabilityResponse

Inherits:
Object
  • Object
show all
Includes:
MsRest::JSONable, MsRestAzure
Defined in:
lib/generated/azure_mgmt_sql/models/check_name_availability_response.rb

Overview

A response indicating whether the specified name for a resource is available.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#availableBoolean

Returns True if the name is available, otherwise false.

Returns:

  • (Boolean)

    True if the name is available, otherwise false.



18
19
20
# File 'lib/generated/azure_mgmt_sql/models/check_name_availability_response.rb', line 18

def available
  @available
end

#messageString

be null if the name is available.

Returns:

  • (String)

    A message explaining why the name is unavailable. Will



22
23
24
# File 'lib/generated/azure_mgmt_sql/models/check_name_availability_response.rb', line 22

def message
  @message
end

#nameString

Returns The name whose availability was checked.

Returns:

  • (String)

    The name whose availability was checked.



25
26
27
# File 'lib/generated/azure_mgmt_sql/models/check_name_availability_response.rb', line 25

def name
  @name
end

#reasonCheckNameAvailabilityReason

the name is unavailable. Will be null if the name is available. Possible values include: ‘Invalid’, ‘AlreadyExists’

Returns:



30
31
32
# File 'lib/generated/azure_mgmt_sql/models/check_name_availability_response.rb', line 30

def reason
  @reason
end

Class Method Details

.mapperObject

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



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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# File 'lib/generated/azure_mgmt_sql/models/check_name_availability_response.rb', line 37

def self.mapper()
  {
    required: false,
    serialized_name: 'CheckNameAvailabilityResponse',
    type: {
      name: 'Composite',
      class_name: 'CheckNameAvailabilityResponse',
      model_properties: {
        available: {
          required: false,
          read_only: true,
          serialized_name: 'available',
          type: {
            name: 'Boolean'
          }
        },
        message: {
          required: false,
          read_only: true,
          serialized_name: 'message',
          type: {
            name: 'String'
          }
        },
        name: {
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        reason: {
          required: false,
          read_only: true,
          serialized_name: 'reason',
          type: {
            name: 'Enum',
            module: 'CheckNameAvailabilityReason'
          }
        }
      }
    }
  }
end