Class OriginRequestPolicyQueryStringsConfig

java.lang.Object

software.amazon.awssdk.services.cloudfront.model.OriginRequestPolicyQueryStringsConfig

All Implemented Interfaces:

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

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

An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in requests that CloudFront sends to the origin.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OriginRequestPolicyQueryStringsConfig.Builder

Method Summary

Modifier and Type	Method	Description
static OriginRequestPolicyQueryStringsConfig.Builder	builder()
final boolean	equals(Object obj)
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 OriginRequestPolicyQueryStringBehavior	queryStringBehavior()	Determines whether any URL query strings in viewer requests are included in requests that CloudFront sends to the origin.
final String	queryStringBehaviorAsString()	Determines whether any URL query strings in viewer requests are included in requests that CloudFront sends to the origin.
final QueryStringNames	queryStrings()	Contains the specific query strings in viewer requests that either are or are not included in requests that CloudFront sends to the origin.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends OriginRequestPolicyQueryStringsConfig.Builder>	serializableBuilderClass()
OriginRequestPolicyQueryStringsConfig.Builder	toBuilder()	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 class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

queryStringBehavior

public final OriginRequestPolicyQueryStringBehavior queryStringBehavior()

Determines whether any URL query strings in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:

• none – No query strings in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to none, any query strings that are listed in a CachePolicy are included in origin requests.

• whitelist – Only the query strings in viewer requests that are listed in the QueryStringNames type are included in requests that CloudFront sends to the origin.

• all – All query strings in viewer requests are included in requests that CloudFront sends to the origin.

• allExcept – All query strings in viewer requests are included in requests that CloudFront sends to the origin, except for those listed in the QueryStringNames type, which are not included.

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

Returns:

Determines whether any URL query strings in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:

• none – No query strings in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to none, any query strings that are listed in a CachePolicy are included in origin requests.

• whitelist – Only the query strings in viewer requests that are listed in the QueryStringNames type are included in requests that CloudFront sends to the origin.

• all – All query strings in viewer requests are included in requests that CloudFront sends to the origin.

• allExcept – All query strings in viewer requests are included in requests that CloudFront sends to the origin, except for those listed in the QueryStringNames type, which are not included.

See Also:

• OriginRequestPolicyQueryStringBehavior

queryStringBehaviorAsString

public final String queryStringBehaviorAsString()

Determines whether any URL query strings in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:

• none – No query strings in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to none, any query strings that are listed in a CachePolicy are included in origin requests.

• whitelist – Only the query strings in viewer requests that are listed in the QueryStringNames type are included in requests that CloudFront sends to the origin.

• all – All query strings in viewer requests are included in requests that CloudFront sends to the origin.

• allExcept – All query strings in viewer requests are included in requests that CloudFront sends to the origin, except for those listed in the QueryStringNames type, which are not included.

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

Returns:

Determines whether any URL query strings in viewer requests are included in requests that CloudFront sends to the origin. Valid values are:

• none – No query strings in viewer requests are included in requests that CloudFront sends to the origin. Even when this field is set to none, any query strings that are listed in a CachePolicy are included in origin requests.

• whitelist – Only the query strings in viewer requests that are listed in the QueryStringNames type are included in requests that CloudFront sends to the origin.

• all – All query strings in viewer requests are included in requests that CloudFront sends to the origin.

• allExcept – All query strings in viewer requests are included in requests that CloudFront sends to the origin, except for those listed in the QueryStringNames type, which are not included.

See Also:

• OriginRequestPolicyQueryStringBehavior

queryStrings

public final QueryStringNames queryStrings()

Contains the specific query strings in viewer requests that either are or are not included in requests that CloudFront sends to the origin. The behavior depends on whether the QueryStringBehavior field in the OriginRequestPolicyQueryStringsConfig type is set to whitelist (the listed query strings are included) or allExcept (the listed query strings are not included, but all other query strings are).

Returns:

Contains the specific query strings in viewer requests that either are or are not included in requests that CloudFront sends to the origin. The behavior depends on whether the QueryStringBehavior field in the OriginRequestPolicyQueryStringsConfig type is set to whitelist (the listed query strings are included) or allExcept (the listed query strings are not included, but all other query strings are).

toBuilder

public OriginRequestPolicyQueryStringsConfig.Builder 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 interface ToCopyableBuilder<OriginRequestPolicyQueryStringsConfig.Builder,OriginRequestPolicyQueryStringsConfig>

Returns:

a builder for type T

builder

public static OriginRequestPolicyQueryStringsConfig.Builder builder()

serializableBuilderClass

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

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 an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.