Package com.datastax.astra.client.model

Class FindOneOptions

java.lang.Object

com.datastax.astra.client.model.CommandOptions<FindOneOptions>

com.datastax.astra.client.model.FindOneOptions

public class FindOneOptions
extends CommandOptions<FindOneOptions>

List Options for a FindOne command.

Field Summary

Fields inherited from class com.datastax.astra.client.model.CommandOptions

embeddingAuthProvider, httpClientOptions, observers, token

Constructor Summary

Constructors

Constructor	Description
FindOneOptions()	Default constructor.

Method Summary

Modifier and Type	Method	Description
FindOneOptions	includeSimilarity()	Fluent api.
FindOneOptions	includeSortVector()	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(Document sorClause)	Syntax sugar as delete option is only a sort Could be like Map.of("$vectorize", "command, "field1", 1, "field2", -1);
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.
FindOneOptions	sort(Map<String,Object> rawSort)	Syntax sugar as delete option is only a sort Could be like Map.of("$vectorize", "command, "field1", 1, "field2", -1);

Methods inherited from class com.datastax.astra.client.model.CommandOptions

embeddingAPIKey, embeddingAuthProvider, getEmbeddingAuthProvider, getHttpClientOptions, getToken, httpClientOptions, registerObserver, registerObserver, token, unregisterObserver, unregisterObserver

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(Map<String,Object> rawSort)

Syntax sugar as delete option is only a sort Could be like Map.of("$vectorize", "command, "field1", 1, "field2", -1);

Parameters:

rawSort - raw sort clause

Returns:

current command.

sort

public FindOneOptions sort(Document sorClause)

Syntax sugar as delete option is only a sort Could be like Map.of("$vectorize", "command, "field1", 1, "field2", -1);

Parameters:

sorClause - sort clause as a document

Returns:

current command.

sort

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

Add a criteria with $vectorize in the sort clause.

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

includeSortVector

public FindOneOptions includeSortVector()

Fluent api.

Returns:

add a filter