com.amazonaws.services.cloudfront.model.ForwardedValues Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudfront Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.cloudfront.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* 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 AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ForwardedValues implements Serializable, Cloneable {
/**
*
* 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.
*
*/
private 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 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.
*
*/
private 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 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.
*
*/
private 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 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.
*
*/
private 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.
*
*
* 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.
*
*
* @param 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.
*/
public void setQueryString(Boolean queryString) {
this.queryString = 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.
*
*
* @return 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.
*/
public Boolean getQueryString() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ForwardedValues withQueryString(Boolean queryString) {
setQueryString(queryString);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public Boolean isQueryString() {
return this.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 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.
*
*
* @param 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.
*/
public void setCookies(CookiePreference cookies) {
this.cookies = 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.
*
*
* @return 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.
*/
public CookiePreference getCookies() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ForwardedValues withCookies(CookiePreference cookies) {
setCookies(cookies);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setHeaders(Headers headers) {
this.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.
*
*
* @return 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.
*/
public Headers getHeaders() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ForwardedValues withHeaders(Headers headers) {
setHeaders(headers);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setQueryStringCacheKeys(QueryStringCacheKeys queryStringCacheKeys) {
this.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.
*
*
* @return 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.
*/
public QueryStringCacheKeys getQueryStringCacheKeys() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ForwardedValues withQueryStringCacheKeys(QueryStringCacheKeys queryStringCacheKeys) {
setQueryStringCacheKeys(queryStringCacheKeys);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getQueryString() != null)
sb.append("QueryString: ").append(getQueryString()).append(",");
if (getCookies() != null)
sb.append("Cookies: ").append(getCookies()).append(",");
if (getHeaders() != null)
sb.append("Headers: ").append(getHeaders()).append(",");
if (getQueryStringCacheKeys() != null)
sb.append("QueryStringCacheKeys: ").append(getQueryStringCacheKeys());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ForwardedValues == false)
return false;
ForwardedValues other = (ForwardedValues) obj;
if (other.getQueryString() == null ^ this.getQueryString() == null)
return false;
if (other.getQueryString() != null && other.getQueryString().equals(this.getQueryString()) == false)
return false;
if (other.getCookies() == null ^ this.getCookies() == null)
return false;
if (other.getCookies() != null && other.getCookies().equals(this.getCookies()) == false)
return false;
if (other.getHeaders() == null ^ this.getHeaders() == null)
return false;
if (other.getHeaders() != null && other.getHeaders().equals(this.getHeaders()) == false)
return false;
if (other.getQueryStringCacheKeys() == null ^ this.getQueryStringCacheKeys() == null)
return false;
if (other.getQueryStringCacheKeys() != null && other.getQueryStringCacheKeys().equals(this.getQueryStringCacheKeys()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getQueryString() == null) ? 0 : getQueryString().hashCode());
hashCode = prime * hashCode + ((getCookies() == null) ? 0 : getCookies().hashCode());
hashCode = prime * hashCode + ((getHeaders() == null) ? 0 : getHeaders().hashCode());
hashCode = prime * hashCode + ((getQueryStringCacheKeys() == null) ? 0 : getQueryStringCacheKeys().hashCode());
return hashCode;
}
@Override
public ForwardedValues clone() {
try {
return (ForwardedValues) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}