CookieMatchPattern (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.wafv2.model.CookieMatchPattern

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CookieMatchPattern
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The filter to use to identify the subset of cookies to inspect in a web request.

You must specify exactly one setting: either All, IncludedCookies, or ExcludedCookies.

Example JSON: "MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] }

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CookieMatchPattern()

Constructors
Constructor and Description
`CookieMatchPattern()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CookieMatchPattern`	`clone()`
`boolean`	`equals(Object obj)`
`All`	`getAll()` Inspect all cookies.
`List<String>`	`getExcludedCookies()` Inspect only the cookies whose keys don't match any of the strings specified here.
`List<String>`	`getIncludedCookies()` Inspect only the cookies that have a key that matches one of the strings specified here.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAll(All all)` Inspect all cookies.
`void`	`setExcludedCookies(Collection<String> excludedCookies)` Inspect only the cookies whose keys don't match any of the strings specified here.
`void`	`setIncludedCookies(Collection<String> includedCookies)` Inspect only the cookies that have a key that matches one of the strings specified here.
`String`	`toString()` Returns a string representation of this object.
`CookieMatchPattern`	`withAll(All all)` Inspect all cookies.
`CookieMatchPattern`	`withExcludedCookies(Collection<String> excludedCookies)` Inspect only the cookies whose keys don't match any of the strings specified here.
`CookieMatchPattern`	`withExcludedCookies(String... excludedCookies)` Inspect only the cookies whose keys don't match any of the strings specified here.
`CookieMatchPattern`	`withIncludedCookies(Collection<String> includedCookies)` Inspect only the cookies that have a key that matches one of the strings specified here.
`CookieMatchPattern`	`withIncludedCookies(String... includedCookies)` Inspect only the cookies that have a key that matches one of the strings specified here.

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

- Constructor Detail
  - CookieMatchPattern
```
public CookieMatchPattern()
```
- Method Detail
  - setAll
```
public void setAll(All all)
```
    Inspect all cookies.
    
    Parameters:
    
    all - Inspect all cookies.
  - getAll
```
public All getAll()
```
    Inspect all cookies.
    
    Returns:
    
    Inspect all cookies.
  - withAll
```
public CookieMatchPattern withAll(All all)
```
    Inspect all cookies.
    
    Parameters:
    
    all - Inspect all cookies.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getIncludedCookies
```
public List<String> getIncludedCookies()
```
    Inspect only the cookies that have a key that matches one of the strings specified here.
    
    Returns:
    
    Inspect only the cookies that have a key that matches one of the strings specified here.
  - setIncludedCookies
```
public void setIncludedCookies(Collection<String> includedCookies)
```
    Inspect only the cookies that have a key that matches one of the strings specified here.
    
    Parameters:
    
    includedCookies - Inspect only the cookies that have a key that matches one of the strings specified here.
  - withIncludedCookies
```
public CookieMatchPattern withIncludedCookies(String... includedCookies)
```
    Inspect only the cookies that have a key that matches one of the strings specified here.
    
    NOTE: This method appends the values to the existing list (if any). Use setIncludedCookies(java.util.Collection) or withIncludedCookies(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    includedCookies - Inspect only the cookies that have a key that matches one of the strings specified here.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withIncludedCookies
```
public CookieMatchPattern withIncludedCookies(Collection<String> includedCookies)
```
    Inspect only the cookies that have a key that matches one of the strings specified here.
    
    Parameters:
    
    includedCookies - Inspect only the cookies that have a key that matches one of the strings specified here.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExcludedCookies
```
public List<String> getExcludedCookies()
```
    Inspect only the cookies whose keys don't match any of the strings specified here.
    
    Returns:
    
    Inspect only the cookies whose keys don't match any of the strings specified here.
  - setExcludedCookies
```
public void setExcludedCookies(Collection<String> excludedCookies)
```
    Inspect only the cookies whose keys don't match any of the strings specified here.
    
    Parameters:
    
    excludedCookies - Inspect only the cookies whose keys don't match any of the strings specified here.
  - withExcludedCookies
```
public CookieMatchPattern withExcludedCookies(String... excludedCookies)
```
    Inspect only the cookies whose keys don't match any of the strings specified here.
    
    NOTE: This method appends the values to the existing list (if any). Use setExcludedCookies(java.util.Collection) or withExcludedCookies(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    excludedCookies - Inspect only the cookies whose keys don't match any of the strings specified here.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withExcludedCookies
```
public CookieMatchPattern withExcludedCookies(Collection<String> excludedCookies)
```
    Inspect only the cookies whose keys don't match any of the strings specified here.
    
    Parameters:
    
    excludedCookies - Inspect only the cookies whose keys don't match any of the strings specified here.
    
    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. 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 CookieMatchPattern 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.

AWS SDK for Java 1.x API Reference - 1.12.779

Class CookieMatchPattern

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CookieMatchPattern

Method Detail

setAll

getAll

withAll

getIncludedCookies

setIncludedCookies

withIncludedCookies

withIncludedCookies

getExcludedCookies

setExcludedCookies

withExcludedCookies

withExcludedCookies

toString

equals

hashCode

clone

marshall