com.azure.resourcemanager.managementgroups.fluent.models.CheckNameAvailabilityResultInner Maven / Gradle / Ivy

Go to download
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.

package com.azure.resourcemanager.managementgroups.fluent.models;

import com.azure.core.annotation.Immutable;
import com.azure.resourcemanager.managementgroups.models.Reason;
import com.fasterxml.jackson.annotation.JsonProperty;

/** Describes the result of the request to check management group name availability. */
@Immutable
public final class CheckNameAvailabilityResultInner {
    /*
     * Required. True indicates name is valid and available. False indicates the name is invalid, unavailable, or both.
     */
    @JsonProperty(value = "nameAvailable", access = JsonProperty.Access.WRITE_ONLY)
    private Boolean nameAvailable;

    /*
     * Required if nameAvailable == false. 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.
     */
    @JsonProperty(value = "reason", access = JsonProperty.Access.WRITE_ONLY)
    private Reason reason;

    /*
     * Required if nameAvailable == false. Localized. 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.
     */
    @JsonProperty(value = "message", access = JsonProperty.Access.WRITE_ONLY)
    private String message;

    /** Creates an instance of CheckNameAvailabilityResultInner class. */
    public CheckNameAvailabilityResultInner() {
    }

    /**
     * Get the nameAvailable property: Required. True indicates name is valid and available. False indicates the name is
     * invalid, unavailable, or both.
     *
     * @return the nameAvailable value.
     */
    public Boolean nameAvailable() {
        return this.nameAvailable;
    }

    /**
     * Get the reason property: Required if nameAvailable == false. 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.
     *
     * @return the reason value.
     */
    public Reason reason() {
        return this.reason;
    }

    /**
     * Get the message property: Required if nameAvailable == false. Localized. 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.
     *
     * @return the message value.
     */
    public String message() {
        return this.message;
    }

    /**
     * Validates the instance.
     *
     * @throws IllegalArgumentException thrown if the instance is not valid.
     */
    public void validate() {
    }
}