software.amazon.awssdk.services.route53domains.model.GetDomainSuggestionsRequest Maven / Gradle / Ivy
Show all versions of route53domains Show documentation
/*
* Copyright 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 software.amazon.awssdk.services.route53domains.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class GetDomainSuggestionsRequest extends Route53DomainsRequest implements
ToCopyableBuilder {
private static final SdkField DOMAIN_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DomainName").getter(getter(GetDomainSuggestionsRequest::domainName)).setter(setter(Builder::domainName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DomainName").build()).build();
private static final SdkField SUGGESTION_COUNT_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("SuggestionCount").getter(getter(GetDomainSuggestionsRequest::suggestionCount))
.setter(setter(Builder::suggestionCount))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SuggestionCount").build()).build();
private static final SdkField ONLY_AVAILABLE_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("OnlyAvailable").getter(getter(GetDomainSuggestionsRequest::onlyAvailable))
.setter(setter(Builder::onlyAvailable))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OnlyAvailable").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DOMAIN_NAME_FIELD,
SUGGESTION_COUNT_FIELD, ONLY_AVAILABLE_FIELD));
private final String domainName;
private final Integer suggestionCount;
private final Boolean onlyAvailable;
private GetDomainSuggestionsRequest(BuilderImpl builder) {
super(builder);
this.domainName = builder.domainName;
this.suggestionCount = builder.suggestionCount;
this.onlyAvailable = builder.onlyAvailable;
}
/**
*
* 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.
*
*
* @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.
*
*
*
*
* 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 final String domainName() {
return domainName;
}
/**
*
* 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 final Integer suggestionCount() {
return 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.
*
*
* @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 final Boolean onlyAvailable() {
return onlyAvailable;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(domainName());
hashCode = 31 * hashCode + Objects.hashCode(suggestionCount());
hashCode = 31 * hashCode + Objects.hashCode(onlyAvailable());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof GetDomainSuggestionsRequest)) {
return false;
}
GetDomainSuggestionsRequest other = (GetDomainSuggestionsRequest) obj;
return Objects.equals(domainName(), other.domainName()) && Objects.equals(suggestionCount(), other.suggestionCount())
&& Objects.equals(onlyAvailable(), other.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.
*/
@Override
public final String toString() {
return ToString.builder("GetDomainSuggestionsRequest").add("DomainName", domainName())
.add("SuggestionCount", suggestionCount()).add("OnlyAvailable", onlyAvailable()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DomainName":
return Optional.ofNullable(clazz.cast(domainName()));
case "SuggestionCount":
return Optional.ofNullable(clazz.cast(suggestionCount()));
case "OnlyAvailable":
return Optional.ofNullable(clazz.cast(onlyAvailable()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetDomainSuggestionsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends Route53DomainsRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* 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.
*
*
* @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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder domainName(String domainName);
/**
*
* 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.
*/
Builder suggestionCount(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.
*
*
* @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.
*/
Builder onlyAvailable(Boolean onlyAvailable);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends Route53DomainsRequest.BuilderImpl implements Builder {
private String domainName;
private Integer suggestionCount;
private Boolean onlyAvailable;
private BuilderImpl() {
}
private BuilderImpl(GetDomainSuggestionsRequest model) {
super(model);
domainName(model.domainName);
suggestionCount(model.suggestionCount);
onlyAvailable(model.onlyAvailable);
}
public final String getDomainName() {
return domainName;
}
public final void setDomainName(String domainName) {
this.domainName = domainName;
}
@Override
public final Builder domainName(String domainName) {
this.domainName = domainName;
return this;
}
public final Integer getSuggestionCount() {
return suggestionCount;
}
public final void setSuggestionCount(Integer suggestionCount) {
this.suggestionCount = suggestionCount;
}
@Override
public final Builder suggestionCount(Integer suggestionCount) {
this.suggestionCount = suggestionCount;
return this;
}
public final Boolean getOnlyAvailable() {
return onlyAvailable;
}
public final void setOnlyAvailable(Boolean onlyAvailable) {
this.onlyAvailable = onlyAvailable;
}
@Override
public final Builder onlyAvailable(Boolean onlyAvailable) {
this.onlyAvailable = onlyAvailable;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public GetDomainSuggestionsRequest build() {
return new GetDomainSuggestionsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}