Interface SearchResponseMetadataOrBuilder (0.1.0)

public interface SearchResponseMetadataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getIndexTypeCase()

public abstract SearchResponseMetadata.IndexTypeCase getIndexTypeCase()
Returns
Type Description
SearchResponseMetadata.IndexTypeCase

getUsedIndex()

public abstract SearchResponseMetadata.IndexInfo getUsedIndex()

Indicates that the search used a particular index.

.google.cloud.vectorsearch.v1beta.SearchResponseMetadata.IndexInfo used_index = 1;

Returns
Type Description
SearchResponseMetadata.IndexInfo

The usedIndex.

getUsedIndexOrBuilder()

public abstract SearchResponseMetadata.IndexInfoOrBuilder getUsedIndexOrBuilder()

Indicates that the search used a particular index.

.google.cloud.vectorsearch.v1beta.SearchResponseMetadata.IndexInfo used_index = 1;

Returns
Type Description
SearchResponseMetadata.IndexInfoOrBuilder

getUsedKnn()

public abstract boolean getUsedKnn()

Output only. If true, the search used the system's default K-Nearest Neighbor (KNN) index engine.

bool used_knn = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The usedKnn.

hasUsedIndex()

public abstract boolean hasUsedIndex()

Indicates that the search used a particular index.

.google.cloud.vectorsearch.v1beta.SearchResponseMetadata.IndexInfo used_index = 1;

Returns
Type Description
boolean

Whether the usedIndex field is set.

hasUsedKnn()

public abstract boolean hasUsedKnn()

Output only. If true, the search used the system's default K-Nearest Neighbor (KNN) index engine.

bool used_knn = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the usedKnn field is set.