CheckNameAvailabilityOutput Class

Output of check name availability API.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance
CheckNameAvailabilityOutput

Constructor

CheckNameAvailabilityOutput(**kwargs)

Variables

is_name_available
bool

A value indicating whether the name is available.

reason
str or UnavailableNameReason

The reason why the name is not 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".

message
str

A message that explains why the name is invalid and provides resource naming requirements. Available only if 'Invalid' is returned in the 'reason' property.