ApiManagementServiceNameAvailabilityResultInner Class

  • Reference
Package:
com.azure.resourcemanager.apimanagement.fluent.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-apimanagement:1.0.0-beta.4
  • java.lang.Object
    • com.azure.resourcemanager.apimanagement.fluent.models.ApiManagementServiceNameAvailabilityResultInner

public final class 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
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\u2019s 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\u2019s 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

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 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\u2019s naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable.

Returns:

the reason value.

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\u2019s 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.

Applies to