Class HeaderObject

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

Describes the request headers that a Lightsail distribution bases caching on.

For the headers that you specify, your distribution caches separate versions of the specified content based on the header values in viewer requests. For example, suppose viewer requests for logo.jpg contain a custom product header that has a value of either acme or apex, and you configure your distribution to cache your content based on values in the product header. Your distribution forwards the product header to the origin and caches the response from the origin once for each header value.

See Also:

  • Method Details

    • option

      public final ForwardValues option()

      The headers that you want your distribution to forward to your origin and base caching on.

      You can configure your distribution to do one of the following:

      • all - Forward all headers to your origin.

      • none - Forward only the default headers.

      • allow-list - Forward only the headers you specify using the headersAllowList parameter.

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

      Returns:
      The headers that you want your distribution to forward to your origin and base caching on.

      You can configure your distribution to do one of the following:

      • all - Forward all headers to your origin.

      • none - Forward only the default headers.

      • allow-list - Forward only the headers you specify using the headersAllowList parameter.

      See Also:

    • optionAsString

      public final String optionAsString()

      The headers that you want your distribution to forward to your origin and base caching on.

      You can configure your distribution to do one of the following:

      • all - Forward all headers to your origin.

      • none - Forward only the default headers.

      • allow-list - Forward only the headers you specify using the headersAllowList parameter.

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

      Returns:
      The headers that you want your distribution to forward to your origin and base caching on.

      You can configure your distribution to do one of the following:

      • all - Forward all headers to your origin.

      • none - Forward only the default headers.

      • allow-list - Forward only the headers you specify using the headersAllowList parameter.

      See Also:

    • headersAllowList

      public final List<HeaderEnum> headersAllowList()

      The specific headers to forward to your distribution's origin.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasHeadersAllowList() method.

      Returns:
      The specific headers to forward to your distribution's origin.

    • hasHeadersAllowList

      public final boolean hasHeadersAllowList()
      For responses, this returns true if the service returned a value for the HeadersAllowList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • headersAllowListAsStrings

      public final List<String> headersAllowListAsStrings()

      The specific headers to forward to your distribution's origin.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasHeadersAllowList() method.

      Returns:
      The specific headers to forward to your distribution's origin.

    • toBuilder

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

    • builder

      public static HeaderObject.Builder builder()

    • serializableBuilderClass

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