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(value="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 automatically included in requests that CloudFront sends to the origin.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CachePolicyQueryStringsConfig.Builder

Method Summary

Modifier and Type	Method and Description
static CachePolicyQueryStringsConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
CachePolicyQueryStringBehavior	queryStringBehavior() Determines whether any URL query strings in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin.
String	queryStringBehaviorAsString() Determines whether any URL query strings in viewer requests are included in the cache key and automatically included in requests that CloudFront sends to the origin.
QueryStringNames	queryStrings() Contains the specific query strings in viewer requests that either are or are not included in the cache key and automatically included in requests that CloudFront sends to the origin.
List<SdkField<?>>	sdkFields()
static Class<? extends CachePolicyQueryStringsConfig.Builder>	serializableBuilderClass()
CachePolicyQueryStringsConfig.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

queryStringBehavior

public final CachePolicyQueryStringBehavior queryStringBehavior()

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

• none – Query strings in viewer requests are not included in the cache key and are not automatically included 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 – The query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.

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

• all – All query strings in viewer requests are included in the cache key and are automatically included 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 automatically included in requests that CloudFront sends to the origin. Valid values are:

• none – Query strings in viewer requests are not included in the cache key and are not automatically included 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 – The query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.

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

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

See Also:

CachePolicyQueryStringBehavior

queryStringBehaviorAsString

public final String queryStringBehaviorAsString()

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

• none – Query strings in viewer requests are not included in the cache key and are not automatically included 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 – The query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.

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

• all – All query strings in viewer requests are included in the cache key and are automatically included 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 automatically included in requests that CloudFront sends to the origin. Valid values are:

• none – Query strings in viewer requests are not included in the cache key and are not automatically included 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 – The query strings in viewer requests that are listed in the QueryStringNames type are included in the cache key and automatically included in requests that CloudFront sends to the origin.

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

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

See Also:

CachePolicyQueryStringBehavior

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 automatically included 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 automatically included 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()

Specified by:

toBuilder in interface ToCopyableBuilder<CachePolicyQueryStringsConfig.Builder,CachePolicyQueryStringsConfig>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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