Class QueryStringCacheKeys
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic QueryStringCacheKeys.Builder
builder()
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 int
hashCode()
final boolean
hasItems()
For responses, this returns true if the service returned a value for the Items property.items()
A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior.final Integer
quantity()
The number ofwhitelisted
query string parameters for a cache behavior.static Class
<? extends QueryStringCacheKeys.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
-
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 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. -
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 omitItems
.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 omitItems
.
-
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<QueryStringCacheKeys.Builder,
QueryStringCacheKeys> - 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
-