AttributeFilter (AWS Java SDK for AWSKendraFrontend 1.11.755 API)

java.lang.Object
- com.amazonaws.services.kendra.model.AttributeFilter

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AttributeFilter
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides filtering the query results based on document attributes.

When you use the AndAllFilters or OrAllFilters, filters you can use a total of 3 layers. For example, you can use:
1. <AndAllFilters>
2. <OrAllFilters>
3. <EqualTo>
See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AttributeFilter()

Constructors
Constructor and Description
`AttributeFilter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AttributeFilter`	`clone()`
`boolean`	`equals(Object obj)`
`List<AttributeFilter>`	`getAndAllFilters()` Performs a logical `AND` operation on all supplied filters.
`DocumentAttribute`	`getContainsAll()` Returns true when a document contains all of the specified document attributes.
`DocumentAttribute`	`getContainsAny()` Returns true when a document contains any of the specified document attributes.
`DocumentAttribute`	`getEqualsTo()` Performs an equals operation on two document attributes.
`DocumentAttribute`	`getGreaterThan()` Performs a greater than operation on two document attributes.
`DocumentAttribute`	`getGreaterThanOrEquals()` Performs a greater or equals than operation on two document attributes.
`DocumentAttribute`	`getLessThan()` Performs a less than operation on two document attributes.
`DocumentAttribute`	`getLessThanOrEquals()` Performs a less than or equals operation on two document attributes.
`AttributeFilter`	`getNotFilter()` Performs a logical `NOT` operation on all supplied filters.
`List<AttributeFilter>`	`getOrAllFilters()` Performs a logical `OR` operation on all supplied filters.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setAndAllFilters(Collection<AttributeFilter> andAllFilters)` Performs a logical `AND` operation on all supplied filters.
`void`	`setContainsAll(DocumentAttribute containsAll)` Returns true when a document contains all of the specified document attributes.
`void`	`setContainsAny(DocumentAttribute containsAny)` Returns true when a document contains any of the specified document attributes.
`void`	`setEqualsTo(DocumentAttribute equalsTo)` Performs an equals operation on two document attributes.
`void`	`setGreaterThan(DocumentAttribute greaterThan)` Performs a greater than operation on two document attributes.
`void`	`setGreaterThanOrEquals(DocumentAttribute greaterThanOrEquals)` Performs a greater or equals than operation on two document attributes.
`void`	`setLessThan(DocumentAttribute lessThan)` Performs a less than operation on two document attributes.
`void`	`setLessThanOrEquals(DocumentAttribute lessThanOrEquals)` Performs a less than or equals operation on two document attributes.
`void`	`setNotFilter(AttributeFilter notFilter)` Performs a logical `NOT` operation on all supplied filters.
`void`	`setOrAllFilters(Collection<AttributeFilter> orAllFilters)` Performs a logical `OR` operation on all supplied filters.
`String`	`toString()` Returns a string representation of this object.
`AttributeFilter`	`withAndAllFilters(AttributeFilter... andAllFilters)` Performs a logical `AND` operation on all supplied filters.
`AttributeFilter`	`withAndAllFilters(Collection<AttributeFilter> andAllFilters)` Performs a logical `AND` operation on all supplied filters.
`AttributeFilter`	`withContainsAll(DocumentAttribute containsAll)` Returns true when a document contains all of the specified document attributes.
`AttributeFilter`	`withContainsAny(DocumentAttribute containsAny)` Returns true when a document contains any of the specified document attributes.
`AttributeFilter`	`withEqualsTo(DocumentAttribute equalsTo)` Performs an equals operation on two document attributes.
`AttributeFilter`	`withGreaterThan(DocumentAttribute greaterThan)` Performs a greater than operation on two document attributes.
`AttributeFilter`	`withGreaterThanOrEquals(DocumentAttribute greaterThanOrEquals)` Performs a greater or equals than operation on two document attributes.
`AttributeFilter`	`withLessThan(DocumentAttribute lessThan)` Performs a less than operation on two document attributes.
`AttributeFilter`	`withLessThanOrEquals(DocumentAttribute lessThanOrEquals)` Performs a less than or equals operation on two document attributes.
`AttributeFilter`	`withNotFilter(AttributeFilter notFilter)` Performs a logical `NOT` operation on all supplied filters.
`AttributeFilter`	`withOrAllFilters(AttributeFilter... orAllFilters)` Performs a logical `OR` operation on all supplied filters.
`AttributeFilter`	`withOrAllFilters(Collection<AttributeFilter> orAllFilters)` Performs a logical `OR` operation on all supplied filters.

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

- Constructor Detail
  - AttributeFilter
```
public AttributeFilter()
```
- Method Detail
  - getAndAllFilters
```
public List<AttributeFilter> getAndAllFilters()
```
    Performs a logical AND operation on all supplied filters.
    
    Returns:
    
    Performs a logical AND operation on all supplied filters.
  - setAndAllFilters
```
public void setAndAllFilters(Collection<AttributeFilter> andAllFilters)
```
    Performs a logical AND operation on all supplied filters.
    
    Parameters:
    
    andAllFilters - Performs a logical AND operation on all supplied filters.
  - withAndAllFilters
```
public AttributeFilter withAndAllFilters(AttributeFilter... andAllFilters)
```
    Performs a logical AND operation on all supplied filters.
    
    NOTE: This method appends the values to the existing list (if any). Use setAndAllFilters(java.util.Collection) or withAndAllFilters(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    andAllFilters - Performs a logical AND operation on all supplied filters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAndAllFilters
```
public AttributeFilter withAndAllFilters(Collection<AttributeFilter> andAllFilters)
```
    Performs a logical AND operation on all supplied filters.
    
    Parameters:
    
    andAllFilters - Performs a logical AND operation on all supplied filters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getOrAllFilters
```
public List<AttributeFilter> getOrAllFilters()
```
    Performs a logical OR operation on all supplied filters.
    
    Returns:
    
    Performs a logical OR operation on all supplied filters.
  - setOrAllFilters
```
public void setOrAllFilters(Collection<AttributeFilter> orAllFilters)
```
    Performs a logical OR operation on all supplied filters.
    
    Parameters:
    
    orAllFilters - Performs a logical OR operation on all supplied filters.
  - withOrAllFilters
```
public AttributeFilter withOrAllFilters(AttributeFilter... orAllFilters)
```
    Performs a logical OR operation on all supplied filters.
    
    NOTE: This method appends the values to the existing list (if any). Use setOrAllFilters(java.util.Collection) or withOrAllFilters(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    orAllFilters - Performs a logical OR operation on all supplied filters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withOrAllFilters
```
public AttributeFilter withOrAllFilters(Collection<AttributeFilter> orAllFilters)
```
    Performs a logical OR operation on all supplied filters.
    
    Parameters:
    
    orAllFilters - Performs a logical OR operation on all supplied filters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNotFilter
```
public void setNotFilter(AttributeFilter notFilter)
```
    Performs a logical NOT operation on all supplied filters.
    
    Parameters:
    
    notFilter - Performs a logical NOT operation on all supplied filters.
  - getNotFilter
```
public AttributeFilter getNotFilter()
```
    Performs a logical NOT operation on all supplied filters.
    
    Returns:
    
    Performs a logical NOT operation on all supplied filters.
  - withNotFilter
```
public AttributeFilter withNotFilter(AttributeFilter notFilter)
```
    Performs a logical NOT operation on all supplied filters.
    
    Parameters:
    
    notFilter - Performs a logical NOT operation on all supplied filters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEqualsTo
```
public void setEqualsTo(DocumentAttribute equalsTo)
```
    Performs an equals operation on two document attributes.
    
    Parameters:
    
    equalsTo - Performs an equals operation on two document attributes.
  - getEqualsTo
```
public DocumentAttribute getEqualsTo()
```
    Performs an equals operation on two document attributes.
    
    Returns:
    
    Performs an equals operation on two document attributes.
  - withEqualsTo
```
public AttributeFilter withEqualsTo(DocumentAttribute equalsTo)
```
    Performs an equals operation on two document attributes.
    
    Parameters:
    
    equalsTo - Performs an equals operation on two document attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setContainsAll
```
public void setContainsAll(DocumentAttribute containsAll)
```
    Returns true when a document contains all of the specified document attributes.
    
    Parameters:
    
    containsAll - Returns true when a document contains all of the specified document attributes.
  - getContainsAll
```
public DocumentAttribute getContainsAll()
```
    Returns true when a document contains all of the specified document attributes.
    
    Returns:
    
    Returns true when a document contains all of the specified document attributes.
  - withContainsAll
```
public AttributeFilter withContainsAll(DocumentAttribute containsAll)
```
    Returns true when a document contains all of the specified document attributes.
    
    Parameters:
    
    containsAll - Returns true when a document contains all of the specified document attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setContainsAny
```
public void setContainsAny(DocumentAttribute containsAny)
```
    Returns true when a document contains any of the specified document attributes.
    
    Parameters:
    
    containsAny - Returns true when a document contains any of the specified document attributes.
  - getContainsAny
```
public DocumentAttribute getContainsAny()
```
    Returns true when a document contains any of the specified document attributes.
    
    Returns:
    
    Returns true when a document contains any of the specified document attributes.
  - withContainsAny
```
public AttributeFilter withContainsAny(DocumentAttribute containsAny)
```
    Returns true when a document contains any of the specified document attributes.
    
    Parameters:
    
    containsAny - Returns true when a document contains any of the specified document attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGreaterThan
```
public void setGreaterThan(DocumentAttribute greaterThan)
```
    Performs a greater than operation on two document attributes. Use with a document attribute of type Integer or Long.
    
    Parameters:
    
    greaterThan - Performs a greater than operation on two document attributes. Use with a document attribute of type Integer or Long.
  - getGreaterThan
```
public DocumentAttribute getGreaterThan()
```
    Performs a greater than operation on two document attributes. Use with a document attribute of type Integer or Long.
    
    Returns:
    
    Performs a greater than operation on two document attributes. Use with a document attribute of type Integer or Long.
  - withGreaterThan
```
public AttributeFilter withGreaterThan(DocumentAttribute greaterThan)
```
    Performs a greater than operation on two document attributes. Use with a document attribute of type Integer or Long.
    
    Parameters:
    
    greaterThan - Performs a greater than operation on two document attributes. Use with a document attribute of type Integer or Long.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGreaterThanOrEquals
```
public void setGreaterThanOrEquals(DocumentAttribute greaterThanOrEquals)
```
    Performs a greater or equals than operation on two document attributes. Use with a document attribute of type Integer or Long.
    
    Parameters:
    
    greaterThanOrEquals - Performs a greater or equals than operation on two document attributes. Use with a document attribute of type Integer or Long.
  - getGreaterThanOrEquals
```
public DocumentAttribute getGreaterThanOrEquals()
```
    Performs a greater or equals than operation on two document attributes. Use with a document attribute of type Integer or Long.
    
    Returns:
    
    Performs a greater or equals than operation on two document attributes. Use with a document attribute of type Integer or Long.
  - withGreaterThanOrEquals
```
public AttributeFilter withGreaterThanOrEquals(DocumentAttribute greaterThanOrEquals)
```
    Performs a greater or equals than operation on two document attributes. Use with a document attribute of type Integer or Long.
    
    Parameters:
    
    greaterThanOrEquals - Performs a greater or equals than operation on two document attributes. Use with a document attribute of type Integer or Long.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLessThan
```
public void setLessThan(DocumentAttribute lessThan)
```
    Performs a less than operation on two document attributes. Use with a document attribute of type Integer or Long.
    
    Parameters:
    
    lessThan - Performs a less than operation on two document attributes. Use with a document attribute of type Integer or Long.
  - getLessThan
```
public DocumentAttribute getLessThan()
```
    Performs a less than operation on two document attributes. Use with a document attribute of type Integer or Long.
    
    Returns:
    
    Performs a less than operation on two document attributes. Use with a document attribute of type Integer or Long.
  - withLessThan
```
public AttributeFilter withLessThan(DocumentAttribute lessThan)
```
    Performs a less than operation on two document attributes. Use with a document attribute of type Integer or Long.
    
    Parameters:
    
    lessThan - Performs a less than operation on two document attributes. Use with a document attribute of type Integer or Long.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLessThanOrEquals
```
public void setLessThanOrEquals(DocumentAttribute lessThanOrEquals)
```
    Performs a less than or equals operation on two document attributes. Use with a document attribute of type Integer or Long.
    
    Parameters:
    
    lessThanOrEquals - Performs a less than or equals operation on two document attributes. Use with a document attribute of type Integer or Long.
  - getLessThanOrEquals
```
public DocumentAttribute getLessThanOrEquals()
```
    Performs a less than or equals operation on two document attributes. Use with a document attribute of type Integer or Long.
    
    Returns:
    
    Performs a less than or equals operation on two document attributes. Use with a document attribute of type Integer or Long.
  - withLessThanOrEquals
```
public AttributeFilter withLessThanOrEquals(DocumentAttribute lessThanOrEquals)
```
    Performs a less than or equals operation on two document attributes. Use with a document attribute of type Integer or Long.
    
    Parameters:
    
    lessThanOrEquals - Performs a less than or equals operation on two document attributes. Use with a document attribute of type Integer or Long.
    
    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 AttributeFilter clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class AttributeFilter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AttributeFilter

Method Detail

getAndAllFilters

setAndAllFilters

withAndAllFilters

withAndAllFilters

getOrAllFilters

setOrAllFilters

withOrAllFilters

withOrAllFilters

setNotFilter

getNotFilter

withNotFilter

setEqualsTo

getEqualsTo

withEqualsTo

setContainsAll

getContainsAll

withContainsAll

setContainsAny

getContainsAny

withContainsAny

setGreaterThan

getGreaterThan

withGreaterThan

setGreaterThanOrEquals

getGreaterThanOrEquals

withGreaterThanOrEquals

setLessThan

getLessThan

withLessThan

setLessThanOrEquals

getLessThanOrEquals

withLessThanOrEquals

toString

equals

hashCode

clone

marshall