Package software.amazon.awssdk.services.lightsail.model

Class CookieObject

java.lang.Object

software.amazon.awssdk.services.lightsail.model.CookieObject

All Implemented Interfaces:

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

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

Describes whether an Amazon Lightsail content delivery network (CDN) distribution forwards cookies to the origin and, if so, which ones.

For the cookies that you specify, your distribution caches separate versions of the specified content based on the cookie values in viewer requests.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CookieObject.Builder

Method Summary

Modifier and Type	Method	Description
static CookieObject.Builder	builder()
List<String>	cookiesAllowList()	The specific cookies to forward to your distribution's origin.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCookiesAllowList()	For responses, this returns true if the service returned a value for the CookiesAllowList property.
int	hashCode()
ForwardValues	option()	Specifies which cookies to forward to the distribution's origin for a cache behavior: all, none, or allow-list to forward only the cookies specified in the cookiesAllowList parameter.
String	optionAsString()	Specifies which cookies to forward to the distribution's origin for a cache behavior: all, none, or allow-list to forward only the cookies specified in the cookiesAllowList parameter.
List<SdkField<?>>	sdkFields()
static Class<? extends CookieObject.Builder>	serializableBuilderClass()
CookieObject.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

option

public final ForwardValues option()

Specifies which cookies to forward to the distribution's origin for a cache behavior: all, none, or allow-list to forward only the cookies specified in the cookiesAllowList parameter.

If the service returns an enum value that is not available in the current SDK version, option will return ForwardValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from optionAsString().

Returns:

Specifies which cookies to forward to the distribution's origin for a cache behavior: all, none, or allow-list to forward only the cookies specified in the cookiesAllowList parameter.

See Also:

ForwardValues

optionAsString

public final String optionAsString()

Specifies which cookies to forward to the distribution's origin for a cache behavior: all, none, or allow-list to forward only the cookies specified in the cookiesAllowList parameter.

If the service returns an enum value that is not available in the current SDK version, option will return ForwardValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from optionAsString().

Returns:

Specifies which cookies to forward to the distribution's origin for a cache behavior: all, none, or allow-list to forward only the cookies specified in the cookiesAllowList parameter.

See Also:

ForwardValues

hasCookiesAllowList

public final boolean hasCookiesAllowList()

For responses, this returns true if the service returned a value for the CookiesAllowList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

cookiesAllowList

public final List<String> cookiesAllowList()

The specific cookies to forward to your distribution's origin.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCookiesAllowList() method.

Returns:

The specific cookies to forward to your distribution's origin.

toBuilder

public CookieObject.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CookieObject.Builder,CookieObject>

builder

public static CookieObject.Builder builder()

serializableBuilderClass

public static Class<? extends CookieObject.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