ForwardedValues (AWS Java SDK :: Services :: Amazon CloudFront 2.17.100 API)

java.lang.Object
- software.amazon.awssdk.services.cloudfront.model.ForwardedValues

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ForwardedValues.Builder,ForwardedValues>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class ForwardedValues
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ForwardedValues.Builder,ForwardedValues>
```
This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.

If you want to include values in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.

If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ForwardedValues.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ForwardedValues.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ForwardedValues.Builder`	`builder()`
`CookiePreference`	`cookies()` This field is deprecated.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Headers`	`headers()` This field is deprecated.
`Boolean`	`queryString()` This field is deprecated.
`QueryStringCacheKeys`	`queryStringCacheKeys()` This field is deprecated.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ForwardedValues.Builder>`	`serializableBuilderClass()`
`ForwardedValues.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
  - queryString
```
public final Boolean queryString()
```
    This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
    
    If you want to include query strings in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
    
    If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
    
    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:
    
    This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
    
    If you want to include query strings in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
    
    If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
    
    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 final CookiePreference cookies()
```
    This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
    
    If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
    
    If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
    
    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:
    
    This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
    
    If you want to include cookies in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
    
    If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
    
    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 final Headers headers()
```
    This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
    
    If you want to include headers in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
    
    If you want to send headers to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
    
    A complex type that specifies the Headers, if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.
    
    For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide.
    
    Returns:
    
    This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
    
    If you want to include headers in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
    
    If you want to send headers to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
    
    A complex type that specifies the Headers, if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.
    
    For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide.
  - queryStringCacheKeys
```
public final QueryStringCacheKeys queryStringCacheKeys()
```
    This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
    
    If you want to include query strings in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
    
    If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
    
    A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.
    
    Returns:
    
    This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.
    
    If you want to include query strings in the cache key, use a cache policy. For more information, see Creating cache policies in the Amazon CloudFront Developer Guide.
    
    If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
    
    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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ForwardedValues.Builder,ForwardedValues>
  - builder
```
public static ForwardedValues.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ForwardedValues.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

Class ForwardedValues

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

queryString

cookies

headers

queryStringCacheKeys

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields