java.lang.Object
- software.amazon.awssdk.services.bedrockagentruntime.model.RetrievalFilter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RetrievalFilter.Builder,RetrievalFilter>
```
@Generated("software.amazon.awssdk:codegen")
public final class RetrievalFilter
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RetrievalFilter.Builder,RetrievalFilter>
```
Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results. For more information, see Query configurations.

This data type is used in the following API operations:
- Retrieve request – in the filter field
- RetrieveAndGenerate request – in the filter field
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface RetrievalFilter.Builder

static class RetrievalFilter.Type

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<RetrievalFilter>`	`andAll()`	Knowledge base data sources whose metadata attributes fulfill all the filter conditions inside this list are returned.
`static RetrievalFilter.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`FilterAttribute`	`equalsValue()`	Knowledge base data sources that contain a metadata attribute whose name matches the `key` and whose value matches the `value` in this object are returned.
`static RetrievalFilter`	`fromAndAll(List<RetrievalFilter> andAll)`	Create an instance of this class with `andAll()` initialized to the given value.
`static RetrievalFilter`	`fromEqualsValue(Consumer<FilterAttribute.Builder> equalsValue)`	Create an instance of this class with `equalsValue()` initialized to the given value.
`static RetrievalFilter`	`fromEqualsValue(FilterAttribute equalsValue)`	Create an instance of this class with `equalsValue()` initialized to the given value.
`static RetrievalFilter`	`fromGreaterThan(Consumer<FilterAttribute.Builder> greaterThan)`	Create an instance of this class with `greaterThan()` initialized to the given value.
`static RetrievalFilter`	`fromGreaterThan(FilterAttribute greaterThan)`	Create an instance of this class with `greaterThan()` initialized to the given value.
`static RetrievalFilter`	`fromGreaterThanOrEquals(Consumer<FilterAttribute.Builder> greaterThanOrEquals)`	Create an instance of this class with `greaterThanOrEquals()` initialized to the given value.
`static RetrievalFilter`	`fromGreaterThanOrEquals(FilterAttribute greaterThanOrEquals)`	Create an instance of this class with `greaterThanOrEquals()` initialized to the given value.
`static RetrievalFilter`	`fromIn(Consumer<FilterAttribute.Builder> in)`	Create an instance of this class with `in()` initialized to the given value.
`static RetrievalFilter`	`fromIn(FilterAttribute in)`	Create an instance of this class with `in()` initialized to the given value.
`static RetrievalFilter`	`fromLessThan(Consumer<FilterAttribute.Builder> lessThan)`	Create an instance of this class with `lessThan()` initialized to the given value.
`static RetrievalFilter`	`fromLessThan(FilterAttribute lessThan)`	Create an instance of this class with `lessThan()` initialized to the given value.
`static RetrievalFilter`	`fromLessThanOrEquals(Consumer<FilterAttribute.Builder> lessThanOrEquals)`	Create an instance of this class with `lessThanOrEquals()` initialized to the given value.
`static RetrievalFilter`	`fromLessThanOrEquals(FilterAttribute lessThanOrEquals)`	Create an instance of this class with `lessThanOrEquals()` initialized to the given value.
`static RetrievalFilter`	`fromNotEquals(Consumer<FilterAttribute.Builder> notEquals)`	Create an instance of this class with `notEquals()` initialized to the given value.
`static RetrievalFilter`	`fromNotEquals(FilterAttribute notEquals)`	Create an instance of this class with `notEquals()` initialized to the given value.
`static RetrievalFilter`	`fromNotIn(Consumer<FilterAttribute.Builder> notIn)`	Create an instance of this class with `notIn()` initialized to the given value.
`static RetrievalFilter`	`fromNotIn(FilterAttribute notIn)`	Create an instance of this class with `notIn()` initialized to the given value.
`static RetrievalFilter`	`fromOrAll(List<RetrievalFilter> orAll)`	Create an instance of this class with `orAll()` initialized to the given value.
`static RetrievalFilter`	`fromStartsWith(Consumer<FilterAttribute.Builder> startsWith)`	Create an instance of this class with `startsWith()` initialized to the given value.
`static RetrievalFilter`	`fromStartsWith(FilterAttribute startsWith)`	Create an instance of this class with `startsWith()` initialized to the given value.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`FilterAttribute`	`greaterThan()`	Knowledge base data sources that contain a metadata attribute whose name matches the `key` and whose value is greater than the `value` in this object are returned.
`FilterAttribute`	`greaterThanOrEquals()`	Knowledge base data sources that contain a metadata attribute whose name matches the `key` and whose value is greater than or equal to the `value` in this object are returned.
`boolean`	`hasAndAll()`	For responses, this returns true if the service returned a value for the AndAll property.
`int`	`hashCode()`
`boolean`	`hasOrAll()`	For responses, this returns true if the service returned a value for the OrAll property.
`FilterAttribute`	`in()`	Knowledge base data sources that contain a metadata attribute whose name matches the `key` and whose value is in the list specified in the `value` in this object are returned.
`FilterAttribute`	`lessThan()`	Knowledge base data sources that contain a metadata attribute whose name matches the `key` and whose value is less than the `value` in this object are returned.
`FilterAttribute`	`lessThanOrEquals()`	Knowledge base data sources that contain a metadata attribute whose name matches the `key` and whose value is less than or equal to the `value` in this object are returned.
`FilterAttribute`	`notEquals()`	Knowledge base data sources that contain a metadata attribute whose name matches the `key` and whose value doesn't match the `value` in this object are returned.
`FilterAttribute`	`notIn()`	Knowledge base data sources that contain a metadata attribute whose name matches the `key` and whose value isn't in the list specified in the `value` in this object are returned.
`List<RetrievalFilter>`	`orAll()`	Knowledge base data sources whose metadata attributes fulfill at least one of the filter conditions inside this list are returned.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RetrievalFilter.Builder>`	`serializableBuilderClass()`
`FilterAttribute`	`startsWith()`	Knowledge base data sources that contain a metadata attribute whose name matches the `key` and whose value starts with the `value` in this object are returned.
`RetrievalFilter.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`RetrievalFilter.Type`	`type()`	Retrieve an enum value representing which member of this object is populated.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - hasAndAll
```
public final boolean hasAndAll()
```
    For responses, this returns true if the service returned a value for the AndAll property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.
  - andAll
```
public final List<RetrievalFilter> andAll()
```
    Knowledge base data sources whose metadata attributes fulfill all the filter conditions inside this list are returned.
    
    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 hasAndAll() method.
    
    Returns:
    
    Knowledge base data sources whose metadata attributes fulfill all the filter conditions inside this list are returned.
  - equalsValue
```
public final FilterAttribute equalsValue()
```
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value matches the value in this object are returned.
    
    Returns:
    
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value matches the value in this object are returned.
  - greaterThan
```
public final FilterAttribute greaterThan()
```
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is greater than the value in this object are returned.
    
    Returns:
    
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is greater than the value in this object are returned.
  - greaterThanOrEquals
```
public final FilterAttribute greaterThanOrEquals()
```
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object are returned.
    
    Returns:
    
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object are returned.
  - in
```
public final FilterAttribute in()
```
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object are returned.
    
    Returns:
    
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object are returned.
  - lessThan
```
public final FilterAttribute lessThan()
```
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is less than the value in this object are returned.
    
    Returns:
    
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is less than the value in this object are returned.
  - lessThanOrEquals
```
public final FilterAttribute lessThanOrEquals()
```
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object are returned.
    
    Returns:
    
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object are returned.
  - notEquals
```
public final FilterAttribute notEquals()
```
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value doesn't match the value in this object are returned.
    
    Returns:
    
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value doesn't match the value in this object are returned.
  - notIn
```
public final FilterAttribute notIn()
```
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value isn't in the list specified in the value in this object are returned.
    
    Returns:
    
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value isn't in the list specified in the value in this object are returned.
  - hasOrAll
```
public final boolean hasOrAll()
```
    For responses, this returns true if the service returned a value for the OrAll property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.
  - orAll
```
public final List<RetrievalFilter> orAll()
```
    Knowledge base data sources whose metadata attributes fulfill at least one of the filter conditions inside this list are returned.
    
    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 hasOrAll() method.
    
    Returns:
    
    Knowledge base data sources whose metadata attributes fulfill at least one of the filter conditions inside this list are returned.
  - startsWith
```
public final FilterAttribute startsWith()
```
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value starts with the value in this object are returned. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.
    
    Returns:
    
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value starts with the value in this object are returned. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.
  - toBuilder
```
public RetrievalFilter.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RetrievalFilter.Builder,RetrievalFilter>
  - builder
```
public static RetrievalFilter.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RetrievalFilter.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - fromAndAll
```
public static RetrievalFilter fromAndAll(List<RetrievalFilter> andAll)
```
    Create an instance of this class with andAll() initialized to the given value.
    Knowledge base data sources whose metadata attributes fulfill all the filter conditions inside this list are returned.
    
    Parameters:
    
    andAll - Knowledge base data sources whose metadata attributes fulfill all the filter conditions inside this list are returned.
  - fromEqualsValue
```
public static RetrievalFilter fromEqualsValue(FilterAttribute equalsValue)
```
    Create an instance of this class with equalsValue() initialized to the given value.
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value matches the value in this object are returned.
    
    Parameters:
    
    equalsValue - Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value matches the value in this object are returned.
  - fromEqualsValue
```
public static RetrievalFilter fromEqualsValue(Consumer<FilterAttribute.Builder> equalsValue)
```
    Create an instance of this class with equalsValue() initialized to the given value.
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value matches the value in this object are returned.
    
    Parameters:
    
    equalsValue - Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value matches the value in this object are returned.
  - fromGreaterThan
```
public static RetrievalFilter fromGreaterThan(FilterAttribute greaterThan)
```
    Create an instance of this class with greaterThan() initialized to the given value.
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is greater than the value in this object are returned.
    
    Parameters:
    
    greaterThan - Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is greater than the value in this object are returned.
  - fromGreaterThan
```
public static RetrievalFilter fromGreaterThan(Consumer<FilterAttribute.Builder> greaterThan)
```
    Create an instance of this class with greaterThan() initialized to the given value.
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is greater than the value in this object are returned.
    
    Parameters:
    
    greaterThan - Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is greater than the value in this object are returned.
  - fromGreaterThanOrEquals
```
public static RetrievalFilter fromGreaterThanOrEquals(FilterAttribute greaterThanOrEquals)
```
    Create an instance of this class with greaterThanOrEquals() initialized to the given value.
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object are returned.
    
    Parameters:
    
    greaterThanOrEquals - Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object are returned.
  - fromGreaterThanOrEquals
```
public static RetrievalFilter fromGreaterThanOrEquals(Consumer<FilterAttribute.Builder> greaterThanOrEquals)
```
    Create an instance of this class with greaterThanOrEquals() initialized to the given value.
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object are returned.
    
    Parameters:
    
    greaterThanOrEquals - Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object are returned.
  - fromIn
```
public static RetrievalFilter fromIn(FilterAttribute in)
```
    Create an instance of this class with in() initialized to the given value.
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object are returned.
    
    Parameters:
    
    in - Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object are returned.
  - fromIn
```
public static RetrievalFilter fromIn(Consumer<FilterAttribute.Builder> in)
```
    Create an instance of this class with in() initialized to the given value.
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object are returned.
    
    Parameters:
    
    in - Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object are returned.
  - fromLessThan
```
public static RetrievalFilter fromLessThan(FilterAttribute lessThan)
```
    Create an instance of this class with lessThan() initialized to the given value.
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is less than the value in this object are returned.
    
    Parameters:
    
    lessThan - Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is less than the value in this object are returned.
  - fromLessThan
```
public static RetrievalFilter fromLessThan(Consumer<FilterAttribute.Builder> lessThan)
```
    Create an instance of this class with lessThan() initialized to the given value.
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is less than the value in this object are returned.
    
    Parameters:
    
    lessThan - Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is less than the value in this object are returned.
  - fromLessThanOrEquals
```
public static RetrievalFilter fromLessThanOrEquals(FilterAttribute lessThanOrEquals)
```
    Create an instance of this class with lessThanOrEquals() initialized to the given value.
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object are returned.
    
    Parameters:
    
    lessThanOrEquals - Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object are returned.
  - fromLessThanOrEquals
```
public static RetrievalFilter fromLessThanOrEquals(Consumer<FilterAttribute.Builder> lessThanOrEquals)
```
    Create an instance of this class with lessThanOrEquals() initialized to the given value.
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object are returned.
    
    Parameters:
    
    lessThanOrEquals - Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object are returned.
  - fromNotEquals
```
public static RetrievalFilter fromNotEquals(FilterAttribute notEquals)
```
    Create an instance of this class with notEquals() initialized to the given value.
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value doesn't match the value in this object are returned.
    
    Parameters:
    
    notEquals - Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value doesn't match the value in this object are returned.
  - fromNotEquals
```
public static RetrievalFilter fromNotEquals(Consumer<FilterAttribute.Builder> notEquals)
```
    Create an instance of this class with notEquals() initialized to the given value.
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value doesn't match the value in this object are returned.
    
    Parameters:
    
    notEquals - Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value doesn't match the value in this object are returned.
  - fromNotIn
```
public static RetrievalFilter fromNotIn(FilterAttribute notIn)
```
    Create an instance of this class with notIn() initialized to the given value.
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value isn't in the list specified in the value in this object are returned.
    
    Parameters:
    
    notIn - Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value isn't in the list specified in the value in this object are returned.
  - fromNotIn
```
public static RetrievalFilter fromNotIn(Consumer<FilterAttribute.Builder> notIn)
```
    Create an instance of this class with notIn() initialized to the given value.
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value isn't in the list specified in the value in this object are returned.
    
    Parameters:
    
    notIn - Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value isn't in the list specified in the value in this object are returned.
  - fromOrAll
```
public static RetrievalFilter fromOrAll(List<RetrievalFilter> orAll)
```
    Create an instance of this class with orAll() initialized to the given value.
    Knowledge base data sources whose metadata attributes fulfill at least one of the filter conditions inside this list are returned.
    
    Parameters:
    
    orAll - Knowledge base data sources whose metadata attributes fulfill at least one of the filter conditions inside this list are returned.
  - fromStartsWith
```
public static RetrievalFilter fromStartsWith(FilterAttribute startsWith)
```
    Create an instance of this class with startsWith() initialized to the given value.
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value starts with the value in this object are returned. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.
    
    Parameters:
    
    startsWith - Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value starts with the value in this object are returned. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.
  - fromStartsWith
```
public static RetrievalFilter fromStartsWith(Consumer<FilterAttribute.Builder> startsWith)
```
    Create an instance of this class with startsWith() initialized to the given value.
    Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value starts with the value in this object are returned. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.
    
    Parameters:
    
    startsWith - Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value starts with the value in this object are returned. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.
  - type
```
public RetrievalFilter.Type type()
```
    Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be RetrievalFilter.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be RetrievalFilter.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Modifier and Type	Class	Description
`static interface`	`RetrievalFilter.Builder`
`static class`	`RetrievalFilter.Type`

Class RetrievalFilter

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasAndAll

andAll

equalsValue

greaterThan

greaterThanOrEquals

in

lessThan

lessThanOrEquals

notEquals

notIn

hasOrAll

orAll

startsWith

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

fromAndAll

fromEqualsValue

fromEqualsValue

fromGreaterThan

fromGreaterThan

fromGreaterThanOrEquals

fromGreaterThanOrEquals

fromIn

fromIn

fromLessThan

fromLessThan

fromLessThanOrEquals

fromLessThanOrEquals

fromNotEquals

fromNotEquals

fromNotIn

fromNotIn

fromOrAll

fromStartsWith

fromStartsWith

type

sdkFields