Class ApiManagementServiceNameAvailabilityResultInner
- java.lang.Object
-
- com.azure.resourcemanager.apimanagement.fluent.models.ApiManagementServiceNameAvailabilityResultInner
-
public final class ApiManagementServiceNameAvailabilityResultInner extends Object
Response of the CheckNameAvailability operation.
-
-
Constructor Summary
Constructors Constructor Description ApiManagementServiceNameAvailabilityResultInner()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
message()
Get the message property: If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name.Boolean
nameAvailable()
Get the nameAvailable property: True if the name is available and can be used to create a new API Management service; otherwise false.NameAvailabilityReason
reason()
Get the reason property: Invalid indicates the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable.void
validate()
Validates the instance.ApiManagementServiceNameAvailabilityResultInner
withReason(NameAvailabilityReason reason)
Set the reason property: Invalid indicates the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable.
-
-
-
Method Detail
-
nameAvailable
public Boolean nameAvailable()
Get the nameAvailable property: True if the name is available and can be used to create a new API Management service; otherwise false.- Returns:
- the nameAvailable value.
-
message
public String message()
Get the message property: If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that <resourceName> is already in use, and direct them to select a different name.- Returns:
- the message value.
-
reason
public NameAvailabilityReason reason()
Get the reason property: Invalid indicates the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable.- Returns:
- the reason value.
-
withReason
public ApiManagementServiceNameAvailabilityResultInner withReason(NameAvailabilityReason reason)
Set the reason property: Invalid indicates the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable.- Parameters:
reason
- the reason value to set.- Returns:
- the ApiManagementServiceNameAvailabilityResultInner object itself.
-
validate
public void validate()
Validates the instance.- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-
-