Package software.amazon.awssdk.services.route53domains.model

Interface GetDomainSuggestionsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetDomainSuggestionsRequest.Builder,GetDomainSuggestionsRequest>, Route53DomainsRequest.Builder, SdkBuilder<GetDomainSuggestionsRequest.Builder,GetDomainSuggestionsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetDomainSuggestionsRequest
public static interface GetDomainSuggestionsRequest.Builder extends Route53DomainsRequest.Builder, SdkPojo, CopyableBuilder<GetDomainSuggestionsRequest.Builder,GetDomainSuggestionsRequest>

  • Method Details

    • domainName

      GetDomainSuggestionsRequest.Builder domainName(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • suggestionCount

      GetDomainSuggestionsRequest.Builder suggestionCount(Integer suggestionCount)

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

      Parameters:
      suggestionCount - The number of suggested domain names that you want Route 53 to return. Specify a value between 1 and 50.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • onlyAvailable

      GetDomainSuggestionsRequest.Builder onlyAvailable(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      GetDomainSuggestionsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetDomainSuggestionsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.