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:

ToCopyableBuilder<GetDomainSuggestionsRequest.Builder,GetDomainSuggestionsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public 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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Boolean	onlyAvailable() If OnlyAvailable is true, Amazon Route 53 returns only domain names that are available.
static Class<? extends GetDomainSuggestionsRequest.Builder>	serializableBuilderClass()
Integer	suggestionCount() The number of suggested domain names that you want Amazon Route 53 to return.
GetDomainSuggestionsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

domainName

public String domainName()

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

Returns:

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

suggestionCount

public Integer suggestionCount()

The number of suggested domain names that you want Amazon Route 53 to return.

Returns:

The number of suggested domain names that you want Amazon Route 53 to return.

onlyAvailable

public Boolean onlyAvailable()

If OnlyAvailable is true, Amazon Route 53 returns only domain names that are available. If OnlyAvailable is false, Amazon 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, Amazon Route 53 returns only domain names that are available. If OnlyAvailable is false, Amazon 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()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetDomainSuggestionsRequest.Builder,GetDomainSuggestionsRequest>

Specified by:

toBuilder in class Route53DomainsRequest

Returns:

a builder for type T

builder

public static GetDomainSuggestionsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value