Package io.milvus.grpc

Interface SearchAggregationSpecOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

SearchAggregationSpec, SearchAggregationSpec.Builder

public interface SearchAggregationSpecOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method	Description
boolean	containsMetrics(String key)	alias -> MetricAggSpec
String	getFields(int index)	field names, JSON path expression OK
com.google.protobuf.ByteString	getFieldsBytes(int index)	field names, JSON path expression OK
int	getFieldsCount()	field names, JSON path expression OK
List<String>	getFieldsList()	field names, JSON path expression OK
Map<String,MetricAggSpec>	getMetrics()	Deprecated.
int	getMetricsCount()	alias -> MetricAggSpec
Map<String,MetricAggSpec>	getMetricsMap()	alias -> MetricAggSpec
MetricAggSpec	getMetricsOrDefault(String key, MetricAggSpec defaultValue)	alias -> MetricAggSpec
MetricAggSpec	getMetricsOrThrow(String key)	alias -> MetricAggSpec
OrderSpec	getOrder(int index)	index 0 = highest priority
int	getOrderCount()	index 0 = highest priority
List<OrderSpec>	getOrderList()	index 0 = highest priority
OrderSpecOrBuilder	getOrderOrBuilder(int index)	index 0 = highest priority
List<? extends OrderSpecOrBuilder>	getOrderOrBuilderList()	index 0 = highest priority
long	getSearchSize()	candidate buckets searched at this level; 0 means size
long	getSize()	max buckets returned at this level
SearchAggregationSpec	getSubAggregation()	recursive nesting
SearchAggregationSpecOrBuilder	getSubAggregationOrBuilder()	recursive nesting
TopHitsSpec	getTopHits()	nil = pure aggregation level
TopHitsSpecOrBuilder	getTopHitsOrBuilder()	nil = pure aggregation level
boolean	hasSubAggregation()	recursive nesting
boolean	hasTopHits()	nil = pure aggregation level

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Detail

getFieldsList

List<String> getFieldsList()

 field names, JSON path expression OK
 

repeated string fields = 1;

Returns:

A list containing the fields.

getFieldsCount

int getFieldsCount()

 field names, JSON path expression OK
 

repeated string fields = 1;

Returns:

The count of fields.

getFields

String getFields(int index)

 field names, JSON path expression OK
 

repeated string fields = 1;

Parameters:

index - The index of the element to return.

Returns:

The fields at the given index.

getFieldsBytes

com.google.protobuf.ByteString getFieldsBytes(int index)

 field names, JSON path expression OK
 

repeated string fields = 1;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the fields at the given index.

getSize

long getSize()

 max buckets returned at this level
 

int64 size = 2;

Returns:

The size.

getMetricsCount

int getMetricsCount()

 alias -> MetricAggSpec
 

map<string, .milvus.proto.common.MetricAggSpec> metrics = 3;

containsMetrics

boolean containsMetrics(String key)

 alias -> MetricAggSpec
 

map<string, .milvus.proto.common.MetricAggSpec> metrics = 3;

getMetrics

@Deprecated
Map<String,MetricAggSpec> getMetrics()

Deprecated.

Use getMetricsMap() instead.

getMetricsMap

Map<String,MetricAggSpec> getMetricsMap()

 alias -> MetricAggSpec
 

map<string, .milvus.proto.common.MetricAggSpec> metrics = 3;

getMetricsOrDefault

MetricAggSpec getMetricsOrDefault(String key,
                                  MetricAggSpec defaultValue)

 alias -> MetricAggSpec
 

map<string, .milvus.proto.common.MetricAggSpec> metrics = 3;

getMetricsOrThrow

MetricAggSpec getMetricsOrThrow(String key)

 alias -> MetricAggSpec
 

map<string, .milvus.proto.common.MetricAggSpec> metrics = 3;

getOrderList

List<OrderSpec> getOrderList()

 index 0 = highest priority
 

repeated .milvus.proto.common.OrderSpec order = 4;

getOrder

OrderSpec getOrder(int index)

 index 0 = highest priority
 

repeated .milvus.proto.common.OrderSpec order = 4;

getOrderCount

int getOrderCount()

 index 0 = highest priority
 

repeated .milvus.proto.common.OrderSpec order = 4;

getOrderOrBuilderList

List<? extends OrderSpecOrBuilder> getOrderOrBuilderList()

 index 0 = highest priority
 

repeated .milvus.proto.common.OrderSpec order = 4;

getOrderOrBuilder

OrderSpecOrBuilder getOrderOrBuilder(int index)

 index 0 = highest priority
 

repeated .milvus.proto.common.OrderSpec order = 4;

hasTopHits

boolean hasTopHits()

 nil = pure aggregation level
 

.milvus.proto.common.TopHitsSpec top_hits = 5;

Returns:

Whether the topHits field is set.

getTopHits

TopHitsSpec getTopHits()

 nil = pure aggregation level
 

.milvus.proto.common.TopHitsSpec top_hits = 5;

Returns:

The topHits.

getTopHitsOrBuilder

TopHitsSpecOrBuilder getTopHitsOrBuilder()

 nil = pure aggregation level
 

.milvus.proto.common.TopHitsSpec top_hits = 5;

hasSubAggregation

boolean hasSubAggregation()

 recursive nesting
 

.milvus.proto.common.SearchAggregationSpec sub_aggregation = 6;

Returns:

Whether the subAggregation field is set.

getSubAggregation

SearchAggregationSpec getSubAggregation()

 recursive nesting
 

.milvus.proto.common.SearchAggregationSpec sub_aggregation = 6;

Returns:

The subAggregation.

getSubAggregationOrBuilder

SearchAggregationSpecOrBuilder getSubAggregationOrBuilder()

 recursive nesting
 

.milvus.proto.common.SearchAggregationSpec sub_aggregation = 6;

getSearchSize

long getSearchSize()

 candidate buckets searched at this level; 0 means size
 

int64 search_size = 7;

Returns:

The searchSize.