ApiManagementServiceNameAvailabilityResultInner Class

Package:

com.azure.resourcemanager.apimanagement.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-apimanagement:2.0.0

• java.lang.Object
• • com.azure.resourcemanager.apimanagement.fluent.models.ApiManagementServiceNameAvailabilityResultInner

Implements

JsonSerializable<ApiManagementServiceNameAvailabilityResultInner>

public final class ApiManagementServiceNameAvailabilityResultInner
implements JsonSerializable<ApiManagementServiceNameAvailabilityResultInner>

Response of the CheckNameAvailability operation.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
static ApiManagementServiceNameAvailabilityResultInner	fromJson(JsonReader jsonReader) Reads an instance of ApiManagementServiceNameAvailabilityResultInner from the JsonReader.
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.
JsonWriter	toJson(JsonWriter jsonWriter)
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.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ApiManagementServiceNameAvailabilityResultInner

public ApiManagementServiceNameAvailabilityResultInner()

Creates an instance of ApiManagementServiceNameAvailabilityResultInner class.

Method Details

fromJson

public static ApiManagementServiceNameAvailabilityResultInner fromJson(JsonReader jsonReader)

Reads an instance of ApiManagementServiceNameAvailabilityResultInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ApiManagementServiceNameAvailabilityResultInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the ApiManagementServiceNameAvailabilityResultInner.

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.

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.

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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

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.