Package com.datastax.astra.client.model

Class FindOneOptions

java.lang.Object

com.datastax.astra.client.model.FindOneOptions

public class FindOneOptions
extends Object

List Options for a FindOne command.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FindOneOptions.Builder	Builder for creating FindOneAndUpdateOptions instances with a fluent API.

Constructor Summary

Constructors

Constructor	Description
FindOneOptions()	Default constructor.

Method Summary

Modifier and Type	Method	Description
FindOneOptions	includeSimilarity()	Fluent api.
FindOneOptions	projection(Projection... projection)	Syntax sugar as delete option is only a sort
FindOneOptions	sort(float[] vector, Sort... sorts)	Add a criteria with $vector in the sort clause
FindOneOptions	sort(Sort... sort)	Syntax sugar as delete option is only a sort
FindOneOptions	sort(String vectorize, Sort... sorts)	Add a criteria with $vectorize in the sort clause

Methods inherited from class java.lang.Object

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

Constructor Details

FindOneOptions

public FindOneOptions()

Default constructor.

Method Details

sort

public FindOneOptions sort(Sort... sort)

Syntax sugar as delete option is only a sort

Parameters:

sort - add a filter

Returns:

current command.

sort

public FindOneOptions sort(String vectorize,
 Sort... sorts)

Add a criteria with $vectorize in the sort clause

Note : This feature is under current development.

Parameters:

vectorize - an expression to look for vectorization

sorts - The sort criteria to be applied to the findOne operation.

Returns:

current command

sort

public FindOneOptions sort(float[] vector,
 Sort... sorts)

Add a criteria with $vector in the sort clause

Parameters:

vector - vector float

sorts - The sort criteria to be applied to the findOne operation.

Returns:

current command

projection

public FindOneOptions projection(Projection... projection)

Syntax sugar as delete option is only a sort

Parameters:

projection - add a filter

Returns:

current command.

includeSimilarity

public FindOneOptions includeSimilarity()

Fluent api.

Returns:

add a filter