Package com.azure.resourcemanager.search.models

Class CheckNameAvailabilityOutput

java.lang.Object

com.azure.resourcemanager.search.models.CheckNameAvailabilityOutput

public final class CheckNameAvailabilityOutput
extends Object

Output of check name availability API.

Constructor Summary

Constructors

Constructor	Description
CheckNameAvailabilityOutput()	Creates an instance of CheckNameAvailabilityOutput class.

Method Summary

Modifier and Type	Method	Description
Boolean	isNameAvailable()	Get the isNameAvailable property: A value indicating whether the name is available.
String	message()	Get the message property: A message that explains why the name is invalid and provides resource naming requirements.
UnavailableNameReason	reason()	Get the reason property: The reason why the name is not available.
void	validate()	Validates the instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CheckNameAvailabilityOutput

public CheckNameAvailabilityOutput()

Creates an instance of CheckNameAvailabilityOutput class.

Method Details

isNameAvailable

public Boolean isNameAvailable()

Get the isNameAvailable property: A value indicating whether the name is available.

Returns:

the isNameAvailable value.

reason

public UnavailableNameReason reason()

Get the reason property: 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.

Returns:

the reason value.

message

public String message()

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

Returns:

the message value.

validate

public void validate()

Validates the instance.

Throws:

IllegalArgumentException - thrown if the instance is not valid.