com.azure.resourcemanager.storage.models.CheckNameAvailabilityResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of azure-resourcemanager-storage Show documentation

This package contains Microsoft Azure Storage Management SDK.

There is a newer version: 2.44.0

Show newest version

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.azure.resourcemanager.storage.models;

import com.azure.resourcemanager.storage.fluent.models.CheckNameAvailabilityResultInner;

/** The {@link StorageAccounts#checkNameAvailability} action result. */
public class CheckNameAvailabilityResult {
    private final CheckNameAvailabilityResultInner inner;

    /**
     * Creates an instance of the check name availability result object.
     *
     * @param inner the inner object
     */
    public CheckNameAvailabilityResult(CheckNameAvailabilityResultInner inner) {
        this.inner = inner;
    }

    /**
     * @return a boolean value that indicates whether the name is available for you to use. If true, the name is
     *     available. If false, the name has already been taken or invalid and cannot be used.
     */
    public boolean isAvailable() {
        return inner.nameAvailable();
    }

    /**
     * @return the reason that a storage account name could not be used. The Reason element is only returned if
     *     NameAvailable is false. Possible values include: 'AccountNameInvalid', 'AlreadyExists'.
     */
    public Reason reason() {
        return inner.reason();
    }

    /** @return an error message explaining the Reason value in more detail */
    public String message() {
        return inner.message();
    }
}