software.amazon.awssdk.services.cloudfront.model

Class ForwardedValues

java.lang.Object

software.amazon.awssdk.services.cloudfront.model.ForwardedValues

All Implemented Interfaces:

ToCopyableBuilder<ForwardedValues.Builder,ForwardedValues>

@Generated(value="software.amazon.awssdk:codegen")
public final class ForwardedValues
extends Object
implements ToCopyableBuilder<ForwardedValues.Builder,ForwardedValues>

A complex type that specifies how CloudFront handles query strings and cookies.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ForwardedValues.Builder

Method Summary

Modifier and Type	Method and Description
static ForwardedValues.Builder	builder()
CookiePreference	cookies() A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Headers	headers() A complex type that specifies the Headers, if any, that you want CloudFront to base caching on for this cache behavior.
Boolean	queryString() Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters.
QueryStringCacheKeys	queryStringCacheKeys() A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
static Class<? extends ForwardedValues.Builder>	serializableBuilderClass()
ForwardedValues.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

queryString

public Boolean queryString()

Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys, if any:

If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.

If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.

If you specify false for QueryString, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.

For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide.

Returns:

Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys, if any:

If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.

If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.

If you specify false for QueryString, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.

For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide.

cookies

public CookiePreference cookies()

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.

Returns:

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.

headers

public Headers headers()

A complex type that specifies the Headers, if any, that you want CloudFront to base caching on for this cache behavior.

Returns:

A complex type that specifies the Headers, if any, that you want CloudFront to base caching on for this cache behavior.

queryStringCacheKeys

public QueryStringCacheKeys queryStringCacheKeys()

A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.

Returns:

A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.

toBuilder

public ForwardedValues.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<ForwardedValues.Builder,ForwardedValues>

Returns:

a builder for type T

builder

public static ForwardedValues.Builder builder()

serializableBuilderClass

public static Class<? extends ForwardedValues.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)