commonMain.aws.sdk.kotlin.services.route53domains.model.CheckDomainAvailabilityResponse.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of route53domains-jvm Show documentation
The AWS SDK for Kotlin client for Route 53 Domains
There is a newer version: 1.3.76
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.route53domains.model

import aws.smithy.kotlin.runtime.SdkDsl

/**
 * The CheckDomainAvailability response includes the following elements.
 */
public class CheckDomainAvailabilityResponse private constructor(builder: Builder) {
    /**
     * Whether the domain name is available for registering.
     *
     * You can register only domains designated as `AVAILABLE`.
     *
     * Valid values:
     *
     * ## AVAILABLE
     * The domain name is available.
     *
     * ## AVAILABLE_RESERVED
     * The domain name is reserved under specific conditions.
     *
     * ## AVAILABLE_PREORDER
     * The domain name is available and can be preordered.
     *
     * ## DONT_KNOW
     * The TLD registry didn't reply with a definitive answer about whether the domain name is available. Route 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. Try again later.
     *
     * ## INVALID_NAME_FOR_TLD
     * The TLD isn't valid. For example, it can contain characters that aren't allowed.
     *
     * ## PENDING
     * The TLD registry didn't return a response in the expected amount of time. When the response is delayed, it usually takes just a few extra seconds. You can resubmit the request immediately.
     *
     * ## RESERVED
     * The domain name has been reserved for another person or organization.
     *
     * ## UNAVAILABLE
     * The domain name is not available.
     *
     * ## UNAVAILABLE_PREMIUM
     * The domain name is not available.
     *
     * ## UNAVAILABLE_RESTRICTED
     * The domain name is forbidden.
     */
    public val availability: aws.sdk.kotlin.services.route53domains.model.DomainAvailability? = builder.availability

    public companion object {
        public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.route53domains.model.CheckDomainAvailabilityResponse = Builder().apply(block).build()
    }

    override fun toString(): kotlin.String = buildString {
        append("CheckDomainAvailabilityResponse(")
        append("availability=$availability")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = availability?.hashCode() ?: 0
        return result
    }

    override fun equals(other: kotlin.Any?): kotlin.Boolean {
        if (this === other) return true
        if (other == null || this::class != other::class) return false

        other as CheckDomainAvailabilityResponse

        if (availability != other.availability) return false

        return true
    }

    public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.route53domains.model.CheckDomainAvailabilityResponse = Builder(this).apply(block).build()

    @SdkDsl
    public class Builder {
        /**
         * Whether the domain name is available for registering.
         *
         * You can register only domains designated as `AVAILABLE`.
         *
         * Valid values:
         *
         * ## AVAILABLE
         * The domain name is available.
         *
         * ## AVAILABLE_RESERVED
         * The domain name is reserved under specific conditions.
         *
         * ## AVAILABLE_PREORDER
         * The domain name is available and can be preordered.
         *
         * ## DONT_KNOW
         * The TLD registry didn't reply with a definitive answer about whether the domain name is available. Route 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. Try again later.
         *
         * ## INVALID_NAME_FOR_TLD
         * The TLD isn't valid. For example, it can contain characters that aren't allowed.
         *
         * ## PENDING
         * The TLD registry didn't return a response in the expected amount of time. When the response is delayed, it usually takes just a few extra seconds. You can resubmit the request immediately.
         *
         * ## RESERVED
         * The domain name has been reserved for another person or organization.
         *
         * ## UNAVAILABLE
         * The domain name is not available.
         *
         * ## UNAVAILABLE_PREMIUM
         * The domain name is not available.
         *
         * ## UNAVAILABLE_RESTRICTED
         * The domain name is forbidden.
         */
        public var availability: aws.sdk.kotlin.services.route53domains.model.DomainAvailability? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.route53domains.model.CheckDomainAvailabilityResponse) : this() {
            this.availability = x.availability
        }

        @PublishedApi
        internal fun build(): aws.sdk.kotlin.services.route53domains.model.CheckDomainAvailabilityResponse = CheckDomainAvailabilityResponse(this)

        internal fun correctErrors(): Builder {
            return this
        }
    }
}