Headers (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cloudfront.model.Headers

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Headers
extends Object
implements Serializable, Cloneable
```
A complex type that specifies the request headers, if any, that you want CloudFront to base caching on for this cache behavior.

For the headers that you specify, CloudFront caches separate versions of a specified object 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 CloudFront to cache your content based on values in the product header. CloudFront forwards the product header to the origin and caches the response from the origin once for each header value. For more information about caching based on header values, see How CloudFront Forwards and Caches Headers in the Amazon CloudFront Developer Guide.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Headers()

Constructors
Constructor and Description
`Headers()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Headers`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getItems()` A list that contains one `Name` element for each header that you want CloudFront to use for caching in this cache behavior.
`Integer`	`getQuantity()` The number of different headers that you want CloudFront to base caching on for this cache behavior.
`int`	`hashCode()`
`void`	`setItems(Collection<String> items)` A list that contains one `Name` element for each header that you want CloudFront to use for caching in this cache behavior.
`void`	`setQuantity(Integer quantity)` The number of different headers that you want CloudFront to base caching on for this cache behavior.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Headers`	`withItems(Collection<String> items)` A list that contains one `Name` element for each header that you want CloudFront to use for caching in this cache behavior.
`Headers`	`withItems(String... items)` A list that contains one `Name` element for each header that you want CloudFront to use for caching in this cache behavior.
`Headers`	`withQuantity(Integer quantity)` The number of different headers that you want CloudFront to base caching on for this cache behavior.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Headers
```
public Headers()
```
- Method Detail
  - setQuantity
```
public void setQuantity(Integer quantity)
```
    The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:
    - Forward all headers to your origin: Specify 1 for Quantity and * for Name.
      
      CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin.
    - Forward a whitelist of headers you specify: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in Name elements. CloudFront caches your objects based on the values in the specified headers.
    - Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.
    Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:
    - S3 bucket: See HTTP Request Headers That CloudFront Removes or Updates
    - Custom origin: See HTTP Request Headers and CloudFront Behavior
    Parameters:
    quantity - The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:
    
    Forward all headers to your origin: Specify 1 for Quantity and * for Name.
    
    CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin.
    
    Forward a whitelist of headers you specify: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in Name elements. CloudFront caches your objects based on the values in the specified headers.
    
    Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.
    
    Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:
    
    S3 bucket: See HTTP Request Headers That CloudFront Removes or Updates
    
    Custom origin: See HTTP Request Headers and CloudFront Behavior
  - getQuantity
```
public Integer getQuantity()
```
    The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:
    - Forward all headers to your origin: Specify 1 for Quantity and * for Name.
      
      CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin.
    - Forward a whitelist of headers you specify: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in Name elements. CloudFront caches your objects based on the values in the specified headers.
    - Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.
    Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:
    - S3 bucket: See HTTP Request Headers That CloudFront Removes or Updates
    - Custom origin: See HTTP Request Headers and CloudFront Behavior
    Returns:
    The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:
    
    Forward all headers to your origin: Specify 1 for Quantity and * for Name.
    
    CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin.
    
    Forward a whitelist of headers you specify: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in Name elements. CloudFront caches your objects based on the values in the specified headers.
    
    Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.
    
    Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:
    
    S3 bucket: See HTTP Request Headers That CloudFront Removes or Updates
    
    Custom origin: See HTTP Request Headers and CloudFront Behavior
  - withQuantity
```
public Headers withQuantity(Integer quantity)
```
    The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:
    - Forward all headers to your origin: Specify 1 for Quantity and * for Name.
      
      CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin.
    - Forward a whitelist of headers you specify: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in Name elements. CloudFront caches your objects based on the values in the specified headers.
    - Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.
    Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:
    - S3 bucket: See HTTP Request Headers That CloudFront Removes or Updates
    - Custom origin: See HTTP Request Headers and CloudFront Behavior
    Parameters:
    quantity - The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:
    
    Forward all headers to your origin: Specify 1 for Quantity and * for Name.
    
    CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin.
    
    Forward a whitelist of headers you specify: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in Name elements. CloudFront caches your objects based on the values in the specified headers.
    
    Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.
    
    Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:
    
    S3 bucket: See HTTP Request Headers That CloudFront Removes or Updates
    
    Custom origin: See HTTP Request Headers and CloudFront Behavior
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getItems
```
public List<String> getItems()
```
    A list that contains one Name element for each header that you want CloudFront to use for caching in this cache behavior. If Quantity is 0, omit Items.
    
    Returns:
    
    A list that contains one Name element for each header that you want CloudFront to use for caching in this cache behavior. If Quantity is 0, omit Items.
  - setItems
```
public void setItems(Collection<String> items)
```
    A list that contains one Name element for each header that you want CloudFront to use for caching in this cache behavior. If Quantity is 0, omit Items.
    
    Parameters:
    
    items - A list that contains one Name element for each header that you want CloudFront to use for caching in this cache behavior. If Quantity is 0, omit Items.
  - withItems
```
public Headers withItems(String... items)
```
    A list that contains one Name element for each header that you want CloudFront to use for caching in this cache behavior. If Quantity is 0, omit Items.
    
    NOTE: This method appends the values to the existing list (if any). Use setItems(java.util.Collection) or withItems(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    items - A list that contains one Name element for each header that you want CloudFront to use for caching in this cache behavior. If Quantity is 0, omit Items.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withItems
```
public Headers withItems(Collection<String> items)
```
    A list that contains one Name element for each header that you want CloudFront to use for caching in this cache behavior. If Quantity is 0, omit Items.
    
    Parameters:
    
    items - A list that contains one Name element for each header that you want CloudFront to use for caching in this cache behavior. If Quantity is 0, omit Items.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    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 Headers clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class Headers

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Headers

Method Detail

setQuantity

getQuantity

withQuantity

getItems

setItems

withItems

withItems

toString

equals

hashCode

clone