com.amazonaws.services.route53domains.model.CheckDomainAvailabilityResult Maven / Gradle / Ivy
/*
* Copyright 2019-2024 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;
import javax.annotation.Generated;
/**
*
* The CheckDomainAvailability response includes the following elements.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CheckDomainAvailabilityResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* 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.
*
*
*
*/
private String availability;
/**
*
* 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.
*
*
*
*
* @param availability
* 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.
*
*
* @see DomainAvailability
*/
public void setAvailability(String availability) {
this.availability = availability;
}
/**
*
* 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.
*
*
*
*
* @return 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.
*
*
* @see DomainAvailability
*/
public String getAvailability() {
return this.availability;
}
/**
*
* 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.
*
*
*
*
* @param availability
* 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.
*
*
* @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 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.
*
*
*
*
* @param availability
* 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.
*
*
* @see DomainAvailability
*/
public void setAvailability(DomainAvailability availability) {
withAvailability(availability);
}
/**
*
* 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.
*
*
*
*
* @param availability
* 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see DomainAvailability
*/
public CheckDomainAvailabilityResult withAvailability(DomainAvailability availability) {
this.availability = availability.toString();
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @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: ").append(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);
}
}
}