com.couchbase.client.java.search.vector

Enum VectorQueryCombination

java.lang.Object

java.lang.Enum<VectorQueryCombination>

com.couchbase.client.java.search.vector.VectorQueryCombination

All Implemented Interfaces:

Serializable, Comparable<VectorQueryCombination>

public enum VectorQueryCombination
extends Enum<VectorQueryCombination>

Controls how multiple vector queries are combined.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AND All vector queries must match a document for it to be included.
OR Any vector query may match a document for it to be included.

Method Summary

Modifier and Type	Method and Description
com.couchbase.client.core.api.search.vector.CoreVectorQueryCombination	toCore()
static VectorQueryCombination	valueOf(String name) Returns the enum constant of this type with the specified name.
static VectorQueryCombination[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AND

public static final VectorQueryCombination AND

All vector queries must match a document for it to be included.

OR

public static final VectorQueryCombination OR

Any vector query may match a document for it to be included.

Method Detail

values

public static VectorQueryCombination[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (VectorQueryCombination c : VectorQueryCombination.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static VectorQueryCombination valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toCore

@Stability.Internal
public com.couchbase.client.core.api.search.vector.CoreVectorQueryCombination toCore()