Class SearchVectorsEnhancedRequest.Builder

java.lang.Object

software.amazon.awssdk.enhanced.dynamodb.model.SearchVectorsEnhancedRequest.Builder

Enclosing class:

SearchVectorsEnhancedRequest

@NotThreadSafe
public static final class SearchVectorsEnhancedRequest.Builder
extends Object

A builder for SearchVectorsEnhancedRequest.

Method Summary

Modifier and Type	Method	Description
SearchVectorsEnhancedRequest.Builder	addAttributeToProject(String attributeToProject)	Adds a single attribute name to be retrieved from the database.
SearchVectorsEnhancedRequest.Builder	addNestedAttributesToProject(Collection<NestedAttributeName> nestedAttributeNames)
SearchVectorsEnhancedRequest.Builder	addNestedAttributesToProject(NestedAttributeName... nestedAttributeNames)
SearchVectorsEnhancedRequest.Builder	addNestedAttributeToProject(NestedAttributeName nestedAttributeName)
SearchVectorsEnhancedRequest.Builder	attributesToProject(String... attributesToProject)	Sets one or more attribute names to be retrieved from the database.
SearchVectorsEnhancedRequest.Builder	attributesToProject(Collection<String> attributesToProject)	Sets a collection of attribute names to be retrieved from the database.
SearchVectorsEnhancedRequest	build()
SearchVectorsEnhancedRequest.Builder	returnConsumedCapacity(String returnConsumedCapacity)
SearchVectorsEnhancedRequest.Builder	returnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
SearchVectorsEnhancedRequest.Builder	searchConditionExpression(Expression searchConditionExpression)
SearchVectorsEnhancedRequest.Builder	searchVector(float[] searchVector)	Sets the query embedding as a float[] (canonical representation).
SearchVectorsEnhancedRequest.Builder	searchVector(List<Float> searchVector)	Sets the query embedding from a list of Float values.
SearchVectorsEnhancedRequest.Builder	topK(int topK)
SearchVectorsEnhancedRequest.Builder	topK(Integer topK)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

searchVector

public SearchVectorsEnhancedRequest.Builder searchVector(float[] searchVector)

Sets the query embedding as a float[] (canonical representation).

searchVector

public SearchVectorsEnhancedRequest.Builder searchVector(List<Float> searchVector)

Sets the query embedding from a list of Float values.

topK

public SearchVectorsEnhancedRequest.Builder topK(Integer topK)

topK

public SearchVectorsEnhancedRequest.Builder topK(int topK)

searchConditionExpression

public SearchVectorsEnhancedRequest.Builder searchConditionExpression(Expression searchConditionExpression)

attributesToProject

public SearchVectorsEnhancedRequest.Builder attributesToProject(Collection<String> attributesToProject)

Sets a collection of attribute names to be retrieved from the database. These attributes can include scalars, sets, or elements of a JSON document.

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

If there are nested attributes, use any of the addNestedAttributesToProject methods, such as addNestedAttributesToProject(NestedAttributeName...).

Parameters:

attributesToProject - A collection of the attributes names to be retrieved from the database.

Returns:

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

attributesToProject

public SearchVectorsEnhancedRequest.Builder attributesToProject(String... attributesToProject)

Sets one or more attribute names to be retrieved from the database. These attributes can include scalars, sets, or elements of a JSON document.

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

If there are nested attributes, use any of the addNestedAttributesToProject methods, such as addNestedAttributesToProject(NestedAttributeName...).

Parameters:

attributesToProject - One or more attributes names to be retrieved from the database.

Returns:

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

addAttributeToProject

public SearchVectorsEnhancedRequest.Builder addAttributeToProject(String attributeToProject)

Adds a single attribute name to be retrieved from the database. The attribute can include scalars, sets, or elements of a JSON document.

If there are nested attributes, use any of the addNestedAttributesToProject methods, such as addNestedAttributesToProject(NestedAttributeName...).

Parameters:

attributeToProject - An additional single attribute name to be retrieved from the database.

Returns:

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

addNestedAttributeToProject

public SearchVectorsEnhancedRequest.Builder addNestedAttributeToProject(NestedAttributeName nestedAttributeName)

addNestedAttributesToProject

public SearchVectorsEnhancedRequest.Builder addNestedAttributesToProject(NestedAttributeName... nestedAttributeNames)

addNestedAttributesToProject

public SearchVectorsEnhancedRequest.Builder addNestedAttributesToProject(Collection<NestedAttributeName> nestedAttributeNames)

returnConsumedCapacity

public SearchVectorsEnhancedRequest.Builder returnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)

returnConsumedCapacity

public SearchVectorsEnhancedRequest.Builder returnConsumedCapacity(String returnConsumedCapacity)

build

public SearchVectorsEnhancedRequest build()