Class DistributionCustomErrorResponse

java.lang.Object
software.amazon.awssdk.services.lightsail.model.DistributionCustomErrorResponse
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DistributionCustomErrorResponse.Builder,DistributionCustomErrorResponse>
@Generated("software.amazon.awssdk:codegen") public final class DistributionCustomErrorResponse extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DistributionCustomErrorResponse.Builder,DistributionCustomErrorResponse>

Describes a custom error response for a Lightsail distribution. A custom error response specifies the page that the distribution returns to the viewer. It also specifies the HTTP status code that the distribution sends when the origin responds with a given HTTP error code.

See Also:

  • Method Details

    • errorCode

      public final Integer errorCode()

      The HTTP error code from the origin that triggers the custom error response (for example, 403 or 404).

      Returns:
      The HTTP error code from the origin that triggers the custom error response (for example, 403 or 404).

    • responseCode

      public final String responseCode()

      The HTTP status code that the distribution returns to the viewer for the custom error response.

      Returns:
      The HTTP status code that the distribution returns to the viewer for the custom error response.

    • responsePagePath

      public final String responsePagePath()

      The path to the custom error page that the distribution returns to the viewer (for example, /404.html). The path must begin with a forward slash (/) and reference an object that is available from the origin.

      Returns:
      The path to the custom error page that the distribution returns to the viewer (for example, /404.html). The path must begin with a forward slash (/) and reference an object that is available from the origin.

    • errorCachingMinTTL

      public final Long errorCachingMinTTL()

      The minimum time, in seconds, that the distribution caches the custom error response before requesting the object again from the origin. If you don't specify a value, the default is 10 seconds.

      Returns:
      The minimum time, in seconds, that the distribution caches the custom error response before requesting the object again from the origin. If you don't specify a value, the default is 10 seconds.

    • toBuilder

      public DistributionCustomErrorResponse.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<DistributionCustomErrorResponse.Builder,DistributionCustomErrorResponse>
      Returns:
      a builder for type T

    • builder

      public static DistributionCustomErrorResponse.Builder builder()

    • serializableBuilderClass

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