/* * Copyright 2018-2023 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; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class GetDomainSuggestionsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* A domain name that you want to use as the basis for a list of possible domain names. The top-level domain (TLD), * such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see Domains that You Can * Register with Amazon Route 53 in the Amazon Route 53 Developer Guide. *

* The domain name can contain only the following characters: *

*
* Letters a through z. Domain names are not case sensitive. *
*
*
* Numbers 0 through 9. *
*
*
* Hyphen (-). You can't specify a hyphen at the beginning or end of a label. *
*
*
* Period (.) to separate the labels in the name, such as the . in example.com. *
*

* Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that * you want to use supports internationalized domain names, see Domains that You Can * Register with Amazon Route 53. *

*/ private String domainName; /** *

* The number of suggested domain names that you want Route 53 to return. Specify a value between 1 and 50. *

*/ private Integer suggestionCount; /** *

* If OnlyAvailable is true, Route 53 returns only domain names that are available. If * OnlyAvailable is false, Route 53 returns domain names without checking whether they're * available to be registered. To determine whether the domain is available, you can call * checkDomainAvailability for each suggestion. *

*/ private Boolean onlyAvailable; /** *

* The domain name can contain only the following characters: *

*
* Letters a through z. Domain names are not case sensitive. *
*
*
* Numbers 0 through 9. *
*
*
* Hyphen (-). You can't specify a hyphen at the beginning or end of a label. *
*
*
* Period (.) to separate the labels in the name, such as the . in example.com. *
*

* * @param domainName * A domain name that you want to use as the basis for a list of possible domain names. The top-level domain * (TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see Domains that You * Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.

* The domain name can contain only the following characters: *

*
* Letters a through z. Domain names are not case sensitive. *
*
*
* Numbers 0 through 9. *
*
*
* Hyphen (-). You can't specify a hyphen at the beginning or end of a label. *
*
*
* Period (.) to separate the labels in the name, such as the . in example.com. *
*

* Internationalized domain names are not supported for some top-level domains. To determine whether the TLD * that you want to use supports internationalized domain names, see Domains that You * Can Register with Amazon Route 53. */ public void setDomainName(String domainName) { this.domainName = domainName; } /** *

* The domain name can contain only the following characters: *

*
* Letters a through z. Domain names are not case sensitive. *
*
*
* Numbers 0 through 9. *
*
*
* Hyphen (-). You can't specify a hyphen at the beginning or end of a label. *
*
*
* Period (.) to separate the labels in the name, such as the . in example.com. *
*

* * @return A domain name that you want to use as the basis for a list of possible domain names. The top-level domain * (TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see Domains that You * Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.

* The domain name can contain only the following characters: *

*
* Letters a through z. Domain names are not case sensitive. *
*
*
* Numbers 0 through 9. *
*
*
* Hyphen (-). You can't specify a hyphen at the beginning or end of a label. *
*
*
* Period (.) to separate the labels in the name, such as the . in example.com. *
*

* The domain name can contain only the following characters: *

*
* Letters a through z. Domain names are not case sensitive. *
*
*
* Numbers 0 through 9. *
*
*
* Hyphen (-). You can't specify a hyphen at the beginning or end of a label. *
*
*
* Period (.) to separate the labels in the name, such as the . in example.com. *
*

* The domain name can contain only the following characters: *

*
* Letters a through z. Domain names are not case sensitive. *
*
*
* Numbers 0 through 9. *
*
*
* Hyphen (-). You can't specify a hyphen at the beginning or end of a label. *
*
*
* Period (.) to separate the labels in the name, such as the . in example.com. *
*

* Internationalized domain names are not supported for some top-level domains. To determine whether the TLD * that you want to use supports internationalized domain names, see Domains that You * Can Register with Amazon Route 53. * @return Returns a reference to this object so that method calls can be chained together. */ public GetDomainSuggestionsRequest withDomainName(String domainName) { setDomainName(domainName); return this; } /** *

* The number of suggested domain names that you want Route 53 to return. Specify a value between 1 and 50. *

* * @param suggestionCount * The number of suggested domain names that you want Route 53 to return. Specify a value between 1 and 50. */ public void setSuggestionCount(Integer suggestionCount) { this.suggestionCount = suggestionCount; } /** *

* The number of suggested domain names that you want Route 53 to return. Specify a value between 1 and 50. *

* * @return The number of suggested domain names that you want Route 53 to return. Specify a value between 1 and 50. */ public Integer getSuggestionCount() { return this.suggestionCount; } /** *

* The number of suggested domain names that you want Route 53 to return. Specify a value between 1 and 50. *

* * @param suggestionCount * The number of suggested domain names that you want Route 53 to return. Specify a value between 1 and 50. * @return Returns a reference to this object so that method calls can be chained together. */ public GetDomainSuggestionsRequest withSuggestionCount(Integer suggestionCount) { setSuggestionCount(suggestionCount); return this; } /** *

* * @param onlyAvailable * If OnlyAvailable is true, Route 53 returns only domain names that are available. * If OnlyAvailable is false, Route 53 returns domain names without checking * whether they're available to be registered. To determine whether the domain is available, you can call * checkDomainAvailability for each suggestion. */ public void setOnlyAvailable(Boolean onlyAvailable) { this.onlyAvailable = onlyAvailable; } /** *

* * @param onlyAvailable * If OnlyAvailable is true, Route 53 returns only domain names that are available. * If OnlyAvailable is false, Route 53 returns domain names without checking * whether they're available to be registered. To determine whether the domain is available, you can call * checkDomainAvailability for each suggestion. * @return Returns a reference to this object so that method calls can be chained together. */ public GetDomainSuggestionsRequest withOnlyAvailable(Boolean onlyAvailable) { setOnlyAvailable(onlyAvailable); return this; } /** *

* * @return If OnlyAvailable is true, Route 53 returns only domain names that are * available. If OnlyAvailable is false, Route 53 returns domain names without * checking whether they're available to be registered. To determine whether the domain is available, you * can call checkDomainAvailability for each suggestion. */ public Boolean isOnlyAvailable() { return this.onlyAvailable; } /** * 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 (getDomainName() != null) sb.append("DomainName: ").append(getDomainName()).append(","); if (getSuggestionCount() != null) sb.append("SuggestionCount: ").append(getSuggestionCount()).append(","); if (getOnlyAvailable() != null) sb.append("OnlyAvailable: ").append(getOnlyAvailable()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof GetDomainSuggestionsRequest == false) return false; GetDomainSuggestionsRequest other = (GetDomainSuggestionsRequest) obj; if (other.getDomainName() == null ^ this.getDomainName() == null) return false; if (other.getDomainName() != null && other.getDomainName().equals(this.getDomainName()) == false) return false; if (other.getSuggestionCount() == null ^ this.getSuggestionCount() == null) return false; if (other.getSuggestionCount() != null && other.getSuggestionCount().equals(this.getSuggestionCount()) == false) return false; if (other.getOnlyAvailable() == null ^ this.getOnlyAvailable() == null) return false; if (other.getOnlyAvailable() != null && other.getOnlyAvailable().equals(this.getOnlyAvailable()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getDomainName() == null) ? 0 : getDomainName().hashCode()); hashCode = prime * hashCode + ((getSuggestionCount() == null) ? 0 : getSuggestionCount().hashCode()); hashCode = prime * hashCode + ((getOnlyAvailable() == null) ? 0 : getOnlyAvailable().hashCode()); return hashCode; } @Override public GetDomainSuggestionsRequest clone() { return (GetDomainSuggestionsRequest) super.clone(); } }