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

Class CheckDomainAvailabilityRequest

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.CheckDomainAvailabilityRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CheckDomainAvailabilityRequest.Builder,CheckDomainAvailabilityRequest>
@Generated("software.amazon.awssdk:codegen") public final class CheckDomainAvailabilityRequest extends Route53DomainsRequest implements ToCopyableBuilder<CheckDomainAvailabilityRequest.Builder,CheckDomainAvailabilityRequest>

The CheckDomainAvailability request contains the following elements.

  • Method Details

    • domainName

      public final String domainName()

      The name of the domain that you want to get availability for. 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. For more information, see Formatting Internationalized Domain Names.

      Returns:
      The name of the domain that you want to get availability for. 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. For more information, see Formatting Internationalized Domain Names.

    • idnLangCode

      public final String idnLangCode()

      Reserved for future use.

      Returns:
      Reserved for future use.

    • toBuilder

      public CheckDomainAvailabilityRequest.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<CheckDomainAvailabilityRequest.Builder,CheckDomainAvailabilityRequest>
      Specified by:
      toBuilder in class Route53DomainsRequest
      Returns:
      a builder for type T

    • builder

      public static CheckDomainAvailabilityRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CheckDomainAvailabilityRequest.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.