Package io.milvus.grpc

Class SearchAggregationSpec

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.milvus.grpc.SearchAggregationSpec

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SearchAggregationSpecOrBuilder, Serializable

public final class SearchAggregationSpec
extends com.google.protobuf.GeneratedMessageV3
implements SearchAggregationSpecOrBuilder

Protobuf type milvus.proto.common.SearchAggregationSpec

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchAggregationSpec.Builder	Protobuf type milvus.proto.common.SearchAggregationSpec

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static int	FIELDS_FIELD_NUMBER
static int	METRICS_FIELD_NUMBER
static int	ORDER_FIELD_NUMBER
static int	SEARCH_SIZE_FIELD_NUMBER
static int	SIZE_FIELD_NUMBER
static int	SUB_AGGREGATION_FIELD_NUMBER
static int	TOP_HITS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	containsMetrics(String key)	alias -> MetricAggSpec
boolean	equals(Object obj)
static SearchAggregationSpec	getDefaultInstance()
SearchAggregationSpec	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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
com.google.protobuf.ProtocolStringList	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
com.google.protobuf.Parser<SearchAggregationSpec>	getParserForType()
long	getSearchSize()	candidate buckets searched at this level; 0 means size
int	getSerializedSize()
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
int	hashCode()
boolean	hasSubAggregation()	recursive nesting
boolean	hasTopHits()	nil = pure aggregation level
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMapFieldReflection(int number)
boolean	isInitialized()
static SearchAggregationSpec.Builder	newBuilder()
static SearchAggregationSpec.Builder	newBuilder(SearchAggregationSpec prototype)
SearchAggregationSpec.Builder	newBuilderForType()
protected SearchAggregationSpec.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static SearchAggregationSpec	parseDelimitedFrom(InputStream input)
static SearchAggregationSpec	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchAggregationSpec	parseFrom(byte[] data)
static SearchAggregationSpec	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchAggregationSpec	parseFrom(com.google.protobuf.ByteString data)
static SearchAggregationSpec	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchAggregationSpec	parseFrom(com.google.protobuf.CodedInputStream input)
static SearchAggregationSpec	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchAggregationSpec	parseFrom(InputStream input)
static SearchAggregationSpec	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchAggregationSpec	parseFrom(ByteBuffer data)
static SearchAggregationSpec	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SearchAggregationSpec>	parser()
SearchAggregationSpec.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Detail

FIELDS_FIELD_NUMBER

public static final int FIELDS_FIELD_NUMBER

See Also:

Constant Field Values

SIZE_FIELD_NUMBER

public static final int SIZE_FIELD_NUMBER

See Also:

Constant Field Values

METRICS_FIELD_NUMBER

public static final int METRICS_FIELD_NUMBER

See Also:

Constant Field Values

ORDER_FIELD_NUMBER

public static final int ORDER_FIELD_NUMBER

See Also:

Constant Field Values

TOP_HITS_FIELD_NUMBER

public static final int TOP_HITS_FIELD_NUMBER

See Also:

Constant Field Values

SUB_AGGREGATION_FIELD_NUMBER

public static final int SUB_AGGREGATION_FIELD_NUMBER

See Also:

Constant Field Values

SEARCH_SIZE_FIELD_NUMBER

public static final int SEARCH_SIZE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapFieldReflection

protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getFieldsList

public com.google.protobuf.ProtocolStringList getFieldsList()

 field names, JSON path expression OK
 

repeated string fields = 1;

Specified by:

getFieldsList in interface SearchAggregationSpecOrBuilder

Returns:

A list containing the fields.

getFieldsCount

public int getFieldsCount()

 field names, JSON path expression OK
 

repeated string fields = 1;

Specified by:

getFieldsCount in interface SearchAggregationSpecOrBuilder

Returns:

The count of fields.

getFields

public String getFields(int index)

 field names, JSON path expression OK
 

repeated string fields = 1;

Specified by:

getFields in interface SearchAggregationSpecOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The fields at the given index.

getFieldsBytes

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

 field names, JSON path expression OK
 

repeated string fields = 1;

Specified by:

getFieldsBytes in interface SearchAggregationSpecOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the fields at the given index.

getSize

public long getSize()

 max buckets returned at this level
 

int64 size = 2;

Specified by:

getSize in interface SearchAggregationSpecOrBuilder

Returns:

The size.

getMetricsCount

public int getMetricsCount()

Description copied from interface: SearchAggregationSpecOrBuilder

 alias -> MetricAggSpec
 

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

Specified by:

getMetricsCount in interface SearchAggregationSpecOrBuilder

containsMetrics

public boolean containsMetrics(String key)

 alias -> MetricAggSpec
 

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

Specified by:

containsMetrics in interface SearchAggregationSpecOrBuilder

getMetrics

@Deprecated
public Map<String,MetricAggSpec> getMetrics()

Deprecated.

Use getMetricsMap() instead.

Specified by:

getMetrics in interface SearchAggregationSpecOrBuilder

getMetricsMap

public Map<String,MetricAggSpec> getMetricsMap()

 alias -> MetricAggSpec
 

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

Specified by:

getMetricsMap in interface SearchAggregationSpecOrBuilder

getMetricsOrDefault

public MetricAggSpec getMetricsOrDefault(String key,
                                         MetricAggSpec defaultValue)

 alias -> MetricAggSpec
 

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

Specified by:

getMetricsOrDefault in interface SearchAggregationSpecOrBuilder

getMetricsOrThrow

public MetricAggSpec getMetricsOrThrow(String key)

 alias -> MetricAggSpec
 

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

Specified by:

getMetricsOrThrow in interface SearchAggregationSpecOrBuilder

getOrderList

public List<OrderSpec> getOrderList()

 index 0 = highest priority
 

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

Specified by:

getOrderList in interface SearchAggregationSpecOrBuilder

getOrderOrBuilderList

public List<? extends OrderSpecOrBuilder> getOrderOrBuilderList()

 index 0 = highest priority
 

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

Specified by:

getOrderOrBuilderList in interface SearchAggregationSpecOrBuilder

getOrderCount

public int getOrderCount()

 index 0 = highest priority
 

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

Specified by:

getOrderCount in interface SearchAggregationSpecOrBuilder

getOrder

public OrderSpec getOrder(int index)

 index 0 = highest priority
 

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

Specified by:

getOrder in interface SearchAggregationSpecOrBuilder

getOrderOrBuilder

public OrderSpecOrBuilder getOrderOrBuilder(int index)

 index 0 = highest priority
 

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

Specified by:

getOrderOrBuilder in interface SearchAggregationSpecOrBuilder

hasTopHits

public boolean hasTopHits()

 nil = pure aggregation level
 

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

Specified by:

hasTopHits in interface SearchAggregationSpecOrBuilder

Returns:

Whether the topHits field is set.

getTopHits

public TopHitsSpec getTopHits()

 nil = pure aggregation level
 

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

Specified by:

getTopHits in interface SearchAggregationSpecOrBuilder

Returns:

The topHits.

getTopHitsOrBuilder

public TopHitsSpecOrBuilder getTopHitsOrBuilder()

 nil = pure aggregation level
 

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

Specified by:

getTopHitsOrBuilder in interface SearchAggregationSpecOrBuilder

hasSubAggregation

public boolean hasSubAggregation()

 recursive nesting
 

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

Specified by:

hasSubAggregation in interface SearchAggregationSpecOrBuilder

Returns:

Whether the subAggregation field is set.

getSubAggregation

public SearchAggregationSpec getSubAggregation()

 recursive nesting
 

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

Specified by:

getSubAggregation in interface SearchAggregationSpecOrBuilder

Returns:

The subAggregation.

getSubAggregationOrBuilder

public SearchAggregationSpecOrBuilder getSubAggregationOrBuilder()

 recursive nesting
 

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

Specified by:

getSubAggregationOrBuilder in interface SearchAggregationSpecOrBuilder

getSearchSize

public long getSearchSize()

 candidate buckets searched at this level; 0 means size
 

int64 search_size = 7;

Specified by:

getSearchSize in interface SearchAggregationSpecOrBuilder

Returns:

The searchSize.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static SearchAggregationSpec parseFrom(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchAggregationSpec parseFrom(ByteBuffer data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchAggregationSpec parseFrom(com.google.protobuf.ByteString data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchAggregationSpec parseFrom(com.google.protobuf.ByteString data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchAggregationSpec parseFrom(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchAggregationSpec parseFrom(byte[] data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchAggregationSpec parseFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

public static SearchAggregationSpec parseFrom(InputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static SearchAggregationSpec parseDelimitedFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static SearchAggregationSpec parseDelimitedFrom(InputStream input,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Throws:

IOException

parseFrom

public static SearchAggregationSpec parseFrom(com.google.protobuf.CodedInputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

public static SearchAggregationSpec parseFrom(com.google.protobuf.CodedInputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Throws:

IOException

newBuilderForType

public SearchAggregationSpec.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static SearchAggregationSpec.Builder newBuilder()

newBuilder

public static SearchAggregationSpec.Builder newBuilder(SearchAggregationSpec prototype)

toBuilder

public SearchAggregationSpec.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected SearchAggregationSpec.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static SearchAggregationSpec getDefaultInstance()

parser

public static com.google.protobuf.Parser<SearchAggregationSpec> parser()

getParserForType

public com.google.protobuf.Parser<SearchAggregationSpec> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public SearchAggregationSpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder