Package software.amazon.awssdk.services.cloudfront.model

Class QueryStringCacheKeys

java.lang.Object

software.amazon.awssdk.services.cloudfront.model.QueryStringCacheKeys

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class QueryStringCacheKeys
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<QueryStringCacheKeys.Builder,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 QueryStringsConfig in a cache policy. See CachePolicy.

If you want to send query strings to the origin but not include them in the cache key, use QueryStringsConfig in an origin request policy. See OriginRequestPolicy.

A complex type that contains information about the query string parameters that you want CloudFront to use for caching for a cache behavior.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	QueryStringCacheKeys.Builder

Method Summary

Modifier and Type	Method	Description
static QueryStringCacheKeys.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasItems()	For responses, this returns true if the service returned a value for the Items property.
List<String>	items()	A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior.
Integer	quantity()	The number of whitelisted query string parameters for a cache behavior.
List<SdkField<?>>	sdkFields()
static Class<? extends QueryStringCacheKeys.Builder>	serializableBuilderClass()
QueryStringCacheKeys.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 final Integer quantity()

The number of whitelisted query string parameters for a cache behavior.

Returns:

The number of whitelisted query string parameters for a cache behavior.

hasItems

public final boolean hasItems()

For responses, this returns true if the service returned a value for the Items 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.

items

public final List<String> items()

A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items.

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 hasItems() method.

Returns:

A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items.

toBuilder

public QueryStringCacheKeys.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<QueryStringCacheKeys.Builder,QueryStringCacheKeys>

builder

public static QueryStringCacheKeys.Builder builder()

serializableBuilderClass

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