com.amazonaws.services.cloudfront.model.CookiePreference Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudfront Show documentation
/*
* Copyright 2017-2022 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 cookies in the cache key, use CookiesConfig in a cache policy. See
* CachePolicy.
*
*
* If you want to send cookies to the origin but not include them in the cache key, use CookiesConfig in an
* origin request policy. See OriginRequestPolicy.
*
*
* 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 Caching Content Based on
* Cookies in the Amazon CloudFront Developer Guide.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CookiePreference 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 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 origin request policy. For
* more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
*
*
* Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies
* specified in the WhitelistedNames complex type.
*
*
* Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify
* none for the Forward element.
*
*/
private String forward;
/**
*
* 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.
*
*
* Required if you specify whitelist for the value of Forward. A complex type that
* specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if
* you want to forward selected cookies, the names of those cookies.
*
*
* If you specify all or none for the value of Forward, omit
* WhitelistedNames. If you change the value of Forward from whitelist to
* all or none and you don't delete the WhitelistedNames element and its
* child elements, CloudFront deletes them automatically.
*
*
* For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront
* Limits in the Amazon Web Services General Reference.
*
*/
private CookieNames whitelistedNames;
/**
*
* 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 origin request policy. For
* more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
*
*
* Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies
* specified in the WhitelistedNames complex type.
*
*
* Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify
* none for the Forward element.
*
*
* @param forward
* 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 origin request
* policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
*
*
* Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of
* cookies specified in the WhitelistedNames complex type.
*
*
* Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin,
* specify none for the Forward element.
* @see ItemSelection
*/
public void setForward(String forward) {
this.forward = forward;
}
/**
*
* 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 origin request policy. For
* more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
*
*
* Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies
* specified in the WhitelistedNames complex type.
*
*
* Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify
* none for the Forward element.
*
*
* @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 origin request
* policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
*
*
* Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of
* cookies specified in the WhitelistedNames complex type.
*
*
* Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin,
* specify none for the Forward element.
* @see ItemSelection
*/
public String getForward() {
return this.forward;
}
/**
*
* 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 origin request policy. For
* more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
*
*
* Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies
* specified in the WhitelistedNames complex type.
*
*
* Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify
* none for the Forward element.
*
*
* @param forward
* 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 origin request
* policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
*
*
* Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of
* cookies specified in the WhitelistedNames complex type.
*
*
* Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin,
* specify none for the Forward element.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ItemSelection
*/
public CookiePreference withForward(String forward) {
setForward(forward);
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 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 origin request policy. For
* more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
*
*
* Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies
* specified in the WhitelistedNames complex type.
*
*
* Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify
* none for the Forward element.
*
*
* @param forward
* 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 origin request
* policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
*
*
* Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of
* cookies specified in the WhitelistedNames complex type.
*
*
* Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin,
* specify none for the Forward element.
* @see ItemSelection
*/
public void setForward(ItemSelection forward) {
withForward(forward);
}
/**
*
* 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 origin request policy. For
* more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
*
*
* Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies
* specified in the WhitelistedNames complex type.
*
*
* Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify
* none for the Forward element.
*
*
* @param forward
* 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 origin request
* policy. For more information, see Creating origin request policies in the Amazon CloudFront Developer Guide.
*
*
* Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of
* cookies specified in the WhitelistedNames complex type.
*
*
* Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin,
* specify none for the Forward element.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ItemSelection
*/
public CookiePreference withForward(ItemSelection forward) {
this.forward = forward.toString();
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 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.
*
*
* Required if you specify whitelist for the value of Forward. A complex type that
* specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if
* you want to forward selected cookies, the names of those cookies.
*
*
* If you specify all or none for the value of Forward, omit
* WhitelistedNames. If you change the value of Forward from whitelist to
* all or none and you don't delete the WhitelistedNames element and its
* child elements, CloudFront deletes them automatically.
*
*
* For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront
* Limits in the Amazon Web Services General Reference.
*
*
* @param whitelistedNames
* 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.
*
*
* Required if you specify whitelist for the value of Forward. A complex type that
* specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior
* and, if you want to forward selected cookies, the names of those cookies.
*
*
* If you specify all or none for the value of Forward, omit
* WhitelistedNames. If you change the value of Forward from whitelist
* to all or none and you don't delete the WhitelistedNames element
* and its child elements, CloudFront deletes them automatically.
*
*
* For the current limit on the number of cookie names that you can whitelist for each cache behavior, see
* CloudFront Limits in the Amazon Web Services General Reference.
*/
public void setWhitelistedNames(CookieNames whitelistedNames) {
this.whitelistedNames = whitelistedNames;
}
/**
*
* 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.
*
*
* Required if you specify whitelist for the value of Forward. A complex type that
* specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if
* you want to forward selected cookies, the names of those cookies.
*
*
* If you specify all or none for the value of Forward, omit
* WhitelistedNames. If you change the value of Forward from whitelist to
* all or none and you don't delete the WhitelistedNames element and its
* child elements, CloudFront deletes them automatically.
*
*
* For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront
* Limits in the Amazon Web Services General Reference.
*
*
* @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.
*
*
* Required if you specify whitelist for the value of Forward. A complex type that
* specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior
* and, if you want to forward selected cookies, the names of those cookies.
*
*
* If you specify all or none for the value of Forward, omit
* WhitelistedNames. If you change the value of Forward from
* whitelist to all or none and you don't delete the
* WhitelistedNames element and its child elements, CloudFront deletes them automatically.
*
*
* For the current limit on the number of cookie names that you can whitelist for each cache behavior, see
*
* CloudFront Limits in the Amazon Web Services General Reference.
*/
public CookieNames getWhitelistedNames() {
return this.whitelistedNames;
}
/**
*
* 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.
*
*
* Required if you specify whitelist for the value of Forward. A complex type that
* specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if
* you want to forward selected cookies, the names of those cookies.
*
*
* If you specify all or none for the value of Forward, omit
* WhitelistedNames. If you change the value of Forward from whitelist to
* all or none and you don't delete the WhitelistedNames element and its
* child elements, CloudFront deletes them automatically.
*
*
* For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront
* Limits in the Amazon Web Services General Reference.
*
*
* @param whitelistedNames
* 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.
*
*
* Required if you specify whitelist for the value of Forward. A complex type that
* specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior
* and, if you want to forward selected cookies, the names of those cookies.
*
*
* If you specify all or none for the value of Forward, omit
* WhitelistedNames. If you change the value of Forward from whitelist
* to all or none and you don't delete the WhitelistedNames element
* and its child elements, CloudFront deletes them automatically.
*
*
* For the current limit on the number of cookie names that you can whitelist for each cache behavior, see
* CloudFront Limits in the Amazon Web Services General Reference.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CookiePreference withWhitelistedNames(CookieNames whitelistedNames) {
setWhitelistedNames(whitelistedNames);
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 (getForward() != null)
sb.append("Forward: ").append(getForward()).append(",");
if (getWhitelistedNames() != null)
sb.append("WhitelistedNames: ").append(getWhitelistedNames());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CookiePreference == false)
return false;
CookiePreference other = (CookiePreference) obj;
if (other.getForward() == null ^ this.getForward() == null)
return false;
if (other.getForward() != null && other.getForward().equals(this.getForward()) == false)
return false;
if (other.getWhitelistedNames() == null ^ this.getWhitelistedNames() == null)
return false;
if (other.getWhitelistedNames() != null && other.getWhitelistedNames().equals(this.getWhitelistedNames()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getForward() == null) ? 0 : getForward().hashCode());
hashCode = prime * hashCode + ((getWhitelistedNames() == null) ? 0 : getWhitelistedNames().hashCode());
return hashCode;
}
@Override
public CookiePreference clone() {
try {
return (CookiePreference) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}