com.amazonaws.services.lightsail.model

Class HeaderObject

java.lang.Object

com.amazonaws.services.lightsail.model.HeaderObject

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class HeaderObject
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
HeaderObject()

Method Summary

Modifier and Type	Method and Description
HeaderObject	clone()
boolean	equals(Object obj)
List<String>	getHeadersAllowList() The specific headers to forward to your distribution's origin.
String	getOption() The headers that you want your distribution to forward to your origin and base caching on.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setHeadersAllowList(Collection<String> headersAllowList) The specific headers to forward to your distribution's origin.
void	setOption(String option) The headers that you want your distribution to forward to your origin and base caching on.
String	toString() Returns a string representation of this object.
HeaderObject	withHeadersAllowList(Collection<String> headersAllowList) The specific headers to forward to your distribution's origin.
HeaderObject	withHeadersAllowList(HeaderEnum... headersAllowList) The specific headers to forward to your distribution's origin.
HeaderObject	withHeadersAllowList(String... headersAllowList) The specific headers to forward to your distribution's origin.
HeaderObject	withOption(ForwardValues option) The headers that you want your distribution to forward to your origin and base caching on.
HeaderObject	withOption(String option) The headers that you want your distribution to forward to your origin and base caching on.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HeaderObject

public HeaderObject()

Method Detail

setOption

public void setOption(String 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 the headersAllowList parameter.

Parameters:

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 the headersAllowList parameter.

See Also:

ForwardValues

getOption

public String getOption()

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 the headersAllowList parameter.

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 the headersAllowList parameter.

See Also:

ForwardValues

withOption

public HeaderObject withOption(String 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 the headersAllowList parameter.

Parameters:

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 the headersAllowList parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ForwardValues

withOption

public HeaderObject withOption(ForwardValues 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 the headersAllowList parameter.

Parameters:

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 the headersAllowList parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ForwardValues

getHeadersAllowList

public List<String> getHeadersAllowList()

The specific headers to forward to your distribution's origin.

Returns:

The specific headers to forward to your distribution's origin.

See Also:

HeaderEnum

setHeadersAllowList

public void setHeadersAllowList(Collection<String> headersAllowList)

The specific headers to forward to your distribution's origin.

Parameters:

headersAllowList - The specific headers to forward to your distribution's origin.

See Also:

HeaderEnum

withHeadersAllowList

public HeaderObject withHeadersAllowList(String... headersAllowList)

The specific headers to forward to your distribution's origin.

NOTE: This method appends the values to the existing list (if any). Use setHeadersAllowList(java.util.Collection) or withHeadersAllowList(java.util.Collection) if you want to override the existing values.

Parameters:

headersAllowList - The specific headers to forward to your distribution's origin.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HeaderEnum

withHeadersAllowList

public HeaderObject withHeadersAllowList(Collection<String> headersAllowList)

The specific headers to forward to your distribution's origin.

Parameters:

headersAllowList - The specific headers to forward to your distribution's origin.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HeaderEnum

withHeadersAllowList

public HeaderObject withHeadersAllowList(HeaderEnum... headersAllowList)

The specific headers to forward to your distribution's origin.

Parameters:

headersAllowList - The specific headers to forward to your distribution's origin.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HeaderEnum

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public HeaderObject clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.