software.amazon.awssdk.services.route53domains.model

Class GetDomainSuggestionsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.route53domains.model.Route53DomainsRequest

software.amazon.awssdk.services.route53domains.model.GetDomainSuggestionsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetDomainSuggestionsRequest.Builder,GetDomainSuggestionsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetDomainSuggestionsRequest
extends Route53DomainsRequest
implements ToCopyableBuilder<GetDomainSuggestionsRequest.Builder,GetDomainSuggestionsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetDomainSuggestionsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetDomainSuggestionsRequest.Builder	builder()
String	domainName() A domain name that you want to use as the basis for a list of possible domain names.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	onlyAvailable() If OnlyAvailable is true, Route 53 returns only domain names that are available.
List<SdkField<?>>	sdkFields()
static Class<? extends GetDomainSuggestionsRequest.Builder>	serializableBuilderClass()
Integer	suggestionCount() The number of suggested domain names that you want Route 53 to return.
GetDomainSuggestionsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

domainName

public final String 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.

Returns:

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.

suggestionCount

public final Integer suggestionCount()

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

Returns:

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

onlyAvailable

public final Boolean 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.

Returns:

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.

toBuilder

public GetDomainSuggestionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetDomainSuggestionsRequest.Builder,GetDomainSuggestionsRequest>

Specified by:

toBuilder in class Route53DomainsRequest

builder

public static GetDomainSuggestionsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetDomainSuggestionsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo