com.amazonaws.services.route53domains.model.CheckDomainAvailabilityResult Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-osgi Show documentation
The AWS SDK for Java with support for OSGi. The AWS SDK for Java provides Java APIs for building software on AWS' cost-effective, scalable, and reliable infrastructure products. The AWS Java SDK allows developers to code against APIs for all of Amazon's infrastructure web services (Amazon S3, Amazon EC2, Amazon SQS, Amazon Relational Database Service, Amazon AutoScaling, etc).
There is a newer version: 1.11.60
Show newest version
/*
 * Copyright 2011-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not
 * use this file except in compliance with the License. A copy of the License is
 * located at
 * 
 * http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */
package com.amazonaws.services.route53domains.model;

import java.io.Serializable;

/**
 * 
 * The CheckDomainAvailability response includes the following elements.
 * 
 */
public class CheckDomainAvailabilityResult implements Serializable, Cloneable {

    /**
     * 
     * Whether the domain name is available for registering.
     * 
     * 
     * 
     * You can only register domains designated as AVAILABLE.
     * 
     * 
     * 
     * Type: String
     * 
     * 
     * 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.
     * UNAVAILABLE – The domain name is not available.
     * UNAVAILABLE_PREMIUM – The domain name is not available.
     * UNAVAILABLE_RESTRICTED – The domain name is forbidden.
     * RESERVED – The domain name has been reserved for another
     * person or organization.
     * DONT_KNOW – The TLD registry didn't reply with a
     * definitive answer about whether the domain name is available. Amazon
     * Route 53 can return this response for a variety of reasons, for example,
     * the registry is performing maintenance. Try again later.
     * 
     */
    private String availability;

    /**
     * 
     * Whether the domain name is available for registering.
     * 
     * 
     * 
     * You can only register domains designated as AVAILABLE.
     * 
     * 
     * 
     * Type: String
     * 
     * 
     * 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.
     * UNAVAILABLE – The domain name is not available.
     * UNAVAILABLE_PREMIUM – The domain name is not available.
     * UNAVAILABLE_RESTRICTED – The domain name is forbidden.
     * RESERVED – The domain name has been reserved for another
     * person or organization.
     * DONT_KNOW – The TLD registry didn't reply with a
     * definitive answer about whether the domain name is available. Amazon
     * Route 53 can return this response for a variety of reasons, for example,
     * the registry is performing maintenance. Try again later.
     * 
     * 
     * @param availability
     *        Whether the domain name is available for registering.
 
     *        
     *        You can only register domains designated as AVAILABLE
     *        .
     *        
     *        
     *        
     *        Type: String
     *        
     *        
     *        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.
     *        UNAVAILABLE – The domain name is not available.
     *        UNAVAILABLE_PREMIUM – The domain name is not
     *        available.
     *        UNAVAILABLE_RESTRICTED – The domain name is
     *        forbidden.
     *        RESERVED – The domain name has been reserved for
     *        another person or organization.
     *        DONT_KNOW – The TLD registry didn't reply with a
     *        definitive answer about whether the domain name is available.
     *        Amazon Route 53 can return this response for a variety of reasons,
     *        for example, the registry is performing maintenance. Try again
     *        later.
     * @see DomainAvailability
     */

    public void setAvailability(String availability) {
        this.availability = availability;
    }

    /**
     * 
     * Whether the domain name is available for registering.
     * 
     * 
     * 
     * You can only register domains designated as AVAILABLE.
     * 
     * 
     * 
     * Type: String
     * 
     * 
     * 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.
     * UNAVAILABLE – The domain name is not available.
     * UNAVAILABLE_PREMIUM – The domain name is not available.
     * UNAVAILABLE_RESTRICTED – The domain name is forbidden.
     * RESERVED – The domain name has been reserved for another
     * person or organization.
     * DONT_KNOW – The TLD registry didn't reply with a
     * definitive answer about whether the domain name is available. Amazon
     * Route 53 can return this response for a variety of reasons, for example,
     * the registry is performing maintenance. Try again later.
     * 
     * 
     * @return Whether the domain name is available for registering.
 
     *         
     *         You can only register domains designated as
     *         AVAILABLE.
     *         
     *         
     *         
     *         Type: String
     *         
     *         
     *         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.
     *         UNAVAILABLE – The domain name is not available.
     *         UNAVAILABLE_PREMIUM – The domain name is not
     *         available.
     *         UNAVAILABLE_RESTRICTED – The domain name is
     *         forbidden.
     *         RESERVED – The domain name has been reserved for
     *         another person or organization.
     *         DONT_KNOW – The TLD registry didn't reply with a
     *         definitive answer about whether the domain name is available.
     *         Amazon Route 53 can return this response for a variety of
     *         reasons, for example, the registry is performing maintenance. Try
     *         again later.
     * @see DomainAvailability
     */

    public String getAvailability() {
        return this.availability;
    }

    /**
     * 
     * Whether the domain name is available for registering.
     * 
     * 
     * 
     * You can only register domains designated as AVAILABLE.
     * 
     * 
     * 
     * Type: String
     * 
     * 
     * 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.
     * UNAVAILABLE – The domain name is not available.
     * UNAVAILABLE_PREMIUM – The domain name is not available.
     * UNAVAILABLE_RESTRICTED – The domain name is forbidden.
     * RESERVED – The domain name has been reserved for another
     * person or organization.
     * DONT_KNOW – The TLD registry didn't reply with a
     * definitive answer about whether the domain name is available. Amazon
     * Route 53 can return this response for a variety of reasons, for example,
     * the registry is performing maintenance. Try again later.
     * 
     * 
     * @param availability
     *        Whether the domain name is available for registering.
 
     *        
     *        You can only register domains designated as AVAILABLE
     *        .
     *        
     *        
     *        
     *        Type: String
     *        
     *        
     *        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.
     *        UNAVAILABLE – The domain name is not available.
     *        UNAVAILABLE_PREMIUM – The domain name is not
     *        available.
     *        UNAVAILABLE_RESTRICTED – The domain name is
     *        forbidden.
     *        RESERVED – The domain name has been reserved for
     *        another person or organization.
     *        DONT_KNOW – The TLD registry didn't reply with a
     *        definitive answer about whether the domain name is available.
     *        Amazon Route 53 can return this response for a variety of reasons,
     *        for example, the registry is performing maintenance. Try again
     *        later.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     * @see DomainAvailability
     */

    public CheckDomainAvailabilityResult withAvailability(String availability) {
        setAvailability(availability);
        return this;
    }

    /**
     * 
     * Whether the domain name is available for registering.
     * 
     * 
     * 
     * You can only register domains designated as AVAILABLE.
     * 
     * 
     * 
     * Type: String
     * 
     * 
     * 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.
     * UNAVAILABLE – The domain name is not available.
     * UNAVAILABLE_PREMIUM – The domain name is not available.
     * UNAVAILABLE_RESTRICTED – The domain name is forbidden.
     * RESERVED – The domain name has been reserved for another
     * person or organization.
     * DONT_KNOW – The TLD registry didn't reply with a
     * definitive answer about whether the domain name is available. Amazon
     * Route 53 can return this response for a variety of reasons, for example,
     * the registry is performing maintenance. Try again later.
     * 
     * 
     * @param availability
     *        Whether the domain name is available for registering.
 
     *        
     *        You can only register domains designated as AVAILABLE
     *        .
     *        
     *        
     *        
     *        Type: String
     *        
     *        
     *        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.
     *        UNAVAILABLE – The domain name is not available.
     *        UNAVAILABLE_PREMIUM – The domain name is not
     *        available.
     *        UNAVAILABLE_RESTRICTED – The domain name is
     *        forbidden.
     *        RESERVED – The domain name has been reserved for
     *        another person or organization.
     *        DONT_KNOW – The TLD registry didn't reply with a
     *        definitive answer about whether the domain name is available.
     *        Amazon Route 53 can return this response for a variety of reasons,
     *        for example, the registry is performing maintenance. Try again
     *        later.
     * @see DomainAvailability
     */

    public void setAvailability(DomainAvailability availability) {
        this.availability = availability.toString();
    }

    /**
     * 
     * Whether the domain name is available for registering.
     * 
     * 
     * 
     * You can only register domains designated as AVAILABLE.
     * 
     * 
     * 
     * Type: String
     * 
     * 
     * 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.
     * UNAVAILABLE – The domain name is not available.
     * UNAVAILABLE_PREMIUM – The domain name is not available.
     * UNAVAILABLE_RESTRICTED – The domain name is forbidden.
     * RESERVED – The domain name has been reserved for another
     * person or organization.
     * DONT_KNOW – The TLD registry didn't reply with a
     * definitive answer about whether the domain name is available. Amazon
     * Route 53 can return this response for a variety of reasons, for example,
     * the registry is performing maintenance. Try again later.
     * 
     * 
     * @param availability
     *        Whether the domain name is available for registering.
 
     *        
     *        You can only register domains designated as AVAILABLE
     *        .
     *        
     *        
     *        
     *        Type: String
     *        
     *        
     *        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.
     *        UNAVAILABLE – The domain name is not available.
     *        UNAVAILABLE_PREMIUM – The domain name is not
     *        available.
     *        UNAVAILABLE_RESTRICTED – The domain name is
     *        forbidden.
     *        RESERVED – The domain name has been reserved for
     *        another person or organization.
     *        DONT_KNOW – The TLD registry didn't reply with a
     *        definitive answer about whether the domain name is available.
     *        Amazon Route 53 can return this response for a variety of reasons,
     *        for example, the registry is performing maintenance. Try again
     *        later.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     * @see DomainAvailability
     */

    public CheckDomainAvailabilityResult withAvailability(
            DomainAvailability availability) {
        setAvailability(availability);
        return this;
    }

    /**
     * Returns a string representation of this object; useful for testing and
     * debugging.
     *
     * @return A string representation of this object.
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getAvailability() != null)
            sb.append("Availability: " + getAvailability());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof CheckDomainAvailabilityResult == false)
            return false;
        CheckDomainAvailabilityResult other = (CheckDomainAvailabilityResult) obj;
        if (other.getAvailability() == null ^ this.getAvailability() == null)
            return false;
        if (other.getAvailability() != null
                && other.getAvailability().equals(this.getAvailability()) == false)
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime
                * hashCode
                + ((getAvailability() == null) ? 0 : getAvailability()
                        .hashCode());
        return hashCode;
    }

    @Override
    public CheckDomainAvailabilityResult clone() {
        try {
            return (CheckDomainAvailabilityResult) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException(
                    "Got a CloneNotSupportedException from Object.clone() "
                            + "even though we're Cloneable!", e);
        }
    }
}