Class CookieObject
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic CookieObject.Builder
builder()
The specific cookies to forward to your distribution's origin.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the CookiesAllowList property.final int
hashCode()
final ForwardValues
option()
Specifies which cookies to forward to the distribution's origin for a cache behavior:all
,none
, orallow-list
to forward only the cookies specified in thecookiesAllowList
parameter.final String
Specifies which cookies to forward to the distribution's origin for a cache behavior:all
,none
, orallow-list
to forward only the cookies specified in thecookiesAllowList
parameter.static Class
<? extends CookieObject.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
option
Specifies which cookies to forward to the distribution's origin for a cache behavior:
all
,none
, orallow-list
to forward only the cookies specified in thecookiesAllowList
parameter.If the service returns an enum value that is not available in the current SDK version,
option
will returnForwardValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoptionAsString()
.- Returns:
- Specifies which cookies to forward to the distribution's origin for a cache behavior:
all
,none
, orallow-list
to forward only the cookies specified in thecookiesAllowList
parameter. - See Also:
-
optionAsString
Specifies which cookies to forward to the distribution's origin for a cache behavior:
all
,none
, orallow-list
to forward only the cookies specified in thecookiesAllowList
parameter.If the service returns an enum value that is not available in the current SDK version,
option
will returnForwardValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoptionAsString()
.- Returns:
- Specifies which cookies to forward to the distribution's origin for a cache behavior:
all
,none
, orallow-list
to forward only the cookies specified in thecookiesAllowList
parameter. - See Also:
-
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 theisEmpty()
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CookieObject.Builder,
CookieObject> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-