Class HeaderObject
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<HeaderObject.Builder,
HeaderObject>
Describes the request headers that a Lightsail distribution bases caching on.
For the headers that you specify, your distribution caches separate versions of the specified content based on the
header values in viewer requests. For example, suppose viewer requests for logo.jpg
contain a custom
product
header that has a value of either acme
or apex
, and you configure your
distribution to cache your content based on values in the product
header. Your distribution forwards the
product
header to the origin and caches the response from the origin once for each header value.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic HeaderObject.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
For responses, this returns true if the service returned a value for the HeadersAllowList property.final List
<HeaderEnum> The specific headers to forward to your distribution's origin.The specific headers to forward to your distribution's origin.final ForwardValues
option()
The headers that you want your distribution to forward to your origin and base caching on.final String
The headers that you want your distribution to forward to your origin and base caching on.static Class
<? extends HeaderObject.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
The headers that you want your distribution to forward to your origin and base caching on.
You can configure your distribution to do one of the following:
-
all
- Forward all headers to your origin. -
none
- Forward only the default headers. -
allow-list
- Forward only the headers you specify using theheadersAllowList
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:
- The headers that you want your distribution to forward to your origin and base caching on.
You can configure your distribution to do one of the following:
-
all
- Forward all headers to your origin. -
none
- Forward only the default headers. -
allow-list
- Forward only the headers you specify using theheadersAllowList
parameter.
-
- See Also:
-
-
optionAsString
The headers that you want your distribution to forward to your origin and base caching on.
You can configure your distribution to do one of the following:
-
all
- Forward all headers to your origin. -
none
- Forward only the default headers. -
allow-list
- Forward only the headers you specify using theheadersAllowList
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:
- The headers that you want your distribution to forward to your origin and base caching on.
You can configure your distribution to do one of the following:
-
all
- Forward all headers to your origin. -
none
- Forward only the default headers. -
allow-list
- Forward only the headers you specify using theheadersAllowList
parameter.
-
- See Also:
-
-
headersAllowList
The specific headers 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
hasHeadersAllowList()
method.- Returns:
- The specific headers to forward to your distribution's origin.
-
hasHeadersAllowList
public final boolean hasHeadersAllowList()For responses, this returns true if the service returned a value for the HeadersAllowList 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. -
headersAllowListAsStrings
The specific headers 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
hasHeadersAllowList()
method.- Returns:
- The specific headers 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<HeaderObject.Builder,
HeaderObject> - 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
-