Class: Azure::Batch::Mgmt::V2018_12_01::Models::CheckNameAvailabilityResult

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-12-01/generated/azure_mgmt_batch/models/check_name_availability_result.rb

Overview

The CheckNameAvailability operation response.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#message ⇒ String

more detail.

Returns:

  • (String) —

    Gets an error message explaining the Reason value in



28
29
30
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/check_name_availability_result.rb', line 28

def message
  @message
end

#name_available ⇒ Boolean

is available for you to use. If true, the name is available. If false, the name has already been taken or invalid and cannot be used.

Returns:

  • (Boolean) —

    Gets a boolean value that indicates whether the name



18
19
20
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/check_name_availability_result.rb', line 18

def name_available
  @name_available
end

#reason ⇒ NameAvailabilityReason

name could not be used. The Reason element is only returned if NameAvailable is false. Possible values include: ‘Invalid’, ‘AlreadyExists’

Returns:



24
25
26
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/check_name_availability_result.rb', line 24

def reason
  @reason
end

Class Method Details

.mapper ⇒ Object

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



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
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/2018-12-01/generated/azure_mgmt_batch/models/check_name_availability_result.rb', line 35

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