Package software.amazon.awssdk.services.cloudfront.model

Class CachePolicyQueryStringsConfig

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

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

See Also:

  • Method Details

    • queryStringBehavior

      public final CachePolicyQueryStringBehavior queryStringBehavior()

      Determines whether any URL query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:

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

      • whitelist – Only the query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and in requests that CloudFront sends to the origin.

      • allExcept – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, except those that are listed in the QueryStringNames type, which are not included.

      • all – All query strings in viewer requests 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, queryStringBehavior will return CachePolicyQueryStringBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from queryStringBehaviorAsString().

      Returns:
      Determines whether any URL query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:

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

      • whitelist – Only the query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and in requests that CloudFront sends to the origin.

      • allExcept – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, except those that are listed in the QueryStringNames type, which are not included.

      • all – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin.

      See Also:

    • queryStringBehaviorAsString

      public final String queryStringBehaviorAsString()

      Determines whether any URL query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:

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

      • whitelist – Only the query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and in requests that CloudFront sends to the origin.

      • allExcept – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, except those that are listed in the QueryStringNames type, which are not included.

      • all – All query strings in viewer requests 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, queryStringBehavior will return CachePolicyQueryStringBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from queryStringBehaviorAsString().

      Returns:
      Determines whether any URL query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:

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

      • whitelist – Only the query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and in requests that CloudFront sends to the origin.

      • allExcept – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, except those that are listed in the QueryStringNames type, which are not included.

      • all – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin.

      See Also:

    • queryStrings

      public final QueryStringNames queryStrings()

      Contains the specific query strings in viewer requests that either are or are not included in the cache key and in requests that CloudFront sends to the origin. The behavior depends on whether the QueryStringBehavior field in the CachePolicyQueryStringsConfig type is set to whitelist (the listed query strings are included) or allExcept (the listed query strings are not included, but all other query strings are).

      Returns:
      Contains the specific query strings in viewer requests that either are or are not included in the cache key and in requests that CloudFront sends to the origin. The behavior depends on whether the QueryStringBehavior field in the CachePolicyQueryStringsConfig type is set to whitelist (the listed query strings are included) or allExcept (the listed query strings are not included, but all other query strings are).

    • toBuilder

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

    • builder

      public static CachePolicyQueryStringsConfig.Builder builder()

    • serializableBuilderClass

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