software.amazon.awssdk.services.cloudfront.model

Class CookieNames

java.lang.Object

software.amazon.awssdk.services.cloudfront.model.CookieNames

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CookieNames.Builder,CookieNames>

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

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 Request Headers in the Amazon CloudFront Developer Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CookieNames.Builder

Method Summary

Modifier and Type	Method and Description
static CookieNames.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasItems() Returns true if the Items property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<String>	items() A complex type that contains one Name element for each cookie that you want CloudFront to forward to the origin for this cache behavior.
Integer	quantity() The number of different cookies that you want CloudFront to forward to the origin for this cache behavior.
List<SdkField<?>>	sdkFields()
static Class<? extends CookieNames.Builder>	serializableBuilderClass()
CookieNames.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

quantity

public Integer quantity()

The number of different cookies that you want CloudFront to forward to the origin for this cache behavior. The value must equal the number of items that are in the Items field.

When you set Forward = whitelist (in the CookiePreferences object), this value must be 1 or higher.

Returns:

The number of different cookies that you want CloudFront to forward to the origin for this cache behavior. The value must equal the number of items that are in the Items field.

When you set Forward = whitelist (in the CookiePreferences object), this value must be 1 or higher.

hasItems

public boolean hasItems()

Returns true if the Items property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

items

public List<String> items()

A complex type that contains one Name element for each cookie that you want CloudFront to forward to the origin for this cache behavior. It must contain the same number of items that is specified in the Quantity field.

When you set Forward = whitelist (in the CookiePreferences object), this field must contain at least one item.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasItems() to see if a value was sent in this field.

Returns:

A complex type that contains one Name element for each cookie that you want CloudFront to forward to the origin for this cache behavior. It must contain the same number of items that is specified in the Quantity field.

When you set Forward = whitelist (in the CookiePreferences object), this field must contain at least one item.

toBuilder

public CookieNames.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CookieNames.Builder,CookieNames>

builder

public static CookieNames.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo