Class CheckSubdomainAvailabilityRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.lightsail.model.LightsailRequest
software.amazon.awssdk.services.lightsail.model.CheckSubdomainAvailabilityRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CheckSubdomainAvailabilityRequest.Builder,CheckSubdomainAvailabilityRequest>
@Generated("software.amazon.awssdk:codegen") public final class CheckSubdomainAvailabilityRequest extends LightsailRequest implements ToCopyableBuilder<CheckSubdomainAvailabilityRequest.Builder,CheckSubdomainAvailabilityRequest>

  • Method Details

    • subdomainName

      public final String subdomainName()

      The subdomain to check (for example, mysite or blog.mysite).

      A subdomain can contain one or two labels separated by a period (.). Each label must start and end with a lowercase letter or a number, and can contain only lowercase letters, numbers, and hyphens (- ). The name can be up to 39 characters long, including periods. Labels that start with xn-- aren't supported, and some names are reserved.

      Specify only the subdomain. A web address, such as mysite.amazonlightsail.com, isn't accepted.

      Returns:
      The subdomain to check (for example, mysite or blog.mysite).

      A subdomain can contain one or two labels separated by a period (.). Each label must start and end with a lowercase letter or a number, and can contain only lowercase letters, numbers, and hyphens (-). The name can be up to 39 characters long, including periods. Labels that start with xn-- aren't supported, and some names are reserved.

      Specify only the subdomain. A web address, such as mysite.amazonlightsail.com, isn't accepted.

    • reserve

      public final Boolean reserve()

      Specifies whether to reserve the subdomain for your account if it's available. A reservation holds the subdomain for 15 minutes so that other accounts can't create it. Checking the subdomain again doesn't extend the reservation.

      For a nested subdomain, such as blog.mysite, the top-level subdomain (mysite) is reserved.

      You can have up to 5 active reservations at a time.

      Returns:
      Specifies whether to reserve the subdomain for your account if it's available. A reservation holds the subdomain for 15 minutes so that other accounts can't create it. Checking the subdomain again doesn't extend the reservation.

      For a nested subdomain, such as blog.mysite, the top-level subdomain (mysite) is reserved.

      You can have up to 5 active reservations at a time.

    • toBuilder

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

    • builder

      public static CheckSubdomainAvailabilityRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CheckSubdomainAvailabilityRequest.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.