com.amazonaws.services.bedrockagentruntime.model

Class RetrievalFilter

java.lang.Object

com.amazonaws.services.bedrockagentruntime.model.RetrievalFilter

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results. For more information, see Query configurations. See the examples below to see how to use these filters.

This data type is used in the following API operations:

• Retrieve request – in the filter field

• RetrieveAndGenerate request – in the filter field

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
RetrievalFilter()

Method Summary

Modifier and Type	Method and Description
RetrievalFilter	clone()
boolean	equals(Object obj)
List<RetrievalFilter>	getAndAll() Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.
List<RetrievalFilter>	getOrAll() Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAndAll(Collection<RetrievalFilter> andAll) Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.
void	setOrAll(Collection<RetrievalFilter> orAll) Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.
String	toString() Returns a string representation of this object.
RetrievalFilter	withAndAll(Collection<RetrievalFilter> andAll) Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.
RetrievalFilter	withAndAll(RetrievalFilter... andAll) Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.
RetrievalFilter	withOrAll(Collection<RetrievalFilter> orAll) Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.
RetrievalFilter	withOrAll(RetrievalFilter... orAll) Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RetrievalFilter

public RetrievalFilter()

Method Detail

getAndAll

public List<RetrievalFilter> getAndAll()

Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.

Returns:

Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.

setAndAll

public void setAndAll(Collection<RetrievalFilter> andAll)

Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.

Parameters:

andAll - Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.

withAndAll

public RetrievalFilter withAndAll(RetrievalFilter... andAll)

Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.

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

Parameters:

andAll - Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.

Returns:

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

withAndAll

public RetrievalFilter withAndAll(Collection<RetrievalFilter> andAll)

Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.

Parameters:

andAll - Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.

Returns:

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

getOrAll

public List<RetrievalFilter> getOrAll()

Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.

Returns:

Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.

setOrAll

public void setOrAll(Collection<RetrievalFilter> orAll)

Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.

Parameters:

orAll - Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.

withOrAll

public RetrievalFilter withOrAll(RetrievalFilter... orAll)

Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.

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

Parameters:

orAll - Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.

Returns:

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

withOrAll

public RetrievalFilter withOrAll(Collection<RetrievalFilter> orAll)

Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.

Parameters:

orAll - Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.

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 RetrievalFilter 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.