class Azure::StorageSync::Mgmt::V2019_02_01::Models::CheckNameAvailabilityResult

The CheckNameAvailability operation response.

Attributes

message[RW]

@return [String] Gets an error message explaining the Reason value in more detail.

name_available[RW]

@return [Boolean] Gets a boolean value that indicates whether the name 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.

reason[RW]

@return [NameAvailabilityReason] Gets the reason that a Storage Sync Service name could not be used. The Reason element is only returned if NameAvailable is false. Possible values include: 'Invalid', 'AlreadyExists'

Public Class Methods

mapper() click to toggle source

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

# File lib/2019-02-01/generated/azure_mgmt_storagesync/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