Class: Azure::ARM::Search::Models::CheckNameAvailabilityOutput

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

Overview

Output of check name availability API.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#is_name_available ⇒ Boolean

Returns A value indicating whether the name is available.

Returns:

  • (Boolean) —

    A value indicating whether the name is available.



16
17
18
 
# File 'lib/generated/azure_mgmt_search/models/check_name_availability_output.rb', line 16

def is_name_available
  @is_name_available
end

#message ⇒ String

provides resource naming requirements. Available only if ‘Invalid’ is returned in the ‘reason’ property.

Returns:

  • (String) —

    A message that explains why the name is invalid and



29
30
31
 
# File 'lib/generated/azure_mgmt_search/models/check_name_availability_output.rb', line 29

def message
  @message
end

#reason ⇒ UnavailableNameReason

available. ‘Invalid’ indicates the name provided does not match the naming requirements (incorrect length, unsupported characters, etc.). ‘AlreadyExists’ indicates that the name is already in use and is therefore unavailable. Possible values include: ‘Invalid’, ‘AlreadyExists’

Returns:



24
25
26
 
# File 'lib/generated/azure_mgmt_search/models/check_name_availability_output.rb', line 24

def reason
  @reason
end

Class Method Details

.mapper ⇒ Object

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



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
65
66
67
68
69
70
71
 
# File 'lib/generated/azure_mgmt_search/models/check_name_availability_output.rb', line 36

def self.mapper()
  {
    required: false,
    serialized_name: 'CheckNameAvailabilityOutput',
    type: {
      name: 'Composite',
      class_name: 'CheckNameAvailabilityOutput',
      model_properties: {
        is_name_available: {
          required: false,
          read_only: true,
          serialized_name: 'nameAvailable',
          type: {
            name: 'Boolean'
          }
        },
        reason: {
          required: false,
          read_only: true,
          serialized_name: 'reason',
          type: {
            name: 'String'
          }
        },
        message: {
          required: false,
          read_only: true,
          serialized_name: 'message',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end