Class CachePolicyHeadersConfig

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

An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and in requests that CloudFront sends to the origin.

See Also:

  • Method Details

    • headerBehavior

      public final CachePolicyHeaderBehavior headerBehavior()

      Determines whether any HTTP headers are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:

      • none – No HTTP headers are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set to none, any headers that are listed in an OriginRequestPolicy are included in origin requests.

      • whitelist – Only the HTTP headers that are listed in the Headers type are included in the cache key and in requests that CloudFront sends to the origin.

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

      Returns:
      Determines whether any HTTP headers are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:

      • none – No HTTP headers are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set to none, any headers that are listed in an OriginRequestPolicy are included in origin requests.

      • whitelist – Only the HTTP headers that are listed in the Headers type are included in the cache key and in requests that CloudFront sends to the origin.

      See Also:

    • headerBehaviorAsString

      public final String headerBehaviorAsString()

      Determines whether any HTTP headers are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:

      • none – No HTTP headers are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set to none, any headers that are listed in an OriginRequestPolicy are included in origin requests.

      • whitelist – Only the HTTP headers that are listed in the Headers type are included in the cache key and in requests that CloudFront sends to the origin.

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

      Returns:
      Determines whether any HTTP headers are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:

      • none – No HTTP headers are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set to none, any headers that are listed in an OriginRequestPolicy are included in origin requests.

      • whitelist – Only the HTTP headers that are listed in the Headers type are included in the cache key and in requests that CloudFront sends to the origin.

      See Also:

    • headers

      public final Headers headers()
      Returns the value of the Headers property for this object.
      Returns:
      The value of the Headers property for this object.

    • toBuilder

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

    • builder

      public static CachePolicyHeadersConfig.Builder builder()

    • serializableBuilderClass

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