Class LightsailDistributionSubdomain

java.lang.Object
software.amazon.awssdk.services.lightsail.model.LightsailDistributionSubdomain
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<LightsailDistributionSubdomain.Builder,LightsailDistributionSubdomain>

@Generated("software.amazon.awssdk:codegen") public final class LightsailDistributionSubdomain extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LightsailDistributionSubdomain.Builder,LightsailDistributionSubdomain>

Describes the Lightsail subdomain of a distribution. The distribution is reachable at the subdomain's web address, which is the subdomain followed by amazonlightsail.com.

See Also:
  • Method Details

    • name

      public final String name()

      The subdomain (for example, mysite), not its web address.

      Returns:
      The subdomain (for example, mysite), not its web address.
    • state

      The state of the subdomain for the distribution.

      The following states are possible:

      • Creating – The subdomain is being created.

      • Attaching – The subdomain is being associated with the distribution.

      • Attached – The subdomain is associated with the distribution.

      • Error – The subdomain couldn't be created or associated with the distribution. For more information, see the errorCode and errorDetails parameters.

      If the service returns an enum value that is not available in the current SDK version, state will return LightsailDistributionSubdomainStateEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The state of the subdomain for the distribution.

      The following states are possible:

      • Creating – The subdomain is being created.

      • Attaching – The subdomain is being associated with the distribution.

      • Attached – The subdomain is associated with the distribution.

      • Error – The subdomain couldn't be created or associated with the distribution. For more information, see the errorCode and errorDetails parameters.

      See Also:
    • stateAsString

      public final String stateAsString()

      The state of the subdomain for the distribution.

      The following states are possible:

      • Creating – The subdomain is being created.

      • Attaching – The subdomain is being associated with the distribution.

      • Attached – The subdomain is associated with the distribution.

      • Error – The subdomain couldn't be created or associated with the distribution. For more information, see the errorCode and errorDetails parameters.

      If the service returns an enum value that is not available in the current SDK version, state will return LightsailDistributionSubdomainStateEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The state of the subdomain for the distribution.

      The following states are possible:

      • Creating – The subdomain is being created.

      • Attaching – The subdomain is being associated with the distribution.

      • Attached – The subdomain is associated with the distribution.

      • Error – The subdomain couldn't be created or associated with the distribution. For more information, see the errorCode and errorDetails parameters.

      See Also:
    • errorCode

      public final String errorCode()

      The error code that describes why the subdomain is in the Error state.

      Returns:
      The error code that describes why the subdomain is in the Error state.
    • errorDetails

      public final String errorDetails()

      The details of the error that caused the subdomain to be in the Error state.

      Returns:
      The details of the error that caused the subdomain to be in the Error state.
    • 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<LightsailDistributionSubdomain.Builder,LightsailDistributionSubdomain>
      Returns:
      a builder for type T
    • builder

      public static LightsailDistributionSubdomain.Builder builder()
    • serializableBuilderClass

      public static Class<? extends LightsailDistributionSubdomain.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object
    • 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)
    • 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.