nrtsearch

package
v1.0.0-beta.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 9, 2025 License: Apache-2.0 Imports: 22 Imported by: 0

Documentation

Overview

Package nrtsearch is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source 
var (
	FieldType_name = map[int32]string{
		0:  "ATOM",
		1:  "TEXT",
		2:  "BOOLEAN",
		3:  "LONG",
		4:  "INT",
		5:  "DOUBLE",
		6:  "FLOAT",
		7:  "LAT_LON",
		8:  "DATE_TIME",
		9:  "VIRTUAL",
		10: "INTERNAL",
		11: "CUSTOM",
		12: "_ID",
		13: "POLYGON",
		14: "OBJECT",
		15: "VECTOR",
		16: "CONTEXT_SUGGEST",
		17: "RUNTIME",
	}
	FieldType_value = map[string]int32{
		"ATOM":            0,
		"TEXT":            1,
		"BOOLEAN":         2,
		"LONG":            3,
		"INT":             4,
		"DOUBLE":          5,
		"FLOAT":           6,
		"LAT_LON":         7,
		"DATE_TIME":       8,
		"VIRTUAL":         9,
		"INTERNAL":        10,
		"CUSTOM":          11,
		"_ID":             12,
		"POLYGON":         13,
		"OBJECT":          14,
		"VECTOR":          15,
		"CONTEXT_SUGGEST": 16,
		"RUNTIME":         17,
	}
)

Enum value maps for FieldType.

View Source 
var (
	IndexOptions_name = map[int32]string{
		0: "DEFAULT",
		1: "DOCS",
		2: "DOCS_FREQS",
		3: "DOCS_FREQS_POSITIONS",
		4: "DOCS_FREQS_POSITIONS_OFFSETS",
	}
	IndexOptions_value = map[string]int32{
		"DEFAULT":                      0,
		"DOCS":                         1,
		"DOCS_FREQS":                   2,
		"DOCS_FREQS_POSITIONS":         3,
		"DOCS_FREQS_POSITIONS_OFFSETS": 4,
	}
)

Enum value maps for IndexOptions.

View Source 
var (
	TermVectors_name = map[int32]string{
		0: "NO_TERMVECTORS",
		1: "TERMS",
		2: "TERMS_POSITIONS",
		3: "TERMS_POSITIONS_OFFSETS",
		4: "TERMS_POSITIONS_OFFSETS_PAYLOADS",
	}
	TermVectors_value = map[string]int32{
		"NO_TERMVECTORS":                   0,
		"TERMS":                            1,
		"TERMS_POSITIONS":                  2,
		"TERMS_POSITIONS_OFFSETS":          3,
		"TERMS_POSITIONS_OFFSETS_PAYLOADS": 4,
	}
)

Enum value maps for TermVectors.

View Source 
var (
	FacetType_name = map[int32]string{
		0: "NO_FACETS",
		1: "FLAT",
		2: "HIERARCHY",
		3: "NUMERIC_RANGE",
		4: "SORTED_SET_DOC_VALUES",
	}
	FacetType_value = map[string]int32{
		"NO_FACETS":             0,
		"FLAT":                  1,
		"HIERARCHY":             2,
		"NUMERIC_RANGE":         3,
		"SORTED_SET_DOC_VALUES": 4,
	}
)

Enum value maps for FacetType.

View Source 
var (
	TextDocValuesType_name = map[int32]string{
		0: "TEXT_DOC_VALUES_TYPE_UNSPECIFIED",
		1: "TEXT_DOC_VALUES_TYPE_BINARY",
		2: "TEXT_DOC_VALUES_TYPE_SORTED",
	}
	TextDocValuesType_value = map[string]int32{
		"TEXT_DOC_VALUES_TYPE_UNSPECIFIED": 0,
		"TEXT_DOC_VALUES_TYPE_BINARY":      1,
		"TEXT_DOC_VALUES_TYPE_SORTED":      2,
	}
)

Enum value maps for TextDocValuesType.

View Source 
var (
	VectorElementType_name = map[int32]string{
		0: "VECTOR_ELEMENT_FLOAT",
		1: "VECTOR_ELEMENT_BYTE",
	}
	VectorElementType_value = map[string]int32{
		"VECTOR_ELEMENT_FLOAT": 0,
		"VECTOR_ELEMENT_BYTE":  1,
	}
)

Enum value maps for VectorElementType.

View Source 
var (
	Mode_name = map[int32]string{
		0: "STANDALONE",
		1: "PRIMARY",
		2: "REPLICA",
	}
	Mode_value = map[string]int32{
		"STANDALONE": 0,
		"PRIMARY":    1,
		"REPLICA":    2,
	}
)

Enum value maps for Mode.

View Source 
var (
	TransferStatusCode_name = map[int32]string{
		0: "Unknown",
		1: "Done",
		2: "Failed",
		3: "Ongoing",
	}
	TransferStatusCode_value = map[string]int32{
		"Unknown": 0,
		"Done":    1,
		"Failed":  2,
		"Ongoing": 3,
	}
)

Enum value maps for TransferStatusCode.

View Source 
var (
	ForceMergeResponse_Status_name = map[int32]string{
		0: "FORCE_MERGE_COMPLETED",
		1: "FORCE_MERGE_SUBMITTED",
	}
	ForceMergeResponse_Status_value = map[string]int32{
		"FORCE_MERGE_COMPLETED": 0,
		"FORCE_MERGE_SUBMITTED": 1,
	}
)

Enum value maps for ForceMergeResponse_Status.

View Source 
var (
	ForceMergeDeletesResponse_Status_name = map[int32]string{
		0: "FORCE_MERGE_DELETES_COMPLETED",
		1: "FORCE_MERGE_DELETES_SUBMITTED",
	}
	ForceMergeDeletesResponse_Status_value = map[string]int32{
		"FORCE_MERGE_DELETES_COMPLETED": 0,
		"FORCE_MERGE_DELETES_SUBMITTED": 1,
	}
)

Enum value maps for ForceMergeDeletesResponse_Status.

View Source 
var (
	MatchOperator_name = map[int32]string{
		0: "SHOULD",
		1: "MUST",
	}
	MatchOperator_value = map[string]int32{
		"SHOULD": 0,
		"MUST":   1,
	}
)

Enum value maps for MatchOperator.

View Source 
var (
	RewriteMethod_name = map[int32]string{
		0: "CONSTANT_SCORE",
		1: "CONSTANT_SCORE_BOOLEAN",
		2: "SCORING_BOOLEAN",
		3: "TOP_TERMS_BLENDED_FREQS",
		4: "TOP_TERMS_BOOST",
		5: "TOP_TERMS",
	}
	RewriteMethod_value = map[string]int32{
		"CONSTANT_SCORE":          0,
		"CONSTANT_SCORE_BOOLEAN":  1,
		"SCORING_BOOLEAN":         2,
		"TOP_TERMS_BLENDED_FREQS": 3,
		"TOP_TERMS_BOOST":         4,
		"TOP_TERMS":               5,
	}
)

Enum value maps for RewriteMethod.

View Source 
var (
	CompletionQueryType_name = map[int32]string{
		0: "PREFIX_QUERY",
		1: "FUZZY_QUERY",
	}
	CompletionQueryType_value = map[string]int32{
		"PREFIX_QUERY": 0,
		"FUZZY_QUERY":  1,
	}
)

Enum value maps for CompletionQueryType.

View Source 
var (
	RegexpFlag_name = map[int32]string{
		0: "REGEXP_ALL",
		1: "REGEXP_ANYSTRING",
		2: "REGEXP_AUTOMATON",
		3: "REGEXP_COMPLEMENT",
		4: "REGEXP_EMPTY",
		5: "REGEXP_INTERSECTION",
		6: "REGEXP_INTERVAL",
		7: "REGEXP_NONE",
	}
	RegexpFlag_value = map[string]int32{
		"REGEXP_ALL":          0,
		"REGEXP_ANYSTRING":    1,
		"REGEXP_AUTOMATON":    2,
		"REGEXP_COMPLEMENT":   3,
		"REGEXP_EMPTY":        4,
		"REGEXP_INTERSECTION": 5,
		"REGEXP_INTERVAL":     6,
		"REGEXP_NONE":         7,
	}
)

Enum value maps for RegexpFlag.

View Source 
var (
	QueryType_name = map[int32]string{
		0:  "NONE",
		1:  "BOOLEAN_QUERY",
		2:  "PHRASE_QUERY",
		3:  "FUNCTION_SCORE_QUERY",
		4:  "TERM_QUERY",
		5:  "TERM_IN_SET_QUERY",
		6:  "DISJUNCTION_MAX",
		7:  "MATCH",
		8:  "MATCH_PHRASE",
		9:  "MULTI_MATCH",
		10: "RANGE",
		11: "GEO_BOUNDING_BOX",
		12: "GEO_POINT",
		13: "NESTED",
		14: "EXISTS",
		15: "GEO_RADIUS",
		16: "COMPLETION",
		17: "MULTI_FUNCTION_SCORE_QUERY",
		18: "MATCH_PHRASE_PREFIX",
		19: "PREFIX",
		20: "CONSTANT_SCORE_QUERY",
		21: "GEO_POLYGON",
		22: "SPAN_QUERY",
	}
	QueryType_value = map[string]int32{
		"NONE":                       0,
		"BOOLEAN_QUERY":              1,
		"PHRASE_QUERY":               2,
		"FUNCTION_SCORE_QUERY":       3,
		"TERM_QUERY":                 4,
		"TERM_IN_SET_QUERY":          5,
		"DISJUNCTION_MAX":            6,
		"MATCH":                      7,
		"MATCH_PHRASE":               8,
		"MULTI_MATCH":                9,
		"RANGE":                      10,
		"GEO_BOUNDING_BOX":           11,
		"GEO_POINT":                  12,
		"NESTED":                     13,
		"EXISTS":                     14,
		"GEO_RADIUS":                 15,
		"COMPLETION":                 16,
		"MULTI_FUNCTION_SCORE_QUERY": 17,
		"MATCH_PHRASE_PREFIX":        18,
		"PREFIX":                     19,
		"CONSTANT_SCORE_QUERY":       20,
		"GEO_POLYGON":                21,
		"SPAN_QUERY":                 22,
	}
)

Enum value maps for QueryType.

View Source 
var (
	Selector_name = map[int32]string{
		0: "MIN",
		1: "MAX",
		2: "MIDDLE_MIN",
		3: "MIDDLE_MAX",
	}
	Selector_value = map[string]int32{
		"MIN":        0,
		"MAX":        1,
		"MIDDLE_MIN": 2,
		"MIDDLE_MAX": 3,
	}
)

Enum value maps for Selector.

View Source 
var (
	BooleanClause_Occur_name = map[int32]string{
		0: "SHOULD",
		1: "MUST",
		2: "FILTER",
		3: "MUST_NOT",
	}
	BooleanClause_Occur_value = map[string]int32{
		"SHOULD":   0,
		"MUST":     1,
		"FILTER":   2,
		"MUST_NOT": 3,
	}
)

Enum value maps for BooleanClause_Occur.

View Source 
var (
	NestedQuery_ScoreMode_name = map[int32]string{
		0: "NONE",
		1: "AVG",
		2: "MAX",
		3: "MIN",
		4: "SUM",
	}
	NestedQuery_ScoreMode_value = map[string]int32{
		"NONE": 0,
		"AVG":  1,
		"MAX":  2,
		"MIN":  3,
		"SUM":  4,
	}
)

Enum value maps for NestedQuery_ScoreMode.

View Source 
var (
	MatchPhraseQuery_ZeroTerms_name = map[int32]string{
		0: "NONE_ZERO_TERMS",
		1: "ALL_ZERO_TERMS",
	}
	MatchPhraseQuery_ZeroTerms_value = map[string]int32{
		"NONE_ZERO_TERMS": 0,
		"ALL_ZERO_TERMS":  1,
	}
)

Enum value maps for MatchPhraseQuery_ZeroTerms.

View Source 
var (
	MultiMatchQuery_MatchType_name = map[int32]string{
		0: "BEST_FIELDS",
		1: "PHRASE_PREFIX",
		2: "CROSS_FIELDS",
	}
	MultiMatchQuery_MatchType_value = map[string]int32{
		"BEST_FIELDS":   0,
		"PHRASE_PREFIX": 1,
		"CROSS_FIELDS":  2,
	}
)

Enum value maps for MultiMatchQuery_MatchType.

View Source 
var (
	MultiFunctionScoreQuery_DecayType_name = map[int32]string{
		0: "DECAY_TYPE_EXPONENTIAL",
		1: "DECAY_TYPE_LINEAR",
		2: "DECAY_TYPE_GUASSIAN",
	}
	MultiFunctionScoreQuery_DecayType_value = map[string]int32{
		"DECAY_TYPE_EXPONENTIAL": 0,
		"DECAY_TYPE_LINEAR":      1,
		"DECAY_TYPE_GUASSIAN":    2,
	}
)

Enum value maps for MultiFunctionScoreQuery_DecayType.

View Source 
var (
	MultiFunctionScoreQuery_FunctionScoreMode_name = map[int32]string{
		0: "SCORE_MODE_MULTIPLY",
		1: "SCORE_MODE_SUM",
	}
	MultiFunctionScoreQuery_FunctionScoreMode_value = map[string]int32{
		"SCORE_MODE_MULTIPLY": 0,
		"SCORE_MODE_SUM":      1,
	}
)

Enum value maps for MultiFunctionScoreQuery_FunctionScoreMode.

View Source 
var (
	MultiFunctionScoreQuery_BoostMode_name = map[int32]string{
		0: "BOOST_MODE_MULTIPLY",
		1: "BOOST_MODE_SUM",
		2: "BOOST_MODE_REPLACE",
	}
	MultiFunctionScoreQuery_BoostMode_value = map[string]int32{
		"BOOST_MODE_MULTIPLY": 0,
		"BOOST_MODE_SUM":      1,
		"BOOST_MODE_REPLACE":  2,
	}
)

Enum value maps for MultiFunctionScoreQuery_BoostMode.

View Source 
var (
	Script_ParamNullValue_name = map[int32]string{
		0: "NULL_VALUE",
	}
	Script_ParamNullValue_value = map[string]int32{
		"NULL_VALUE": 0,
	}
)

Enum value maps for Script_ParamNullValue.

View Source 
var (
	TotalHits_Relation_name = map[int32]string{
		0: "EQUAL_TO",
		1: "GREATER_THAN_OR_EQUAL_TO",
	}
	TotalHits_Relation_value = map[string]int32{
		"EQUAL_TO":                 0,
		"GREATER_THAN_OR_EQUAL_TO": 1,
	}
)

Enum value maps for TotalHits_Relation.

View Source 
var (
	BucketOrder_OrderType_name = map[int32]string{
		0: "DESC",
		1: "ASC",
	}
	BucketOrder_OrderType_value = map[string]int32{
		"DESC": 0,
		"ASC":  1,
	}
)

Enum value maps for BucketOrder_OrderType.

View Source 
var (
	Highlight_Type_name = map[int32]string{
		0: "DEFAULT",
		1: "FAST_VECTOR",
		2: "PLAIN",
		3: "CUSTOM",
	}
	Highlight_Type_value = map[string]int32{
		"DEFAULT":     0,
		"FAST_VECTOR": 1,
		"PLAIN":       2,
		"CUSTOM":      3,
	}
)

Enum value maps for Highlight_Type.

View Source 
var File_yelp_nrtsearch_analysis_proto protoreflect.FileDescriptor
View Source 
var File_yelp_nrtsearch_luceneserver_proto protoreflect.FileDescriptor
View Source 
var File_yelp_nrtsearch_search_proto protoreflect.FileDescriptor

Functions

func RegisterLuceneServerHandler 

func RegisterLuceneServerHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterLuceneServerHandler registers the http handlers for service LuceneServer to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterLuceneServerHandlerClient 

func RegisterLuceneServerHandlerClient(ctx context.Context, mux *runtime.ServeMux, client LuceneServerClient) error

RegisterLuceneServerHandlerClient registers the http handlers for service LuceneServer to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "LuceneServerClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "LuceneServerClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "LuceneServerClient" to call the correct interceptors.

func RegisterLuceneServerHandlerFromEndpoint 

func RegisterLuceneServerHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterLuceneServerHandlerFromEndpoint is same as RegisterLuceneServerHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterLuceneServerHandlerServer 

func RegisterLuceneServerHandlerServer(ctx context.Context, mux *runtime.ServeMux, server LuceneServerServer) error

RegisterLuceneServerHandlerServer registers the http handlers for service LuceneServer to "mux". UnaryRPC :call LuceneServerServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterLuceneServerHandlerFromEndpoint instead.

func RegisterLuceneServerServer 

func RegisterLuceneServerServer(s *grpc.Server, srv LuceneServerServer)

func RegisterReplicationServerServer 

func RegisterReplicationServerServer(s *grpc.Server, srv ReplicationServerServer)

Types

type AddDocumentRequest 

type AddDocumentRequest struct {

	// Index name
	IndexName string `protobuf:"bytes,1,opt,name=indexName,proto3" json:"indexName,omitempty"`
	// Map of field name to a list of string values
	Fields map[string]*AddDocumentRequest_MultiValuedField `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

Message representing a document to index

func (*AddDocumentRequest) Descriptor deprecated 

func (*AddDocumentRequest) Descriptor() ([]byte, []int)

Deprecated: Use AddDocumentRequest.ProtoReflect.Descriptor instead.

func (*AddDocumentRequest) GetFields 

func (x *AddDocumentRequest) GetFields() map[string]*AddDocumentRequest_MultiValuedField

func (*AddDocumentRequest) GetIndexName 

func (x *AddDocumentRequest) GetIndexName() string

func (*AddDocumentRequest) ProtoMessage 

func (*AddDocumentRequest) ProtoMessage()

func (*AddDocumentRequest) ProtoReflect 

func (x *AddDocumentRequest) ProtoReflect() protoreflect.Message

func (*AddDocumentRequest) Reset 

func (x *AddDocumentRequest) Reset()

func (*AddDocumentRequest) String 

func (x *AddDocumentRequest) String() string

type AddDocumentRequest_MultiValuedField 

type AddDocumentRequest_MultiValuedField struct {

	// List of values for this field
	Value []string `protobuf:"bytes,1,rep,name=value,proto3" json:"value,omitempty"`
	// Facet paths/hierarchy to bucket these values by, if indexed field is of type Facet.HIERARCHY
	FaceHierarchyPaths []*FacetHierarchyPath `protobuf:"bytes,2,rep,name=faceHierarchyPaths,proto3" json:"faceHierarchyPaths,omitempty"`
	// contains filtered or unexported fields
}

Wrapper object to represent each field as a multivalued field.

func (*AddDocumentRequest_MultiValuedField) Descriptor deprecated 

func (*AddDocumentRequest_MultiValuedField) Descriptor() ([]byte, []int)

Deprecated: Use AddDocumentRequest_MultiValuedField.ProtoReflect.Descriptor instead.

func (*AddDocumentRequest_MultiValuedField) GetFaceHierarchyPaths 

func (x *AddDocumentRequest_MultiValuedField) GetFaceHierarchyPaths() []*FacetHierarchyPath

func (*AddDocumentRequest_MultiValuedField) GetValue 

func (x *AddDocumentRequest_MultiValuedField) GetValue() []string

func (*AddDocumentRequest_MultiValuedField) ProtoMessage 

func (*AddDocumentRequest_MultiValuedField) ProtoMessage()

func (*AddDocumentRequest_MultiValuedField) ProtoReflect 

func (x *AddDocumentRequest_MultiValuedField) ProtoReflect() protoreflect.Message

func (*AddDocumentRequest_MultiValuedField) Reset 

func (x *AddDocumentRequest_MultiValuedField) Reset()

func (*AddDocumentRequest_MultiValuedField) String 

func (x *AddDocumentRequest_MultiValuedField) String() string

type AddDocumentResponse 

type AddDocumentResponse struct {

	// Lucene index sequence number after adding the documents
	GenId string `protobuf:"bytes,1,opt,name=genId,proto3" json:"genId,omitempty"`
	// Unique identifier for the primary instance that processed the request
	PrimaryId string `protobuf:"bytes,2,opt,name=primaryId,proto3" json:"primaryId,omitempty"`
	// contains filtered or unexported fields
}

Response from Server for addDocument

func (*AddDocumentResponse) Descriptor deprecated 

func (*AddDocumentResponse) Descriptor() ([]byte, []int)

Deprecated: Use AddDocumentResponse.ProtoReflect.Descriptor instead.

func (*AddDocumentResponse) GetGenId 

func (x *AddDocumentResponse) GetGenId() string

func (*AddDocumentResponse) GetPrimaryId 

func (x *AddDocumentResponse) GetPrimaryId() string

func (*AddDocumentResponse) ProtoMessage 

func (*AddDocumentResponse) ProtoMessage()

func (*AddDocumentResponse) ProtoReflect 

func (x *AddDocumentResponse) ProtoReflect() protoreflect.Message

func (*AddDocumentResponse) Reset 

func (x *AddDocumentResponse) Reset()

func (*AddDocumentResponse) String 

func (x *AddDocumentResponse) String() string

type AddReplicaRequest 

type AddReplicaRequest struct {

	// Magic number send on all requests since these are meant for internal communication only
	MagicNumber int32 `protobuf:"varint,1,opt,name=magicNumber,proto3" json:"magicNumber,omitempty"`
	// Index name
	IndexName string `protobuf:"bytes,2,opt,name=indexName,proto3" json:"indexName,omitempty"`
	// No longer used
	//
	// Deprecated: Do not use.
	ReplicaId int32 `protobuf:"varint,3,opt,name=replicaId,proto3" json:"replicaId,omitempty"`
	// Replica host name
	HostName string `protobuf:"bytes,4,opt,name=hostName,proto3" json:"hostName,omitempty"`
	// Replica port number
	Port int32 `protobuf:"varint,5,opt,name=port,proto3" json:"port,omitempty"`
	// Index id
	IndexId string `protobuf:"bytes,6,opt,name=indexId,proto3" json:"indexId,omitempty"`
	// Node name
	NodeName string `protobuf:"bytes,7,opt,name=nodeName,proto3" json:"nodeName,omitempty"`
	// contains filtered or unexported fields
}

Input to addReplica

func (*AddReplicaRequest) Descriptor deprecated 

func (*AddReplicaRequest) Descriptor() ([]byte, []int)

Deprecated: Use AddReplicaRequest.ProtoReflect.Descriptor instead.

func (*AddReplicaRequest) GetHostName 

func (x *AddReplicaRequest) GetHostName() string

func (*AddReplicaRequest) GetIndexId added in v0.39.0 

func (x *AddReplicaRequest) GetIndexId() string

func (*AddReplicaRequest) GetIndexName 

func (x *AddReplicaRequest) GetIndexName() string

func (*AddReplicaRequest) GetMagicNumber 

func (x *AddReplicaRequest) GetMagicNumber() int32

func (*AddReplicaRequest) GetNodeName 

func (x *AddReplicaRequest) GetNodeName() string

func (*AddReplicaRequest) GetPort 

func (x *AddReplicaRequest) GetPort() int32

func (*AddReplicaRequest) GetReplicaId deprecated 

func (x *AddReplicaRequest) GetReplicaId() int32

Deprecated: Do not use.

func (*AddReplicaRequest) ProtoMessage 

func (*AddReplicaRequest) ProtoMessage()

func (*AddReplicaRequest) ProtoReflect 

func (x *AddReplicaRequest) ProtoReflect() protoreflect.Message

func (*AddReplicaRequest) Reset 

func (x *AddReplicaRequest) Reset()

func (*AddReplicaRequest) String 

func (x *AddReplicaRequest) String() string

type AddReplicaResponse 

type AddReplicaResponse struct {

	// Returns "ok" string on success
	Ok string `protobuf:"bytes,1,opt,name=ok,proto3" json:"ok,omitempty"`
	// contains filtered or unexported fields
}

Response from Server for addReplica

func (*AddReplicaResponse) Descriptor deprecated 

func (*AddReplicaResponse) Descriptor() ([]byte, []int)

Deprecated: Use AddReplicaResponse.ProtoReflect.Descriptor instead.

func (*AddReplicaResponse) GetOk 

func (x *AddReplicaResponse) GetOk() string

func (*AddReplicaResponse) ProtoMessage 

func (*AddReplicaResponse) ProtoMessage()

func (*AddReplicaResponse) ProtoReflect 

func (x *AddReplicaResponse) ProtoReflect() protoreflect.Message

func (*AddReplicaResponse) Reset 

func (x *AddReplicaResponse) Reset()

func (*AddReplicaResponse) String 

func (x *AddReplicaResponse) String() string

type Analyzer 

type Analyzer struct {

	// Types that are assignable to AnalyzerType:
	//
	//	*Analyzer_Predefined
	//	*Analyzer_Custom
	AnalyzerType isAnalyzer_AnalyzerType `protobuf_oneof:"AnalyzerType"`
	// contains filtered or unexported fields
}

Analyzer definition

func (*Analyzer) Descriptor deprecated 

func (*Analyzer) Descriptor() ([]byte, []int)

Deprecated: Use Analyzer.ProtoReflect.Descriptor instead.

func (*Analyzer) GetAnalyzerType 

func (m *Analyzer) GetAnalyzerType() isAnalyzer_AnalyzerType

func (*Analyzer) GetCustom 

func (x *Analyzer) GetCustom() *CustomAnalyzer

func (*Analyzer) GetPredefined 

func (x *Analyzer) GetPredefined() string

func (*Analyzer) ProtoMessage 

func (*Analyzer) ProtoMessage()

func (*Analyzer) ProtoReflect 

func (x *Analyzer) ProtoReflect() protoreflect.Message

func (*Analyzer) Reset 

func (x *Analyzer) Reset()

func (*Analyzer) String 

func (x *Analyzer) String() string

type Analyzer_Custom 

type Analyzer_Custom struct {
	// Custom analyzer
	Custom *CustomAnalyzer `protobuf:"bytes,2,opt,name=custom,proto3,oneof"`
}

type Analyzer_Predefined 

type Analyzer_Predefined struct {
	// Analyzers predefined in Lucene, apart from standard and classic there are en.English, bn.Bengali,
	// eu.Basque, etc. (names derived from Lucene's analyzer class names)
	Predefined string `protobuf:"bytes,1,opt,name=predefined,proto3,oneof"`
}

type BackupWarmingQueriesRequest 

type BackupWarmingQueriesRequest struct {

	// Index whose warming queries to backup
	Index string `protobuf:"bytes,1,opt,name=index,proto3" json:"index,omitempty"`
	// Remote storage namespace qualifier for service
	ServiceName string `protobuf:"bytes,2,opt,name=serviceName,proto3" json:"serviceName,omitempty"`
	// Optional; minimum # of queries required to backup warming queries
	NumQueriesThreshold int32 `protobuf:"varint,3,opt,name=numQueriesThreshold,proto3" json:"numQueriesThreshold,omitempty"`
	// Optional; minimum # of minutes uptime to backup warming queries
	UptimeMinutesThreshold int32 `protobuf:"varint,4,opt,name=uptimeMinutesThreshold,proto3" json:"uptimeMinutesThreshold,omitempty"`
	// contains filtered or unexported fields
}

Input to backupWarmingQueries

func (*BackupWarmingQueriesRequest) Descriptor deprecated 

func (*BackupWarmingQueriesRequest) Descriptor() ([]byte, []int)

Deprecated: Use BackupWarmingQueriesRequest.ProtoReflect.Descriptor instead.

func (*BackupWarmingQueriesRequest) GetIndex 

func (x *BackupWarmingQueriesRequest) GetIndex() string

func (*BackupWarmingQueriesRequest) GetNumQueriesThreshold 

func (x *BackupWarmingQueriesRequest) GetNumQueriesThreshold() int32

func (*BackupWarmingQueriesRequest) GetServiceName 

func (x *BackupWarmingQueriesRequest) GetServiceName() string

func (*BackupWarmingQueriesRequest) GetUptimeMinutesThreshold 

func (x *BackupWarmingQueriesRequest) GetUptimeMinutesThreshold() int32

func (*BackupWarmingQueriesRequest) ProtoMessage 

func (*BackupWarmingQueriesRequest) ProtoMessage()

func (*BackupWarmingQueriesRequest) ProtoReflect 

func (x *BackupWarmingQueriesRequest) ProtoReflect() protoreflect.Message

func (*BackupWarmingQueriesRequest) Reset 

func (x *BackupWarmingQueriesRequest) Reset()

func (*BackupWarmingQueriesRequest) String 

func (x *BackupWarmingQueriesRequest) String() string

type BackupWarmingQueriesResponse 

type BackupWarmingQueriesResponse struct {
	// contains filtered or unexported fields
}

Response from Server for backupWarmingQueries

func (*BackupWarmingQueriesResponse) Descriptor deprecated 

func (*BackupWarmingQueriesResponse) Descriptor() ([]byte, []int)

Deprecated: Use BackupWarmingQueriesResponse.ProtoReflect.Descriptor instead.

func (*BackupWarmingQueriesResponse) ProtoMessage 

func (*BackupWarmingQueriesResponse) ProtoMessage()

func (*BackupWarmingQueriesResponse) ProtoReflect 

func (x *BackupWarmingQueriesResponse) ProtoReflect() protoreflect.Message

func (*BackupWarmingQueriesResponse) Reset 

func (x *BackupWarmingQueriesResponse) Reset()

func (*BackupWarmingQueriesResponse) String 

func (x *BackupWarmingQueriesResponse) String() string

type BooleanClause 

type BooleanClause struct {

	// The Query for the clause
	Query *Query `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
	// Specifies how this clause must occur in a matching document. SHOULD by default.
	Occur BooleanClause_Occur `protobuf:"varint,2,opt,name=occur,proto3,enum=luceneserver.BooleanClause_Occur" json:"occur,omitempty"`
	// contains filtered or unexported fields
}

A clause in a BooleanQuery.

func (*BooleanClause) Descriptor deprecated 

func (*BooleanClause) Descriptor() ([]byte, []int)

Deprecated: Use BooleanClause.ProtoReflect.Descriptor instead.

func (*BooleanClause) GetOccur 

func (x *BooleanClause) GetOccur() BooleanClause_Occur

func (*BooleanClause) GetQuery 

func (x *BooleanClause) GetQuery() *Query

func (*BooleanClause) ProtoMessage 

func (*BooleanClause) ProtoMessage()

func (*BooleanClause) ProtoReflect 

func (x *BooleanClause) ProtoReflect() protoreflect.Message

func (*BooleanClause) Reset 

func (x *BooleanClause) Reset()

func (*BooleanClause) String 

func (x *BooleanClause) String() string

type BooleanClause_Occur 

type BooleanClause_Occur int32

Defines how clauses may occur in matching documents. This will always be SHOULD by default. 

const (
	BooleanClause_SHOULD   BooleanClause_Occur = 0
	BooleanClause_MUST     BooleanClause_Occur = 1
	BooleanClause_FILTER   BooleanClause_Occur = 2
	BooleanClause_MUST_NOT BooleanClause_Occur = 3
)

func (BooleanClause_Occur) Descriptor 

func (BooleanClause_Occur) Descriptor() protoreflect.EnumDescriptor

func (BooleanClause_Occur) Enum 

func (x BooleanClause_Occur) Enum() *BooleanClause_Occur

func (BooleanClause_Occur) EnumDescriptor deprecated 

func (BooleanClause_Occur) EnumDescriptor() ([]byte, []int)

Deprecated: Use BooleanClause_Occur.Descriptor instead.

func (BooleanClause_Occur) Number 

func (x BooleanClause_Occur) Number() protoreflect.EnumNumber

func (BooleanClause_Occur) String 

func (x BooleanClause_Occur) String() string

func (BooleanClause_Occur) Type 

func (BooleanClause_Occur) Type() protoreflect.EnumType

type BooleanQuery 

type BooleanQuery struct {

	// Clauses for a boolean query
	Clauses []*BooleanClause `protobuf:"bytes,1,rep,name=clauses,proto3" json:"clauses,omitempty"`
	// Minimum number of optional clauses that must match
	MinimumNumberShouldMatch int32 `protobuf:"varint,2,opt,name=minimumNumberShouldMatch,proto3" json:"minimumNumberShouldMatch,omitempty"`
	// contains filtered or unexported fields
}

A query that matches documents using boolean combinations of other queries

func (*BooleanQuery) Descriptor deprecated 

func (*BooleanQuery) Descriptor() ([]byte, []int)

Deprecated: Use BooleanQuery.ProtoReflect.Descriptor instead.

func (*BooleanQuery) GetClauses 

func (x *BooleanQuery) GetClauses() []*BooleanClause

func (*BooleanQuery) GetMinimumNumberShouldMatch 

func (x *BooleanQuery) GetMinimumNumberShouldMatch() int32

func (*BooleanQuery) ProtoMessage 

func (*BooleanQuery) ProtoMessage()

func (*BooleanQuery) ProtoReflect 

func (x *BooleanQuery) ProtoReflect() protoreflect.Message

func (*BooleanQuery) Reset 

func (x *BooleanQuery) Reset()

func (*BooleanQuery) String 

func (x *BooleanQuery) String() string

type BucketOrder added in v0.23.0 

type BucketOrder struct {

	// What to use for sorting. This can be _count for Bucket count, or the name of a nested collector that
	// supports ordering.
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// Sorting order
	Order BucketOrder_OrderType `protobuf:"varint,2,opt,name=order,proto3,enum=luceneserver.BucketOrder_OrderType" json:"order,omitempty"`
	// contains filtered or unexported fields
}

Defines how Buckets should be ordered in BucketResult

func (*BucketOrder) Descriptor deprecated added in v0.23.0 

func (*BucketOrder) Descriptor() ([]byte, []int)

Deprecated: Use BucketOrder.ProtoReflect.Descriptor instead.

func (*BucketOrder) GetKey added in v0.23.0 

func (x *BucketOrder) GetKey() string

func (*BucketOrder) GetOrder added in v0.23.0 

func (x *BucketOrder) GetOrder() BucketOrder_OrderType

func (*BucketOrder) ProtoMessage added in v0.23.0 

func (*BucketOrder) ProtoMessage()

func (*BucketOrder) ProtoReflect added in v0.23.0 

func (x *BucketOrder) ProtoReflect() protoreflect.Message

func (*BucketOrder) Reset added in v0.23.0 

func (x *BucketOrder) Reset()

func (*BucketOrder) String added in v0.23.0 

func (x *BucketOrder) String() string

type BucketOrder_OrderType added in v0.23.0 

type BucketOrder_OrderType int32

Sorting order type 

const (
	BucketOrder_DESC BucketOrder_OrderType = 0
	BucketOrder_ASC  BucketOrder_OrderType = 1
)

func (BucketOrder_OrderType) Descriptor added in v0.23.0 

func (BucketOrder_OrderType) Descriptor() protoreflect.EnumDescriptor

func (BucketOrder_OrderType) Enum added in v0.23.0 

func (x BucketOrder_OrderType) Enum() *BucketOrder_OrderType

func (BucketOrder_OrderType) EnumDescriptor deprecated added in v0.23.0 

func (BucketOrder_OrderType) EnumDescriptor() ([]byte, []int)

Deprecated: Use BucketOrder_OrderType.Descriptor instead.

func (BucketOrder_OrderType) Number added in v0.23.0 

func (x BucketOrder_OrderType) Number() protoreflect.EnumNumber

func (BucketOrder_OrderType) String added in v0.23.0 

func (x BucketOrder_OrderType) String() string

func (BucketOrder_OrderType) Type added in v0.23.0 

func (BucketOrder_OrderType) Type() protoreflect.EnumType

type BucketResult 

type BucketResult struct {

	// Buckets
	Buckets []*BucketResult_Bucket `protobuf:"bytes,1,rep,name=buckets,proto3" json:"buckets,omitempty"`
	// Number of unique buckets, including those not in the buckets list
	TotalBuckets int32 `protobuf:"varint,2,opt,name=totalBuckets,proto3" json:"totalBuckets,omitempty"`
	// Number of other collected counts not represented in the buckets' counts
	TotalOtherCounts int32 `protobuf:"varint,3,opt,name=totalOtherCounts,proto3" json:"totalOtherCounts,omitempty"`
	// contains filtered or unexported fields
}

Results from bucketing collector

func (*BucketResult) Descriptor deprecated 

func (*BucketResult) Descriptor() ([]byte, []int)

Deprecated: Use BucketResult.ProtoReflect.Descriptor instead.

func (*BucketResult) GetBuckets 

func (x *BucketResult) GetBuckets() []*BucketResult_Bucket

func (*BucketResult) GetTotalBuckets 

func (x *BucketResult) GetTotalBuckets() int32

func (*BucketResult) GetTotalOtherCounts 

func (x *BucketResult) GetTotalOtherCounts() int32

func (*BucketResult) ProtoMessage 

func (*BucketResult) ProtoMessage()

func (*BucketResult) ProtoReflect 

func (x *BucketResult) ProtoReflect() protoreflect.Message

func (*BucketResult) Reset 

func (x *BucketResult) Reset()

func (*BucketResult) String 

func (x *BucketResult) String() string

type BucketResult_Bucket 

type BucketResult_Bucket struct {

	// Bucket key
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// Bucket item count
	Count int32 `protobuf:"varint,2,opt,name=count,proto3" json:"count,omitempty"`
	// Nested collector results for sub-aggregations of this bucket
	NestedCollectorResults map[string]*CollectorResult `` /* 185-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*BucketResult_Bucket) Descriptor deprecated 

func (*BucketResult_Bucket) Descriptor() ([]byte, []int)

Deprecated: Use BucketResult_Bucket.ProtoReflect.Descriptor instead.

func (*BucketResult_Bucket) GetCount 

func (x *BucketResult_Bucket) GetCount() int32

func (*BucketResult_Bucket) GetKey 

func (x *BucketResult_Bucket) GetKey() string

func (*BucketResult_Bucket) GetNestedCollectorResults added in v0.13.0 

func (x *BucketResult_Bucket) GetNestedCollectorResults() map[string]*CollectorResult

func (*BucketResult_Bucket) ProtoMessage 

func (*BucketResult_Bucket) ProtoMessage()

func (*BucketResult_Bucket) ProtoReflect 

func (x *BucketResult_Bucket) ProtoReflect() protoreflect.Message

func (*BucketResult_Bucket) Reset 

func (x *BucketResult_Bucket) Reset()

func (*BucketResult_Bucket) String 

func (x *BucketResult_Bucket) String() string

type Collector 

type Collector struct {

	// Types that are assignable to Collectors:
	//
	//	*Collector_Terms
	//	*Collector_PluginCollector
	//	*Collector_TopHitsCollector
	//	*Collector_Filter
	//	*Collector_Max
	//	*Collector_Min
	Collectors isCollector_Collectors `protobuf_oneof:"Collectors"`
	// Nested collectors that define sub-aggregations per bucket, supported by bucket based collectors
	NestedCollectors map[string]*Collector `` /* 173-byte string literal not displayed */
	// contains filtered or unexported fields
}

Definition of additional document collector

func (*Collector) Descriptor deprecated 

func (*Collector) Descriptor() ([]byte, []int)

Deprecated: Use Collector.ProtoReflect.Descriptor instead.

func (*Collector) GetCollectors 

func (m *Collector) GetCollectors() isCollector_Collectors

func (*Collector) GetFilter added in v0.19.0 

func (x *Collector) GetFilter() *FilterCollector

func (*Collector) GetMax added in v0.23.0 

func (x *Collector) GetMax() *MaxCollector

func (*Collector) GetMin added in v0.37.0 

func (x *Collector) GetMin() *MinCollector

func (*Collector) GetNestedCollectors added in v0.13.0 

func (x *Collector) GetNestedCollectors() map[string]*Collector

func (*Collector) GetPluginCollector added in v0.10.5 

func (x *Collector) GetPluginCollector() *PluginCollector

func (*Collector) GetTerms 

func (x *Collector) GetTerms() *TermsCollector

func (*Collector) GetTopHitsCollector added in v0.13.0 

func (x *Collector) GetTopHitsCollector() *TopHitsCollector

func (*Collector) ProtoMessage 

func (*Collector) ProtoMessage()

func (*Collector) ProtoReflect 

func (x *Collector) ProtoReflect() protoreflect.Message

func (*Collector) Reset 

func (x *Collector) Reset()

func (*Collector) String 

func (x *Collector) String() string

type CollectorResult 

type CollectorResult struct {

	// Types that are assignable to CollectorResults:
	//
	//	*CollectorResult_BucketResult
	//	*CollectorResult_AnyResult
	//	*CollectorResult_HitsResult
	//	*CollectorResult_FilterResult
	//	*CollectorResult_DoubleResult
	CollectorResults isCollectorResult_CollectorResults `protobuf_oneof:"CollectorResults"`
	// contains filtered or unexported fields
}

Result of aggregating collector

func (*CollectorResult) Descriptor deprecated 

func (*CollectorResult) Descriptor() ([]byte, []int)

Deprecated: Use CollectorResult.ProtoReflect.Descriptor instead.

func (*CollectorResult) GetAnyResult added in v0.10.5 

func (x *CollectorResult) GetAnyResult() *anypb.Any

func (*CollectorResult) GetBucketResult 

func (x *CollectorResult) GetBucketResult() *BucketResult

func (*CollectorResult) GetCollectorResults 

func (m *CollectorResult) GetCollectorResults() isCollectorResult_CollectorResults

func (*CollectorResult) GetDoubleResult added in v0.23.0 

func (x *CollectorResult) GetDoubleResult() *wrapperspb.DoubleValue

func (*CollectorResult) GetFilterResult added in v0.19.0 

func (x *CollectorResult) GetFilterResult() *FilterResult

func (*CollectorResult) GetHitsResult added in v0.13.0 

func (x *CollectorResult) GetHitsResult() *HitsResult

func (*CollectorResult) ProtoMessage 

func (*CollectorResult) ProtoMessage()

func (*CollectorResult) ProtoReflect 

func (x *CollectorResult) ProtoReflect() protoreflect.Message

func (*CollectorResult) Reset 

func (x *CollectorResult) Reset()

func (*CollectorResult) String 

func (x *CollectorResult) String() string

type CollectorResult_AnyResult added in v0.10.5 

type CollectorResult_AnyResult struct {
	// Flexible collector result for additional document collectors
	AnyResult *anypb.Any `protobuf:"bytes,2,opt,name=anyResult,proto3,oneof"`
}

type CollectorResult_BucketResult 

type CollectorResult_BucketResult struct {
	// Result of collector that produces buckets and counts
	BucketResult *BucketResult `protobuf:"bytes,1,opt,name=bucketResult,proto3,oneof"`
}

type CollectorResult_DoubleResult added in v0.23.0 

type CollectorResult_DoubleResult struct {
	// Result of collector that produces a single double value
	DoubleResult *wrapperspb.DoubleValue `protobuf:"bytes,6,opt,name=doubleResult,proto3,oneof"`
}

type CollectorResult_FilterResult added in v0.19.0 

type CollectorResult_FilterResult struct {
	// Result of collector that filters documents
	FilterResult *FilterResult `protobuf:"bytes,5,opt,name=filterResult,proto3,oneof"`
}

type CollectorResult_HitsResult added in v0.13.0 

type CollectorResult_HitsResult struct {
	// Result of collector that returns document hits
	HitsResult *HitsResult `protobuf:"bytes,4,opt,name=hitsResult,proto3,oneof"`
}

type Collector_Filter added in v0.19.0 

type Collector_Filter struct {
	// Collector that filters documents to nested collectors
	Filter *FilterCollector `protobuf:"bytes,5,opt,name=filter,proto3,oneof"`
}

type Collector_Max added in v0.23.0 

type Collector_Max struct {
	// Collector for finding a max double value from collected documents
	Max *MaxCollector `protobuf:"bytes,6,opt,name=max,proto3,oneof"`
}

type Collector_Min added in v0.37.0 

type Collector_Min struct {
	// Collector for finding a min double value from collected documents
	Min *MinCollector `protobuf:"bytes,7,opt,name=min,proto3,oneof"`
}

type Collector_PluginCollector added in v0.10.5 

type Collector_PluginCollector struct {
	PluginCollector *PluginCollector `protobuf:"bytes,2,opt,name=pluginCollector,proto3,oneof"`
}

type Collector_Terms 

type Collector_Terms struct {
	// Collector for aggregating based on term values
	Terms *TermsCollector `protobuf:"bytes,1,opt,name=terms,proto3,oneof"`
}

type Collector_TopHitsCollector added in v0.13.0 

type Collector_TopHitsCollector struct {
	// Collector for getting top hits based on score or sorting
	TopHitsCollector *TopHitsCollector `protobuf:"bytes,4,opt,name=topHitsCollector,proto3,oneof"`
}

type CommitRequest 

type CommitRequest struct {

	// Index name to commit
	IndexName string `protobuf:"bytes,1,opt,name=indexName,proto3" json:"indexName,omitempty"`
	// contains filtered or unexported fields
}

Input to commit

func (*CommitRequest) Descriptor deprecated 

func (*CommitRequest) Descriptor() ([]byte, []int)

Deprecated: Use CommitRequest.ProtoReflect.Descriptor instead.

func (*CommitRequest) GetIndexName 

func (x *CommitRequest) GetIndexName() string

func (*CommitRequest) ProtoMessage 

func (*CommitRequest) ProtoMessage()

func (*CommitRequest) ProtoReflect 

func (x *CommitRequest) ProtoReflect() protoreflect.Message

func (*CommitRequest) Reset 

func (x *CommitRequest) Reset()

func (*CommitRequest) String 

func (x *CommitRequest) String() string

type CommitResponse 

type CommitResponse struct {

	// Sequence number of the last operation in the commit. All sequence numbers less than this value
	// will be reflected in the commit, and all others will not.
	Gen int64 `protobuf:"varint,1,opt,name=gen,proto3" json:"gen,omitempty"`
	// Unique identifier for the primary instance that processed the request
	PrimaryId string `protobuf:"bytes,2,opt,name=primaryId,proto3" json:"primaryId,omitempty"`
	// contains filtered or unexported fields
}

Response from Server for commit

func (*CommitResponse) Descriptor deprecated 

func (*CommitResponse) Descriptor() ([]byte, []int)

Deprecated: Use CommitResponse.ProtoReflect.Descriptor instead.

func (*CommitResponse) GetGen 

func (x *CommitResponse) GetGen() int64

func (*CommitResponse) GetPrimaryId 

func (x *CommitResponse) GetPrimaryId() string

func (*CommitResponse) ProtoMessage 

func (*CommitResponse) ProtoMessage()

func (*CommitResponse) ProtoReflect 

func (x *CommitResponse) ProtoReflect() protoreflect.Message

func (*CommitResponse) Reset 

func (x *CommitResponse) Reset()

func (*CommitResponse) String 

func (x *CommitResponse) String() string

type CompletionQuery added in v0.16.0 

type CompletionQuery struct {

	// Name of the field in the document to query, must be a SuggestField
	Field string `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
	// Completion query type, used when constructing the lucene completion query
	QueryType CompletionQueryType `protobuf:"varint,2,opt,name=queryType,proto3,enum=luceneserver.CompletionQueryType" json:"queryType,omitempty"`
	// Completion text to be used in completion query
	Text string `protobuf:"bytes,3,opt,name=text,proto3" json:"text,omitempty"`
	// List of contexts to filter by. Each result will have at least one of the contexts specified
	Contexts []string `protobuf:"bytes,4,rep,name=contexts,proto3" json:"contexts,omitempty"`
	// contains filtered or unexported fields
}

A query used for suggest completion

func (*CompletionQuery) Descriptor deprecated added in v0.16.0 

func (*CompletionQuery) Descriptor() ([]byte, []int)

Deprecated: Use CompletionQuery.ProtoReflect.Descriptor instead.

func (*CompletionQuery) GetContexts added in v0.16.0 

func (x *CompletionQuery) GetContexts() []string

func (*CompletionQuery) GetField added in v0.16.0 

func (x *CompletionQuery) GetField() string

func (*CompletionQuery) GetQueryType added in v0.16.0 

func (x *CompletionQuery) GetQueryType() CompletionQueryType

func (*CompletionQuery) GetText added in v0.16.0 

func (x *CompletionQuery) GetText() string

func (*CompletionQuery) ProtoMessage added in v0.16.0 

func (*CompletionQuery) ProtoMessage()

func (*CompletionQuery) ProtoReflect added in v0.16.0 

func (x *CompletionQuery) ProtoReflect() protoreflect.Message

func (*CompletionQuery) Reset added in v0.16.0 

func (x *CompletionQuery) Reset()

func (*CompletionQuery) String added in v0.16.0 

func (x *CompletionQuery) String() string

type CompletionQueryType added in v0.16.0 

type CompletionQueryType int32

Type of completion query 

const (
	// PrefixCompletionQuery within ContextCompletionQuery
	CompletionQueryType_PREFIX_QUERY CompletionQueryType = 0
	// FuzzyCompletionQuery within ContextCompletionQuery
	CompletionQueryType_FUZZY_QUERY CompletionQueryType = 1
)

func (CompletionQueryType) Descriptor added in v0.16.0 

func (CompletionQueryType) Descriptor() protoreflect.EnumDescriptor

func (CompletionQueryType) Enum added in v0.16.0 

func (x CompletionQueryType) Enum() *CompletionQueryType

func (CompletionQueryType) EnumDescriptor deprecated added in v0.16.0 

func (CompletionQueryType) EnumDescriptor() ([]byte, []int)

Deprecated: Use CompletionQueryType.Descriptor instead.

func (CompletionQueryType) Number added in v0.16.0 

func (x CompletionQueryType) Number() protoreflect.EnumNumber

func (CompletionQueryType) String added in v0.16.0 

func (x CompletionQueryType) String() string

func (CompletionQueryType) Type added in v0.16.0 

func (CompletionQueryType) Type() protoreflect.EnumType

type ConditionalTokenFilter 

type ConditionalTokenFilter struct {

	// Condition to apply the token filter
	Condition *NameAndParams `protobuf:"bytes,1,opt,name=condition,proto3" json:"condition,omitempty"`
	// Token filters to apply if the condition is met
	TokenFilters []*NameAndParams `protobuf:"bytes,2,rep,name=tokenFilters,proto3" json:"tokenFilters,omitempty"`
	// contains filtered or unexported fields
}

Used to specify a conditional token filter

func (*ConditionalTokenFilter) Descriptor deprecated 

func (*ConditionalTokenFilter) Descriptor() ([]byte, []int)

Deprecated: Use ConditionalTokenFilter.ProtoReflect.Descriptor instead.

func (*ConditionalTokenFilter) GetCondition 

func (x *ConditionalTokenFilter) GetCondition() *NameAndParams

func (*ConditionalTokenFilter) GetTokenFilters 

func (x *ConditionalTokenFilter) GetTokenFilters() []*NameAndParams

func (*ConditionalTokenFilter) ProtoMessage 

func (*ConditionalTokenFilter) ProtoMessage()

func (*ConditionalTokenFilter) ProtoReflect 

func (x *ConditionalTokenFilter) ProtoReflect() protoreflect.Message

func (*ConditionalTokenFilter) Reset 

func (x *ConditionalTokenFilter) Reset()

func (*ConditionalTokenFilter) String 

func (x *ConditionalTokenFilter) String() string

type ConstantScoreQuery added in v0.21.0 

type ConstantScoreQuery struct {

	// Query to determine matching documents
	Filter *Query `protobuf:"bytes,1,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

Query that produces a score of 1.0 (modifiable by query boost value) for documents that match the filter query

func (*ConstantScoreQuery) Descriptor deprecated added in v0.21.0 

func (*ConstantScoreQuery) Descriptor() ([]byte, []int)

Deprecated: Use ConstantScoreQuery.ProtoReflect.Descriptor instead.

func (*ConstantScoreQuery) GetFilter added in v0.21.0 

func (x *ConstantScoreQuery) GetFilter() *Query

func (*ConstantScoreQuery) ProtoMessage added in v0.21.0 

func (*ConstantScoreQuery) ProtoMessage()

func (*ConstantScoreQuery) ProtoReflect added in v0.21.0 

func (x *ConstantScoreQuery) ProtoReflect() protoreflect.Message

func (*ConstantScoreQuery) Reset added in v0.21.0 

func (x *ConstantScoreQuery) Reset()

func (*ConstantScoreQuery) String added in v0.21.0 

func (x *ConstantScoreQuery) String() string

type CopyFiles 

type CopyFiles struct {

	// Magic number send on all requests since these are meant for internal communication only
	MagicNumber int32 `protobuf:"varint,1,opt,name=magicNumber,proto3" json:"magicNumber,omitempty"`
	// Index name
	IndexName string `protobuf:"bytes,2,opt,name=indexName,proto3" json:"indexName,omitempty"`
	// Primary generation
	PrimaryGen int64 `protobuf:"varint,3,opt,name=primaryGen,proto3" json:"primaryGen,omitempty"`
	// Files metadata to copy
	FilesMetadata *FilesMetadata `protobuf:"bytes,4,opt,name=filesMetadata,proto3" json:"filesMetadata,omitempty"`
	// Index id
	IndexId string `protobuf:"bytes,5,opt,name=indexId,proto3" json:"indexId,omitempty"`
	// contains filtered or unexported fields
}

Primary invokes this on a replica to ask it to copy files

func (*CopyFiles) Descriptor deprecated 

func (*CopyFiles) Descriptor() ([]byte, []int)

Deprecated: Use CopyFiles.ProtoReflect.Descriptor instead.

func (*CopyFiles) GetFilesMetadata 

func (x *CopyFiles) GetFilesMetadata() *FilesMetadata

func (*CopyFiles) GetIndexId added in v0.39.0 

func (x *CopyFiles) GetIndexId() string

func (*CopyFiles) GetIndexName 

func (x *CopyFiles) GetIndexName() string

func (*CopyFiles) GetMagicNumber 

func (x *CopyFiles) GetMagicNumber() int32

func (*CopyFiles) GetPrimaryGen 

func (x *CopyFiles) GetPrimaryGen() int64

func (*CopyFiles) ProtoMessage 

func (*CopyFiles) ProtoMessage()

func (*CopyFiles) ProtoReflect 

func (x *CopyFiles) ProtoReflect() protoreflect.Message

func (*CopyFiles) Reset 

func (x *CopyFiles) Reset()

func (*CopyFiles) String 

func (x *CopyFiles) String() string

type CopyState 

type CopyState struct {

	// InfoBytes length
	InfoBytesLength int32 `protobuf:"varint,1,opt,name=infoBytesLength,proto3" json:"infoBytesLength,omitempty"`
	// InfoBytes
	InfoBytes []byte `protobuf:"bytes,2,opt,name=infoBytes,proto3" json:"infoBytes,omitempty"`
	// Index generation
	Gen int64 `protobuf:"varint,3,opt,name=gen,proto3" json:"gen,omitempty"`
	// Index version
	Version int64 `protobuf:"varint,4,opt,name=version,proto3" json:"version,omitempty"`
	// Index file metadata
	FilesMetadata *FilesMetadata `protobuf:"bytes,5,opt,name=filesMetadata,proto3" json:"filesMetadata,omitempty"`
	// Completed merged files size
	CompletedMergeFilesSize int32 `protobuf:"varint,6,opt,name=completedMergeFilesSize,proto3" json:"completedMergeFilesSize,omitempty"`
	// Completed merged files
	CompletedMergeFiles []string `protobuf:"bytes,7,rep,name=completedMergeFiles,proto3" json:"completedMergeFiles,omitempty"`
	// Primary generation
	PrimaryGen int64 `protobuf:"varint,8,opt,name=primaryGen,proto3" json:"primaryGen,omitempty"`
	// contains filtered or unexported fields
}

Holds incRef'd file level details for one point-in-time segment infos on the primary node

func (*CopyState) Descriptor deprecated 

func (*CopyState) Descriptor() ([]byte, []int)

Deprecated: Use CopyState.ProtoReflect.Descriptor instead.

func (*CopyState) GetCompletedMergeFiles 

func (x *CopyState) GetCompletedMergeFiles() []string

func (*CopyState) GetCompletedMergeFilesSize 

func (x *CopyState) GetCompletedMergeFilesSize() int32

func (*CopyState) GetFilesMetadata 

func (x *CopyState) GetFilesMetadata() *FilesMetadata

func (*CopyState) GetGen 

func (x *CopyState) GetGen() int64

func (*CopyState) GetInfoBytes 

func (x *CopyState) GetInfoBytes() []byte

func (*CopyState) GetInfoBytesLength 

func (x *CopyState) GetInfoBytesLength() int32

func (*CopyState) GetPrimaryGen 

func (x *CopyState) GetPrimaryGen() int64

func (*CopyState) GetVersion 

func (x *CopyState) GetVersion() int64

func (*CopyState) ProtoMessage 

func (*CopyState) ProtoMessage()

func (*CopyState) ProtoReflect 

func (x *CopyState) ProtoReflect() protoreflect.Message

func (*CopyState) Reset 

func (x *CopyState) Reset()

func (*CopyState) String 

func (x *CopyState) String() string

type CopyStateRequest 

type CopyStateRequest struct {

	// Magic number send on all requests since these are meant for internal communication only
	MagicNumber int32 `protobuf:"varint,1,opt,name=magicNumber,proto3" json:"magicNumber,omitempty"`
	// Index name
	IndexName string `protobuf:"bytes,2,opt,name=indexName,proto3" json:"indexName,omitempty"`
	// Replica id
	ReplicaId int32 `protobuf:"varint,3,opt,name=replicaId,proto3" json:"replicaId,omitempty"`
	// Index id
	IndexId string `protobuf:"bytes,4,opt,name=indexId,proto3" json:"indexId,omitempty"`
	// contains filtered or unexported fields
}

Replica invokes this on a primary to let primary know it needs the CopyState

func (*CopyStateRequest) Descriptor deprecated 

func (*CopyStateRequest) Descriptor() ([]byte, []int)

Deprecated: Use CopyStateRequest.ProtoReflect.Descriptor instead.

func (*CopyStateRequest) GetIndexId added in v0.39.0 

func (x *CopyStateRequest) GetIndexId() string

func (*CopyStateRequest) GetIndexName 

func (x *CopyStateRequest) GetIndexName() string

func (*CopyStateRequest) GetMagicNumber 

func (x *CopyStateRequest) GetMagicNumber() int32

func (*CopyStateRequest) GetReplicaId 

func (x *CopyStateRequest) GetReplicaId() int32

func (*CopyStateRequest) ProtoMessage 

func (*CopyStateRequest) ProtoMessage()

func (*CopyStateRequest) ProtoReflect 

func (x *CopyStateRequest) ProtoReflect() protoreflect.Message

func (*CopyStateRequest) Reset 

func (x *CopyStateRequest) Reset()

func (*CopyStateRequest) String 

func (x *CopyStateRequest) String() string

type CreateIndexRequest 

type CreateIndexRequest struct {

	// Name of the index to be created. [a-zA-Z0-9_-]+
	IndexName string `protobuf:"bytes,1,opt,name=indexName,proto3" json:"indexName,omitempty"`
	// Set if state/data already exists in the data backend. Provides the yyyyMMddHHmmssSSS formatted date-time
	// string to identify and load the index data.
	ExistsWithId string `protobuf:"bytes,2,opt,name=existsWithId,proto3" json:"existsWithId,omitempty"`
	// Optional initial index settings
	Settings *IndexSettings `protobuf:"bytes,3,opt,name=settings,proto3" json:"settings,omitempty"`
	// Optional initial index live settings
	LiveSettings *IndexLiveSettings `protobuf:"bytes,4,opt,name=liveSettings,proto3" json:"liveSettings,omitempty"`
	// Optional initial index fields
	Fields []*Field `protobuf:"bytes,5,rep,name=fields,proto3" json:"fields,omitempty"`
	// If this index should also be started, using IndexStartConfig configuration
	Start bool `protobuf:"varint,6,opt,name=start,proto3" json:"start,omitempty"`
	// contains filtered or unexported fields
}

Input to createIndex

func (*CreateIndexRequest) Descriptor deprecated 

func (*CreateIndexRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateIndexRequest.ProtoReflect.Descriptor instead.

func (*CreateIndexRequest) GetExistsWithId added in v0.14.0 

func (x *CreateIndexRequest) GetExistsWithId() string

func (*CreateIndexRequest) GetFields added in v0.18.0 

func (x *CreateIndexRequest) GetFields() []*Field

func (*CreateIndexRequest) GetIndexName 

func (x *CreateIndexRequest) GetIndexName() string

func (*CreateIndexRequest) GetLiveSettings added in v0.18.0 

func (x *CreateIndexRequest) GetLiveSettings() *IndexLiveSettings

func (*CreateIndexRequest) GetSettings added in v0.18.0 

func (x *CreateIndexRequest) GetSettings() *IndexSettings

func (*CreateIndexRequest) GetStart added in v0.18.0 

func (x *CreateIndexRequest) GetStart() bool

func (*CreateIndexRequest) ProtoMessage 

func (*CreateIndexRequest) ProtoMessage()

func (*CreateIndexRequest) ProtoReflect 

func (x *CreateIndexRequest) ProtoReflect() protoreflect.Message

func (*CreateIndexRequest) Reset 

func (x *CreateIndexRequest) Reset()

func (*CreateIndexRequest) String 

func (x *CreateIndexRequest) String() string

type CreateIndexResponse 

type CreateIndexResponse struct {

	// Message confirming creation of the index
	Response string `protobuf:"bytes,1,opt,name=response,proto3" json:"response,omitempty"`
	// contains filtered or unexported fields
}

Response from Server to createIndex

func (*CreateIndexResponse) Descriptor deprecated 

func (*CreateIndexResponse) Descriptor() ([]byte, []int)

Deprecated: Use CreateIndexResponse.ProtoReflect.Descriptor instead.

func (*CreateIndexResponse) GetResponse 

func (x *CreateIndexResponse) GetResponse() string

func (*CreateIndexResponse) ProtoMessage 

func (*CreateIndexResponse) ProtoMessage()

func (*CreateIndexResponse) ProtoReflect 

func (x *CreateIndexResponse) ProtoReflect() protoreflect.Message

func (*CreateIndexResponse) Reset 

func (x *CreateIndexResponse) Reset()

func (*CreateIndexResponse) String 

func (x *CreateIndexResponse) String() string

type CreateSnapshotRequest 

type CreateSnapshotRequest struct {

	// Name of the index to snapshot
	IndexName string `protobuf:"bytes,1,opt,name=indexName,proto3" json:"indexName,omitempty"`
	// Pass true if you intend to do searches against this snapshot, by passing searcher: {snapshot: X} to @search
	OpenSearcher bool `protobuf:"varint,2,opt,name=openSearcher,proto3" json:"openSearcher,omitempty"`
	// contains filtered or unexported fields
}

Creates a snapshot in the index, which is saved point-in-time view of the last commit in the index such that no files referenced by that snapshot will be deleted by ongoing indexing until the snapshot is released with @releaseSnapshot. Note that this will reference the last commit, so be sure to call commit first if you have pending changes that you'd like to be included in the snapshot.<p>This can be used for backup purposes, i.e. after creating the snapshot you can copy all referenced files to backup storage, and then release the snapshot once complete. To restore the backup, just copy all the files back and restart the server. It can also be used for transactional purposes, i.e. if you sometimes need to search a specific snapshot instead of the current live index.<p>Creating a snapshot is very fast (does not require any file copying), but over time it will consume extra disk space as old segments are merged in the index. Be sure to release the snapshot once you're done. Snapshots survive shutdown and restart of the server. Returns all protected filenames referenced by this snapshot: these files will not change and will not be deleted until the snapshot is released. This returns the directories and files referenced by the snapshot.

func (*CreateSnapshotRequest) Descriptor deprecated 

func (*CreateSnapshotRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateSnapshotRequest.ProtoReflect.Descriptor instead.

func (*CreateSnapshotRequest) GetIndexName 

func (x *CreateSnapshotRequest) GetIndexName() string

func (*CreateSnapshotRequest) GetOpenSearcher 

func (x *CreateSnapshotRequest) GetOpenSearcher() bool

func (*CreateSnapshotRequest) ProtoMessage 

func (*CreateSnapshotRequest) ProtoMessage()

func (*CreateSnapshotRequest) ProtoReflect 

func (x *CreateSnapshotRequest) ProtoReflect() protoreflect.Message

func (*CreateSnapshotRequest) Reset 

func (x *CreateSnapshotRequest) Reset()

func (*CreateSnapshotRequest) String 

func (x *CreateSnapshotRequest) String() string

type CreateSnapshotResponse 

type CreateSnapshotResponse struct {

	// List of index files referenced by this snapshot
	IndexFiles []string `protobuf:"bytes,1,rep,name=indexFiles,proto3" json:"indexFiles,omitempty"`
	// List of taxonomy index files referenced by this snapshot
	TaxonomyFiles []string `protobuf:"bytes,2,rep,name=taxonomyFiles,proto3" json:"taxonomyFiles,omitempty"`
	// List of state index files referenced by this snapshot
	StateFiles []string `protobuf:"bytes,3,rep,name=stateFiles,proto3" json:"stateFiles,omitempty"`
	// Snapshot id
	SnapshotId *SnapshotId `protobuf:"bytes,4,opt,name=snapshotId,proto3" json:"snapshotId,omitempty"`
	// contains filtered or unexported fields
}

Response from Server for createSnapshot

func (*CreateSnapshotResponse) Descriptor deprecated 

func (*CreateSnapshotResponse) Descriptor() ([]byte, []int)

Deprecated: Use CreateSnapshotResponse.ProtoReflect.Descriptor instead.

func (*CreateSnapshotResponse) GetIndexFiles 

func (x *CreateSnapshotResponse) GetIndexFiles() []string

func (*CreateSnapshotResponse) GetSnapshotId 

func (x *CreateSnapshotResponse) GetSnapshotId() *SnapshotId

func (*CreateSnapshotResponse) GetStateFiles 

func (x *CreateSnapshotResponse) GetStateFiles() []string

func (*CreateSnapshotResponse) GetTaxonomyFiles 

func (x *CreateSnapshotResponse) GetTaxonomyFiles() []string

func (*CreateSnapshotResponse) ProtoMessage 

func (*CreateSnapshotResponse) ProtoMessage()

func (*CreateSnapshotResponse) ProtoReflect 

func (x *CreateSnapshotResponse) ProtoReflect() protoreflect.Message

func (*CreateSnapshotResponse) Reset 

func (x *CreateSnapshotResponse) Reset()

func (*CreateSnapshotResponse) String 

func (x *CreateSnapshotResponse) String() string

type CustomAnalyzer 

type CustomAnalyzer struct {

	// Specify a Lucene character filters (https://lucene.apache.org/core/9_12_0/core/org/apache/lucene/analysis/CharFilter.html)
	CharFilters []*NameAndParams `protobuf:"bytes,1,rep,name=charFilters,proto3" json:"charFilters,omitempty"`
	// Specify a Lucene tokenizer (https://lucene.apache.org/core/9_12_0/core/org/apache/lucene/analysis/Tokenizer.html)
	Tokenizer *NameAndParams `protobuf:"bytes,2,opt,name=tokenizer,proto3" json:"tokenizer,omitempty"`
	// Specify a Lucene token filter (https://lucene.apache.org/core/9_12_0/core/org/apache/lucene/analysis/TokenFilter.html)
	TokenFilters []*NameAndParams `protobuf:"bytes,3,rep,name=tokenFilters,proto3" json:"tokenFilters,omitempty"`
	// TODO: this is not properly supported yet, the only impl requires a protected terms file.
	ConditionalTokenFilters []*ConditionalTokenFilter `protobuf:"bytes,4,rep,name=conditionalTokenFilters,proto3" json:"conditionalTokenFilters,omitempty"`
	// Lucene version as LUCENE_X_Y_Z or X.Y.Z, LATEST by default
	DefaultMatchVersion string `protobuf:"bytes,5,opt,name=defaultMatchVersion,proto3" json:"defaultMatchVersion,omitempty"`
	// Must be >= 0
	PositionIncrementGap *IntObject `protobuf:"bytes,6,opt,name=positionIncrementGap,proto3" json:"positionIncrementGap,omitempty"`
	// Must be >= 0
	OffsetGap *IntObject `protobuf:"bytes,7,opt,name=offsetGap,proto3" json:"offsetGap,omitempty"`
	// contains filtered or unexported fields
}

Custom analyzer definition

func (*CustomAnalyzer) Descriptor deprecated 

func (*CustomAnalyzer) Descriptor() ([]byte, []int)

Deprecated: Use CustomAnalyzer.ProtoReflect.Descriptor instead.

func (*CustomAnalyzer) GetCharFilters 

func (x *CustomAnalyzer) GetCharFilters() []*NameAndParams

func (*CustomAnalyzer) GetConditionalTokenFilters 

func (x *CustomAnalyzer) GetConditionalTokenFilters() []*ConditionalTokenFilter

func (*CustomAnalyzer) GetDefaultMatchVersion 

func (x *CustomAnalyzer) GetDefaultMatchVersion() string

func (*CustomAnalyzer) GetOffsetGap 

func (x *CustomAnalyzer) GetOffsetGap() *IntObject

func (*CustomAnalyzer) GetPositionIncrementGap 

func (x *CustomAnalyzer) GetPositionIncrementGap() *IntObject

func (*CustomAnalyzer) GetTokenFilters 

func (x *CustomAnalyzer) GetTokenFilters() []*NameAndParams

func (*CustomAnalyzer) GetTokenizer 

func (x *CustomAnalyzer) GetTokenizer() *NameAndParams

func (*CustomAnalyzer) ProtoMessage 

func (*CustomAnalyzer) ProtoMessage()

func (*CustomAnalyzer) ProtoReflect 

func (x *CustomAnalyzer) ProtoReflect() protoreflect.Message

func (*CustomAnalyzer) Reset 

func (x *CustomAnalyzer) Reset()

func (*CustomAnalyzer) String 

func (x *CustomAnalyzer) String() string

type CustomRequest added in v0.11.0 

type CustomRequest struct {

	// ID defined for custom requests in a plugin
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Custom path that is defined in a plugin that maps to a route
	Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	// Parameters that can be processed by the plugin at the specified path
	Params map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

Input to custom

func (*CustomRequest) Descriptor deprecated added in v0.11.0 

func (*CustomRequest) Descriptor() ([]byte, []int)

Deprecated: Use CustomRequest.ProtoReflect.Descriptor instead.

func (*CustomRequest) GetId added in v0.11.0 

func (x *CustomRequest) GetId() string

func (*CustomRequest) GetParams added in v0.11.0 

func (x *CustomRequest) GetParams() map[string]string

func (*CustomRequest) GetPath added in v0.11.0 

func (x *CustomRequest) GetPath() string

func (*CustomRequest) ProtoMessage added in v0.11.0 

func (*CustomRequest) ProtoMessage()

func (*CustomRequest) ProtoReflect added in v0.11.0 

func (x *CustomRequest) ProtoReflect() protoreflect.Message

func (*CustomRequest) Reset added in v0.11.0 

func (x *CustomRequest) Reset()

func (*CustomRequest) String added in v0.11.0 

func (x *CustomRequest) String() string

type CustomResponse added in v0.11.0 

type CustomResponse struct {
	Response map[string]string `` // Custom response sent by the plugin
	/* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

Response from Server for custom

func (*CustomResponse) Descriptor deprecated added in v0.11.0 

func (*CustomResponse) Descriptor() ([]byte, []int)

Deprecated: Use CustomResponse.ProtoReflect.Descriptor instead.

func (*CustomResponse) GetResponse added in v0.11.0 

func (x *CustomResponse) GetResponse() map[string]string

func (*CustomResponse) ProtoMessage added in v0.11.0 

func (*CustomResponse) ProtoMessage()

func (*CustomResponse) ProtoReflect added in v0.11.0 

func (x *CustomResponse) ProtoReflect() protoreflect.Message

func (*CustomResponse) Reset added in v0.11.0 

func (x *CustomResponse) Reset()

func (*CustomResponse) String added in v0.11.0 

func (x *CustomResponse) String() string

type DeleteAllDocumentsRequest 

type DeleteAllDocumentsRequest struct {

	// Index name to delete all documents from
	IndexName string `protobuf:"bytes,1,opt,name=indexName,proto3" json:"indexName,omitempty"`
	// contains filtered or unexported fields
}

Input to deleteAllDocuments

func (*DeleteAllDocumentsRequest) Descriptor deprecated 

func (*DeleteAllDocumentsRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteAllDocumentsRequest.ProtoReflect.Descriptor instead.

func (*DeleteAllDocumentsRequest) GetIndexName 

func (x *DeleteAllDocumentsRequest) GetIndexName() string

func (*DeleteAllDocumentsRequest) ProtoMessage 

func (*DeleteAllDocumentsRequest) ProtoMessage()

func (*DeleteAllDocumentsRequest) ProtoReflect 

func (x *DeleteAllDocumentsRequest) ProtoReflect() protoreflect.Message

func (*DeleteAllDocumentsRequest) Reset 

func (x *DeleteAllDocumentsRequest) Reset()

func (*DeleteAllDocumentsRequest) String 

func (x *DeleteAllDocumentsRequest) String() string

type DeleteAllDocumentsResponse 

type DeleteAllDocumentsResponse struct {

	// Lucene index sequence number after deleting all documents
	GenId string `protobuf:"bytes,1,opt,name=genId,proto3" json:"genId,omitempty"`
	// contains filtered or unexported fields
}

Response from Server for deleteAllDocuments

func (*DeleteAllDocumentsResponse) Descriptor deprecated 

func (*DeleteAllDocumentsResponse) Descriptor() ([]byte, []int)

Deprecated: Use DeleteAllDocumentsResponse.ProtoReflect.Descriptor instead.

func (*DeleteAllDocumentsResponse) GetGenId 

func (x *DeleteAllDocumentsResponse) GetGenId() string

func (*DeleteAllDocumentsResponse) ProtoMessage 

func (*DeleteAllDocumentsResponse) ProtoMessage()

func (*DeleteAllDocumentsResponse) ProtoReflect 

func (x *DeleteAllDocumentsResponse) ProtoReflect() protoreflect.Message

func (*DeleteAllDocumentsResponse) Reset 

func (x *DeleteAllDocumentsResponse) Reset()

func (*DeleteAllDocumentsResponse) String 

func (x *DeleteAllDocumentsResponse) String() string

type DeleteByQueryRequest 

type DeleteByQueryRequest struct {

	// Index name to delete documents from
	IndexName string `protobuf:"bytes,1,opt,name=indexName,proto3" json:"indexName,omitempty"`
	// Queries to match documents to be deleted
	Query []*Query `protobuf:"bytes,2,rep,name=query,proto3" json:"query,omitempty"`
	// contains filtered or unexported fields
}

Input to deleteByQuery

func (*DeleteByQueryRequest) Descriptor deprecated 

func (*DeleteByQueryRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteByQueryRequest.ProtoReflect.Descriptor instead.

func (*DeleteByQueryRequest) GetIndexName 

func (x *DeleteByQueryRequest) GetIndexName() string

func (*DeleteByQueryRequest) GetQuery 

func (x *DeleteByQueryRequest) GetQuery() []*Query

func (*DeleteByQueryRequest) ProtoMessage 

func (*DeleteByQueryRequest) ProtoMessage()

func (*DeleteByQueryRequest) ProtoReflect 

func (x *DeleteByQueryRequest) ProtoReflect() protoreflect.Message

func (*DeleteByQueryRequest) Reset 

func (x *DeleteByQueryRequest) Reset()

func (*DeleteByQueryRequest) String 

func (x *DeleteByQueryRequest) String() string

type DeleteIndexRequest 

type DeleteIndexRequest struct {

	// Index name to delete
	IndexName string `protobuf:"bytes,1,opt,name=indexName,proto3" json:"indexName,omitempty"`
	// contains filtered or unexported fields
}

Input to deleteIndex

func (*DeleteIndexRequest) Descriptor deprecated 

func (*DeleteIndexRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteIndexRequest.ProtoReflect.Descriptor instead.

func (*DeleteIndexRequest) GetIndexName 

func (x *DeleteIndexRequest) GetIndexName() string

func (*DeleteIndexRequest) ProtoMessage 

func (*DeleteIndexRequest) ProtoMessage()

func (*DeleteIndexRequest) ProtoReflect 

func (x *DeleteIndexRequest) ProtoReflect() protoreflect.Message

func (*DeleteIndexRequest) Reset 

func (x *DeleteIndexRequest) Reset()

func (*DeleteIndexRequest) String 

func (x *DeleteIndexRequest) String() string

type DeleteIndexResponse 

type DeleteIndexResponse struct {

	// Returns "ok" string on success
	Ok string `protobuf:"bytes,1,opt,name=ok,proto3" json:"ok,omitempty"`
	// contains filtered or unexported fields
}

Response from Server for deleteIndex

func (*DeleteIndexResponse) Descriptor deprecated 

func (*DeleteIndexResponse) Descriptor() ([]byte, []int)

Deprecated: Use DeleteIndexResponse.ProtoReflect.Descriptor instead.

func (*DeleteIndexResponse) GetOk 

func (x *DeleteIndexResponse) GetOk() string

func (*DeleteIndexResponse) ProtoMessage 

func (*DeleteIndexResponse) ProtoMessage()

func (*DeleteIndexResponse) ProtoReflect 

func (x *DeleteIndexResponse) ProtoReflect() protoreflect.Message

func (*DeleteIndexResponse) Reset 

func (x *DeleteIndexResponse) Reset()

func (*DeleteIndexResponse) String 

func (x *DeleteIndexResponse) String() string

type DisjunctionMaxQuery 

type DisjunctionMaxQuery struct {

	// A list of all the disjuncts to add
	Disjuncts []*Query `protobuf:"bytes,1,rep,name=disjuncts,proto3" json:"disjuncts,omitempty"`
	// The score of each non-maximum disjunct for a document is multiplied by this weight and added into the
	// final score
	TieBreakerMultiplier float32 `protobuf:"fixed32,2,opt,name=tieBreakerMultiplier,proto3" json:"tieBreakerMultiplier,omitempty"`
	// contains filtered or unexported fields
}

A query that generates the union of documents produced by its subqueries, and that scores each document with the maximum score for that document as produced by any subquery, plus a tie breaking increment for any additional matching subqueries.

func (*DisjunctionMaxQuery) Descriptor deprecated 

func (*DisjunctionMaxQuery) Descriptor() ([]byte, []int)

Deprecated: Use DisjunctionMaxQuery.ProtoReflect.Descriptor instead.

func (*DisjunctionMaxQuery) GetDisjuncts 

func (x *DisjunctionMaxQuery) GetDisjuncts() []*Query

func (*DisjunctionMaxQuery) GetTieBreakerMultiplier 

func (x *DisjunctionMaxQuery) GetTieBreakerMultiplier() float32

func (*DisjunctionMaxQuery) ProtoMessage 

func (*DisjunctionMaxQuery) ProtoMessage()

func (*DisjunctionMaxQuery) ProtoReflect 

func (x *DisjunctionMaxQuery) ProtoReflect() protoreflect.Message

func (*DisjunctionMaxQuery) Reset 

func (x *DisjunctionMaxQuery) Reset()

func (*DisjunctionMaxQuery) String 

func (x *DisjunctionMaxQuery) String() string

type DummyResponse 

type DummyResponse struct {

	// Returns "ok" string on success
	Ok string `protobuf:"bytes,1,opt,name=ok,proto3" json:"ok,omitempty"`
	// contains filtered or unexported fields
}

Response with no content

func (*DummyResponse) Descriptor deprecated 

func (*DummyResponse) Descriptor() ([]byte, []int)

Deprecated: Use DummyResponse.ProtoReflect.Descriptor instead.

func (*DummyResponse) GetOk 

func (x *DummyResponse) GetOk() string

func (*DummyResponse) ProtoMessage 

func (*DummyResponse) ProtoMessage()

func (*DummyResponse) ProtoReflect 

func (x *DummyResponse) ProtoReflect() protoreflect.Message

func (*DummyResponse) Reset 

func (x *DummyResponse) Reset()

func (*DummyResponse) String 

func (x *DummyResponse) String() string

type ExactVectorQuery 

type ExactVectorQuery struct {

	// Field in the document to query
	Field string `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
	// Query vector for fields with the float element type
	QueryFloatVector []float32 `protobuf:"fixed32,2,rep,packed,name=query_float_vector,json=queryFloatVector,proto3" json:"query_float_vector,omitempty"`
	// Query vector for fields with the byte element type
	QueryByteVector []byte `protobuf:"bytes,3,opt,name=query_byte_vector,json=queryByteVector,proto3" json:"query_byte_vector,omitempty"`
	// contains filtered or unexported fields
}

A query that does a brute force search for documents with a vector most similar to the query vector

func (*ExactVectorQuery) Descriptor deprecated 

func (*ExactVectorQuery) Descriptor() ([]byte, []int)

Deprecated: Use ExactVectorQuery.ProtoReflect.Descriptor instead.

func (*ExactVectorQuery) GetField 

func (x *ExactVectorQuery) GetField() string

func (*ExactVectorQuery) GetQueryByteVector 

func (x *ExactVectorQuery) GetQueryByteVector() []byte

func (*ExactVectorQuery) GetQueryFloatVector 

func (x *ExactVectorQuery) GetQueryFloatVector() []float32

func (*ExactVectorQuery) ProtoMessage 

func (*ExactVectorQuery) ProtoMessage()

func (*ExactVectorQuery) ProtoReflect 

func (x *ExactVectorQuery) ProtoReflect() protoreflect.Message

func (*ExactVectorQuery) Reset 

func (x *ExactVectorQuery) Reset()

func (*ExactVectorQuery) String 

func (x *ExactVectorQuery) String() string

type ExistsQuery 

type ExistsQuery struct {

	// Field in the document to query
	Field string `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
	// contains filtered or unexported fields
}

A query that matches documents which contain a value for a field

func (*ExistsQuery) Descriptor deprecated 

func (*ExistsQuery) Descriptor() ([]byte, []int)

Deprecated: Use ExistsQuery.ProtoReflect.Descriptor instead.

func (*ExistsQuery) GetField 

func (x *ExistsQuery) GetField() string

func (*ExistsQuery) ProtoMessage 

func (*ExistsQuery) ProtoMessage()

func (*ExistsQuery) ProtoReflect 

func (x *ExistsQuery) ProtoReflect() protoreflect.Message

func (*ExistsQuery) Reset 

func (x *ExistsQuery) Reset()

func (*ExistsQuery) String 

func (x *ExistsQuery) String() string

type Facet 

type Facet struct {

	// Dimension (field)
	Dim string `protobuf:"bytes,1,opt,name=dim,proto3" json:"dim,omitempty"`
	// Prefix path to facet 'under'
	Paths []string `protobuf:"bytes,2,rep,name=paths,proto3" json:"paths,omitempty"`
	// Custom numeric ranges. Field must be indexed with facet=numericRange.
	NumericRange []*NumericRangeType `protobuf:"bytes,3,rep,name=numericRange,proto3" json:"numericRange,omitempty"`
	// No longer used
	//
	// Deprecated: Do not use.
	UseOrdsCache bool `protobuf:"varint,4,opt,name=useOrdsCache,proto3" json:"useOrdsCache,omitempty"`
	// Specific facet labels to retrieve
	Labels []string `protobuf:"bytes,5,rep,name=labels,proto3" json:"labels,omitempty"`
	// How many top facets to return
	TopN int32 `protobuf:"varint,6,opt,name=topN,proto3" json:"topN,omitempty"`
	// FacetScript definition to use in place of index facet
	Script *Script `protobuf:"bytes,7,opt,name=script,proto3" json:"script,omitempty"`
	// Facet over the top N ranked documents, instead of all hits. Only works with field doc values.
	SampleTopDocs int32 `protobuf:"varint,8,opt,name=sampleTopDocs,proto3" json:"sampleTopDocs,omitempty"`
	// Name for this facet
	Name string `protobuf:"bytes,9,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Facet request definition

func (*Facet) Descriptor deprecated 

func (*Facet) Descriptor() ([]byte, []int)

Deprecated: Use Facet.ProtoReflect.Descriptor instead.

func (*Facet) GetDim 

func (x *Facet) GetDim() string

func (*Facet) GetLabels 

func (x *Facet) GetLabels() []string

func (*Facet) GetName 

func (x *Facet) GetName() string

func (*Facet) GetNumericRange 

func (x *Facet) GetNumericRange() []*NumericRangeType

func (*Facet) GetPaths 

func (x *Facet) GetPaths() []string

func (*Facet) GetSampleTopDocs 

func (x *Facet) GetSampleTopDocs() int32

func (*Facet) GetScript 

func (x *Facet) GetScript() *Script

func (*Facet) GetTopN 

func (x *Facet) GetTopN() int32

func (*Facet) GetUseOrdsCache deprecated 

func (x *Facet) GetUseOrdsCache() bool

Deprecated: Do not use.

func (*Facet) ProtoMessage 

func (*Facet) ProtoMessage()

func (*Facet) ProtoReflect 

func (x *Facet) ProtoReflect() protoreflect.Message

func (*Facet) Reset 

func (x *Facet) Reset()

func (*Facet) String 

func (x *Facet) String() string

type FacetHierarchyPath 

type FacetHierarchyPath struct {

	// Facet path
	Value []string `protobuf:"bytes,1,rep,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Path for hierarchical facets

func (*FacetHierarchyPath) Descriptor deprecated 

func (*FacetHierarchyPath) Descriptor() ([]byte, []int)

Deprecated: Use FacetHierarchyPath.ProtoReflect.Descriptor instead.

func (*FacetHierarchyPath) GetValue 

func (x *FacetHierarchyPath) GetValue() []string

func (*FacetHierarchyPath) ProtoMessage 

func (*FacetHierarchyPath) ProtoMessage()

func (*FacetHierarchyPath) ProtoReflect 

func (x *FacetHierarchyPath) ProtoReflect() protoreflect.Message

func (*FacetHierarchyPath) Reset 

func (x *FacetHierarchyPath) Reset()

func (*FacetHierarchyPath) String 

func (x *FacetHierarchyPath) String() string

type FacetResult 

type FacetResult struct {

	// Dimension that was requested
	Dim string `protobuf:"bytes,1,opt,name=dim,proto3" json:"dim,omitempty"`
	// Path whose children were requested
	Path []string `protobuf:"bytes,2,rep,name=path,proto3" json:"path,omitempty"`
	// Total value for this path (sum of all child counts, or sum of all child values), even those not included
	// in the topN
	Value float64 `protobuf:"fixed64,3,opt,name=value,proto3" json:"value,omitempty"`
	// Child counts
	LabelValues []*LabelAndValue `protobuf:"bytes,4,rep,name=labelValues,proto3" json:"labelValues,omitempty"`
	// How many child labels were encountered
	ChildCount int64 `protobuf:"varint,5,opt,name=childCount,proto3" json:"childCount,omitempty"`
	// Name for this facet
	Name string `protobuf:"bytes,6,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Result of facet collection

func (*FacetResult) Descriptor deprecated 

func (*FacetResult) Descriptor() ([]byte, []int)

Deprecated: Use FacetResult.ProtoReflect.Descriptor instead.

func (*FacetResult) GetChildCount 

func (x *FacetResult) GetChildCount() int64

func (*FacetResult) GetDim 

func (x *FacetResult) GetDim() string

func (*FacetResult) GetLabelValues 

func (x *FacetResult) GetLabelValues() []*LabelAndValue

func (*FacetResult) GetName 

func (x *FacetResult) GetName() string

func (*FacetResult) GetPath 

func (x *FacetResult) GetPath() []string

func (*FacetResult) GetValue 

func (x *FacetResult) GetValue() float64

func (*FacetResult) ProtoMessage 

func (*FacetResult) ProtoMessage()

func (*FacetResult) ProtoReflect 

func (x *FacetResult) ProtoReflect() protoreflect.Message

func (*FacetResult) Reset 

func (x *FacetResult) Reset()

func (*FacetResult) String 

func (x *FacetResult) String() string

type FacetType 

type FacetType int32

Whether/how facets should be indexed 

const (
	// No facets are indexed
	FacetType_NO_FACETS FacetType = 0
	// Facets are indexed with no hierarchy
	FacetType_FLAT FacetType = 1
	// Facets are indexed and are hierarchical
	FacetType_HIERARCHY FacetType = 2
	// Compute facet counts for custom numeric ranges
	FacetType_NUMERIC_RANGE FacetType = 3
	// Uses SortedSetDocValuesFacetCounts, which must be flat but don't require a taxonomy index
	FacetType_SORTED_SET_DOC_VALUES FacetType = 4
)

func (FacetType) Descriptor 

func (FacetType) Descriptor() protoreflect.EnumDescriptor

func (FacetType) Enum 

func (x FacetType) Enum() *FacetType

func (FacetType) EnumDescriptor deprecated 

func (FacetType) EnumDescriptor() ([]byte, []int)

Deprecated: Use FacetType.Descriptor instead.

func (FacetType) Number 

func (x FacetType) Number() protoreflect.EnumNumber

func (FacetType) String 

func (x FacetType) String() string

func (FacetType) Type 

func (FacetType) Type() protoreflect.EnumType

type FetchTask 

type FetchTask struct {

	// Name of task, as registered by a FetchTaskPlugin
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional task parameters
	Params *structpb.Struct `protobuf:"bytes,2,opt,name=params,proto3" json:"params,omitempty"`
	// contains filtered or unexported fields
}

Define additional task to perform in the fetch phase

func (*FetchTask) Descriptor deprecated 

func (*FetchTask) Descriptor() ([]byte, []int)

Deprecated: Use FetchTask.ProtoReflect.Descriptor instead.

func (*FetchTask) GetName 

func (x *FetchTask) GetName() string

func (*FetchTask) GetParams 

func (x *FetchTask) GetParams() *structpb.Struct

func (*FetchTask) ProtoMessage 

func (*FetchTask) ProtoMessage()

func (*FetchTask) ProtoReflect 

func (x *FetchTask) ProtoReflect() protoreflect.Message

func (*FetchTask) Reset 

func (x *FetchTask) Reset()

func (*FetchTask) String 

func (x *FetchTask) String() string

type Field 

type Field struct {

	// Name of the field
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Type of the field
	Type FieldType `protobuf:"varint,2,opt,name=type,proto3,enum=luceneserver.FieldType" json:"type,omitempty"`
	// True if the value should be available for searching (or numeric range searching, for a numeric fields)
	Search bool `protobuf:"varint,3,opt,name=search,proto3" json:"search,omitempty"`
	// True if the value should be stored in the index
	Store bool `protobuf:"varint,4,opt,name=store,proto3" json:"store,omitempty"`
	// True if the value should be indexed into doc values
	StoreDocValues bool `protobuf:"varint,5,opt,name=storeDocValues,proto3" json:"storeDocValues,omitempty"`
	// No longer used
	//
	// Deprecated: Do not use.
	Sort bool `protobuf:"varint,6,opt,name=sort,proto3" json:"sort,omitempty"`
	// No longer used
	//
	// Deprecated: Do not use.
	Tokenize bool `protobuf:"varint,7,opt,name=tokenize,proto3" json:"tokenize,omitempty"`
	// No longer used
	//
	// Deprecated: Do not use.
	Group bool `protobuf:"varint,8,opt,name=group,proto3" json:"group,omitempty"`
	// True if this field may have more than one value
	MultiValued bool `protobuf:"varint,9,opt,name=multiValued,proto3" json:"multiValued,omitempty"`
	// No longer used
	//
	// Deprecated: Do not use.
	Highlight bool `protobuf:"varint,10,opt,name=highlight,proto3" json:"highlight,omitempty"`
	// True if norms are omitted for text fields
	OmitNorms bool `protobuf:"varint,11,opt,name=omitNorms,proto3" json:"omitNorms,omitempty"`
	// Format string used to parse datetime fields, supported values are:
	//  1. DateTimeFormatter format
	//  2. "epoch_millis" (datetime value is epoch timestamp)
	//  3. "strict_date_optional_time" (date with optional time in pattern of "yyyy-MM-dd['T'HH:mm:ss[.SSS]]")
	DateTimeFormat string `protobuf:"bytes,12,opt,name=dateTimeFormat,proto3" json:"dateTimeFormat,omitempty"`
	// Which PostingsFormat should be used to index this field, defaults to Lucene codec default
	PostingsFormat string `protobuf:"bytes,13,opt,name=postingsFormat,proto3" json:"postingsFormat,omitempty"`
	// Which DocValuesFormat should be used to index this field, defaults to Lucene codec default
	DocValuesFormat string `protobuf:"bytes,14,opt,name=docValuesFormat,proto3" json:"docValuesFormat,omitempty"`
	// How the tokens should be indexed for text fields
	IndexOptions IndexOptions `protobuf:"varint,15,opt,name=indexOptions,proto3,enum=luceneserver.IndexOptions" json:"indexOptions,omitempty"`
	// The script definition defining a virtual field's value (only used with type=virtual)
	Script *Script `protobuf:"bytes,16,opt,name=script,proto3" json:"script,omitempty"`
	// Analyzer to use for this field during indexing and searching, defaults to Lucene standard analyzer
	Analyzer *Analyzer `protobuf:"bytes,17,opt,name=analyzer,proto3" json:"analyzer,omitempty"`
	// Analyzer to use for this field during indexing, if different from analyzer
	IndexAnalyzer *Analyzer `protobuf:"bytes,18,opt,name=indexAnalyzer,proto3" json:"indexAnalyzer,omitempty"`
	// Analyzer to use for this field during searching, if different from analyzer
	SearchAnalyzer *Analyzer `protobuf:"bytes,19,opt,name=searchAnalyzer,proto3" json:"searchAnalyzer,omitempty"`
	// Whether/how term vectors should be indexed
	TermVectors TermVectors `protobuf:"varint,20,opt,name=termVectors,proto3,enum=luceneserver.TermVectors" json:"termVectors,omitempty"`
	// Which Similarity implementation to use for this field, defaults to BM25Similarity
	Similarity string `protobuf:"bytes,21,opt,name=similarity,proto3" json:"similarity,omitempty"`
	// Whether/how facets should be indexed
	Facet FacetType `protobuf:"varint,22,opt,name=facet,proto3,enum=luceneserver.FacetType" json:"facet,omitempty"`
	// Which underlying Lucene index field is used to hold any indexed taxonomy or sorted set doc values facets,
	// defaults to '$_<field_name>'
	FacetIndexFieldName string `protobuf:"bytes,23,opt,name=facetIndexFieldName,proto3" json:"facetIndexFieldName,omitempty"`
	// Additional info needed to configure field, used for CUSTOM types
	AdditionalProperties *structpb.Struct `protobuf:"bytes,24,opt,name=additionalProperties,proto3" json:"additionalProperties,omitempty"`
	// Parameters for similarity implementation
	SimilarityParams *structpb.Struct `protobuf:"bytes,25,opt,name=similarityParams,proto3" json:"similarityParams,omitempty"`
	// Child fields accessible by dot notation. For standard fields, this indexes the same data as the parent field.
	// For object fields, this represents the subfields within the object.
	ChildFields []*Field `protobuf:"bytes,26,rep,name=childFields,proto3" json:"childFields,omitempty"`
	// Compute facet global ordinals for this field up front, otherwise this is done lazily on first query.
	// Currently only for SORTED_SET_DOC_VALUES facet type.
	EagerGlobalOrdinals bool `protobuf:"varint,27,opt,name=eagerGlobalOrdinals,proto3" json:"eagerGlobalOrdinals,omitempty"`
	// True if object data should be indexed as child documents
	NestedDoc bool `protobuf:"varint,28,opt,name=nestedDoc,proto3" json:"nestedDoc,omitempty"`
	// Dimensions for vector field types
	VectorDimensions int32 `protobuf:"varint,29,opt,name=vectorDimensions,proto3" json:"vectorDimensions,omitempty"`
	// If field based global ordinals should be built up front, otherwise this is done lazily on first access.
	// Currently only for fields with text doc values (TEXT/ATOM).
	EagerFieldGlobalOrdinals bool `protobuf:"varint,30,opt,name=eagerFieldGlobalOrdinals,proto3" json:"eagerFieldGlobalOrdinals,omitempty"`
	// Similarity type for search enabled VECTOR fields. This is a required option when search=true.
	// Accepts built in types:
	//
	//	'l2_norm'          : (1 / (1 + l2_norm(query, vector)^2))
	//	'dot_product'      : Float vector: ((1 + dot_product(query, vector)) / 2) (all vectors must be unit length)
	//	                     Byte vector : 0.5 + (dot_product(query, vector) / (32768 * dims))
	//	                        (all vectors must have the same length)
	//	'cosine'           : ((1 + cosine(query, vector)) / 2)
	//	'normalized_cosine': Identical usage to 'cosine', but indexed and query vectors are automatically normalized
	//	                     to unit length. Original vector magnitude is available in the <field>._magnitude field.
	//	'max_inner_product': when < 0 : 1 / (1 + -1 * max_inner_product(query, vector))
	//	                     when >= 0: max_inner_product(query, vector) + 1
	VectorSimilarity string `protobuf:"bytes,31,opt,name=vectorSimilarity,proto3" json:"vectorSimilarity,omitempty"`
	// Indexing options for search enabled VECTOR field type. This is optional, defaulting to HNSW with m=16,
	// ef_construction=100 when not set.
	VectorIndexingOptions *VectorIndexingOptions `protobuf:"bytes,32,opt,name=vectorIndexingOptions,proto3" json:"vectorIndexingOptions,omitempty"`
	// Specify doc values type for TEXT/ATOM field types. This is optional, defaulting to SORTED when not set.
	// Multivalued fields will always use SORTED_SET.
	TextDocValuesType TextDocValuesType `protobuf:"varint,33,opt,name=textDocValuesType,proto3,enum=luceneserver.TextDocValuesType" json:"textDocValuesType,omitempty"`
	// Element type for vector field, defaulting to FLOAT when not set
	VectorElementType VectorElementType `protobuf:"varint,34,opt,name=vectorElementType,proto3,enum=luceneserver.VectorElementType" json:"vectorElementType,omitempty"`
	// Position increment gap for indexing multi valued TEXT fields. Must be >= 0, defaulting to 100 when not set.
	PositionIncrementGap *int32 `protobuf:"varint,35,opt,name=positionIncrementGap,proto3,oneof" json:"positionIncrementGap,omitempty"`
	// For arrays of strings, ignoreAbove will be applied for each array element separately and string elements longer
	// than ignore_above will not be indexed or stored. This option is useful for protecting against Lucene’s
	// term byte-length limit of 32766
	IgnoreAbove *int32 `protobuf:"varint,36,opt,name=ignoreAbove,proto3,oneof" json:"ignoreAbove,omitempty"`
	// contains filtered or unexported fields
}

Definition of a field in an index

func (*Field) Descriptor deprecated 

func (*Field) Descriptor() ([]byte, []int)

Deprecated: Use Field.ProtoReflect.Descriptor instead.

func (*Field) GetAdditionalProperties 

func (x *Field) GetAdditionalProperties() *structpb.Struct

func (*Field) GetAnalyzer 

func (x *Field) GetAnalyzer() *Analyzer

func (*Field) GetChildFields 

func (x *Field) GetChildFields() []*Field

func (*Field) GetDateTimeFormat 

func (x *Field) GetDateTimeFormat() string

func (*Field) GetDocValuesFormat 

func (x *Field) GetDocValuesFormat() string

func (*Field) GetEagerFieldGlobalOrdinals added in v0.13.0 

func (x *Field) GetEagerFieldGlobalOrdinals() bool

func (*Field) GetEagerGlobalOrdinals 

func (x *Field) GetEagerGlobalOrdinals() bool

func (*Field) GetFacet 

func (x *Field) GetFacet() FacetType

func (*Field) GetFacetIndexFieldName 

func (x *Field) GetFacetIndexFieldName() string

func (*Field) GetGroup deprecated 

func (x *Field) GetGroup() bool

Deprecated: Do not use.

func (*Field) GetHighlight deprecated 

func (x *Field) GetHighlight() bool

Deprecated: Do not use.

func (*Field) GetIgnoreAbove added in v0.41.0 

func (x *Field) GetIgnoreAbove() int32

func (*Field) GetIndexAnalyzer 

func (x *Field) GetIndexAnalyzer() *Analyzer

func (*Field) GetIndexOptions 

func (x *Field) GetIndexOptions() IndexOptions

func (*Field) GetMultiValued 

func (x *Field) GetMultiValued() bool

func (*Field) GetName 

func (x *Field) GetName() string

func (*Field) GetNestedDoc 

func (x *Field) GetNestedDoc() bool

func (*Field) GetOmitNorms 

func (x *Field) GetOmitNorms() bool

func (*Field) GetPositionIncrementGap 

func (x *Field) GetPositionIncrementGap() int32

func (*Field) GetPostingsFormat 

func (x *Field) GetPostingsFormat() string

func (*Field) GetScript 

func (x *Field) GetScript() *Script

func (*Field) GetSearch 

func (x *Field) GetSearch() bool

func (*Field) GetSearchAnalyzer 

func (x *Field) GetSearchAnalyzer() *Analyzer

func (*Field) GetSimilarity 

func (x *Field) GetSimilarity() string

func (*Field) GetSimilarityParams 

func (x *Field) GetSimilarityParams() *structpb.Struct

func (*Field) GetSort deprecated 

func (x *Field) GetSort() bool

Deprecated: Do not use.

func (*Field) GetStore 

func (x *Field) GetStore() bool

func (*Field) GetStoreDocValues 

func (x *Field) GetStoreDocValues() bool

func (*Field) GetTermVectors 

func (x *Field) GetTermVectors() TermVectors

func (*Field) GetTextDocValuesType 

func (x *Field) GetTextDocValuesType() TextDocValuesType

func (*Field) GetTokenize deprecated 

func (x *Field) GetTokenize() bool

Deprecated: Do not use.

func (*Field) GetType 

func (x *Field) GetType() FieldType

func (*Field) GetVectorDimensions added in v0.10.5 

func (x *Field) GetVectorDimensions() int32

func (*Field) GetVectorElementType 

func (x *Field) GetVectorElementType() VectorElementType

func (*Field) GetVectorIndexingOptions 

func (x *Field) GetVectorIndexingOptions() *VectorIndexingOptions

func (*Field) GetVectorSimilarity 

func (x *Field) GetVectorSimilarity() string

func (*Field) ProtoMessage 

func (*Field) ProtoMessage()

func (*Field) ProtoReflect 

func (x *Field) ProtoReflect() protoreflect.Message

func (*Field) Reset 

func (x *Field) Reset()

func (*Field) String 

func (x *Field) String() string

type FieldDefRequest 

type FieldDefRequest struct {

	// Name of index to add fields to
	IndexName string `protobuf:"bytes,1,opt,name=indexName,proto3" json:"indexName,omitempty"`
	// List of fields to add
	Field []*Field `protobuf:"bytes,2,rep,name=field,proto3" json:"field,omitempty"`
	// contains filtered or unexported fields
}

Input to registerFields

func (*FieldDefRequest) Descriptor deprecated 

func (*FieldDefRequest) Descriptor() ([]byte, []int)

Deprecated: Use FieldDefRequest.ProtoReflect.Descriptor instead.

func (*FieldDefRequest) GetField 

func (x *FieldDefRequest) GetField() []*Field

func (*FieldDefRequest) GetIndexName 

func (x *FieldDefRequest) GetIndexName() string

func (*FieldDefRequest) ProtoMessage 

func (*FieldDefRequest) ProtoMessage()

func (*FieldDefRequest) ProtoReflect 

func (x *FieldDefRequest) ProtoReflect() protoreflect.Message

func (*FieldDefRequest) Reset 

func (x *FieldDefRequest) Reset()

func (*FieldDefRequest) String 

func (x *FieldDefRequest) String() string

type FieldDefResponse 

type FieldDefResponse struct {

	// Json string of object containing all index fields (including newly added fields)
	Response string `protobuf:"bytes,1,opt,name=response,proto3" json:"response,omitempty"`
	// contains filtered or unexported fields
}

Response from Server for registerFields

func (*FieldDefResponse) Descriptor deprecated 

func (*FieldDefResponse) Descriptor() ([]byte, []int)

Deprecated: Use FieldDefResponse.ProtoReflect.Descriptor instead.

func (*FieldDefResponse) GetResponse 

func (x *FieldDefResponse) GetResponse() string

func (*FieldDefResponse) ProtoMessage 

func (*FieldDefResponse) ProtoMessage()

func (*FieldDefResponse) ProtoReflect 

func (x *FieldDefResponse) ProtoReflect() protoreflect.Message

func (*FieldDefResponse) Reset 

func (x *FieldDefResponse) Reset()

func (*FieldDefResponse) String 

func (x *FieldDefResponse) String() string

type FieldType 

type FieldType int32

Type of a Field 

const (
	// Text that's indexed as a single token, with DOCS_ONLY and omitting norms
	FieldType_ATOM FieldType = 0
	// Text that's tokenized and indexed, with the index-time analyzer
	FieldType_TEXT FieldType = 1
	// Boolean value
	FieldType_BOOLEAN FieldType = 2
	// Long value
	FieldType_LONG FieldType = 3
	// Int value
	FieldType_INT FieldType = 4
	// Double value
	FieldType_DOUBLE FieldType = 5
	// Float value
	FieldType_FLOAT FieldType = 6
	// A latitude/longitude point
	FieldType_LAT_LON FieldType = 7
	// Date and optional time
	FieldType_DATE_TIME FieldType = 8
	// Virtual field defined with a Script
	FieldType_VIRTUAL FieldType = 9
	// Internal field, not currently used
	FieldType_INTERNAL FieldType = 10
	// Field type specified by name
	FieldType_CUSTOM FieldType = 11
	// Field type for document ID
	FieldType__ID FieldType = 12
	// Geojson defined polygon
	FieldType_POLYGON FieldType = 13
	// Json object with child fields for each key
	FieldType_OBJECT FieldType = 14
	// List of float values
	FieldType_VECTOR FieldType = 15
	// Field used for contextual suggest fields
	FieldType_CONTEXT_SUGGEST FieldType = 16
	// Runtime fields
	FieldType_RUNTIME FieldType = 17
)

func (FieldType) Descriptor 

func (FieldType) Descriptor() protoreflect.EnumDescriptor

func (FieldType) Enum 

func (x FieldType) Enum() *FieldType

func (FieldType) EnumDescriptor deprecated 

func (FieldType) EnumDescriptor() ([]byte, []int)

Deprecated: Use FieldType.Descriptor instead.

func (FieldType) Number 

func (x FieldType) Number() protoreflect.EnumNumber

func (FieldType) String 

func (x FieldType) String() string

func (FieldType) Type 

func (FieldType) Type() protoreflect.EnumType

type FileInfo 

type FileInfo struct {

	// Name of the file the replica wants primary to send
	FileName string `protobuf:"bytes,1,opt,name=fileName,proto3" json:"fileName,omitempty"`
	// Starting offset in the file primary should start sending bytes from
	FpStart int64 `protobuf:"varint,2,opt,name=fpStart,proto3" json:"fpStart,omitempty"`
	// Index name these files belong to
	IndexName string `protobuf:"bytes,3,opt,name=indexName,proto3" json:"indexName,omitempty"`
	// Sequence number to ack, only used for acked file copy
	AckSeqNum int32 `protobuf:"varint,4,opt,name=ackSeqNum,proto3" json:"ackSeqNum,omitempty"`
	// Index id
	IndexId string `protobuf:"bytes,5,opt,name=indexId,proto3" json:"indexId,omitempty"`
	// contains filtered or unexported fields
}

Request to receive file data from primary

func (*FileInfo) Descriptor deprecated 

func (*FileInfo) Descriptor() ([]byte, []int)

Deprecated: Use FileInfo.ProtoReflect.Descriptor instead.

func (*FileInfo) GetAckSeqNum 

func (x *FileInfo) GetAckSeqNum() int32

func (*FileInfo) GetFileName 

func (x *FileInfo) GetFileName() string

func (*FileInfo) GetFpStart 

func (x *FileInfo) GetFpStart() int64

func (*FileInfo) GetIndexId added in v0.39.0 

func (x *FileInfo) GetIndexId() string

func (*FileInfo) GetIndexName 

func (x *FileInfo) GetIndexName() string

func (*FileInfo) ProtoMessage 

func (*FileInfo) ProtoMessage()

func (*FileInfo) ProtoReflect 

func (x *FileInfo) ProtoReflect() protoreflect.Message

func (*FileInfo) Reset 

func (x *FileInfo) Reset()

func (*FileInfo) String 

func (x *FileInfo) String() string

type FileMetadata 

type FileMetadata struct {

	// File name
	FileName string `protobuf:"bytes,1,opt,name=fileName,proto3" json:"fileName,omitempty"`
	// File length
	Len int64 `protobuf:"varint,2,opt,name=len,proto3" json:"len,omitempty"`
	// File checksum
	Checksum int64 `protobuf:"varint,3,opt,name=checksum,proto3" json:"checksum,omitempty"`
	// File header length
	HeaderLength int32 `protobuf:"varint,4,opt,name=headerLength,proto3" json:"headerLength,omitempty"`
	// File header
	Header []byte `protobuf:"bytes,5,opt,name=header,proto3" json:"header,omitempty"`
	// File footer length
	FooterLength int32 `protobuf:"varint,6,opt,name=footerLength,proto3" json:"footerLength,omitempty"`
	// File footer
	Footer []byte `protobuf:"bytes,7,opt,name=footer,proto3" json:"footer,omitempty"`
	// contains filtered or unexported fields
}

Metadata for a single index file

func (*FileMetadata) Descriptor deprecated 

func (*FileMetadata) Descriptor() ([]byte, []int)

Deprecated: Use FileMetadata.ProtoReflect.Descriptor instead.

func (*FileMetadata) GetChecksum 

func (x *FileMetadata) GetChecksum() int64

func (*FileMetadata) GetFileName 

func (x *FileMetadata) GetFileName() string

func (*FileMetadata) GetFooter 

func (x *FileMetadata) GetFooter() []byte

func (*FileMetadata) GetFooterLength 

func (x *FileMetadata) GetFooterLength() int32

func (*FileMetadata) GetHeader 

func (x *FileMetadata) GetHeader() []byte

func (*FileMetadata) GetHeaderLength 

func (x *FileMetadata) GetHeaderLength() int32

func (*FileMetadata) GetLen 

func (x *FileMetadata) GetLen() int64

func (*FileMetadata) ProtoMessage 

func (*FileMetadata) ProtoMessage()

func (*FileMetadata) ProtoReflect 

func (x *FileMetadata) ProtoReflect() protoreflect.Message

func (*FileMetadata) Reset 

func (x *FileMetadata) Reset()

func (*FileMetadata) String 

func (x *FileMetadata) String() string

type FilesMetadata 

type FilesMetadata struct {
	NumFiles     int32           `protobuf:"varint,1,opt,name=numFiles,proto3" json:"numFiles,omitempty"`        //number of files int this set
	FileMetadata []*FileMetadata `protobuf:"bytes,2,rep,name=fileMetadata,proto3" json:"fileMetadata,omitempty"` //list of metadata for each file
	// contains filtered or unexported fields
}

Metadata for multiple index files

func (*FilesMetadata) Descriptor deprecated 

func (*FilesMetadata) Descriptor() ([]byte, []int)

Deprecated: Use FilesMetadata.ProtoReflect.Descriptor instead.

func (*FilesMetadata) GetFileMetadata 

func (x *FilesMetadata) GetFileMetadata() []*FileMetadata

func (*FilesMetadata) GetNumFiles 

func (x *FilesMetadata) GetNumFiles() int32

func (*FilesMetadata) ProtoMessage 

func (*FilesMetadata) ProtoMessage()

func (*FilesMetadata) ProtoReflect 

func (x *FilesMetadata) ProtoReflect() protoreflect.Message

func (*FilesMetadata) Reset 

func (x *FilesMetadata) Reset()

func (*FilesMetadata) String 

func (x *FilesMetadata) String() string

type FilterCollector added in v0.19.0 

type FilterCollector struct {

	// Types that are assignable to Filter:
	//
	//	*FilterCollector_Query
	//	*FilterCollector_SetQuery
	Filter isFilterCollector_Filter `protobuf_oneof:"Filter"`
	// contains filtered or unexported fields
}

Definition of filtering collector, there must be at least one nested collector specified in the Collector message

func (*FilterCollector) Descriptor deprecated added in v0.19.0 

func (*FilterCollector) Descriptor() ([]byte, []int)

Deprecated: Use FilterCollector.ProtoReflect.Descriptor instead.

func (*FilterCollector) GetFilter added in v0.19.0 

func (m *FilterCollector) GetFilter() isFilterCollector_Filter

func (*FilterCollector) GetQuery added in v0.19.0 

func (x *FilterCollector) GetQuery() *Query

func (*FilterCollector) GetSetQuery added in v0.19.0 

func (x *FilterCollector) GetSetQuery() *TermInSetQuery

func (*FilterCollector) ProtoMessage added in v0.19.0 

func (*FilterCollector) ProtoMessage()

func (*FilterCollector) ProtoReflect added in v0.19.0 

func (x *FilterCollector) ProtoReflect() protoreflect.Message

func (*FilterCollector) Reset added in v0.19.0 

func (x *FilterCollector) Reset()

func (*FilterCollector) String added in v0.19.0 

func (x *FilterCollector) String() string

type FilterCollector_Query added in v0.19.0 

type FilterCollector_Query struct {
	// Only propagate documents that match the given query
	Query *Query `protobuf:"bytes,1,opt,name=query,proto3,oneof"`
}

type FilterCollector_SetQuery added in v0.19.0 

type FilterCollector_SetQuery struct {
	// Specialized implementation for set queries, checks if field doc values are in the provided set.
	// This can be useful for large set sizes with lower recall, where building the scorer would be expensive.
	SetQuery *TermInSetQuery `protobuf:"bytes,2,opt,name=setQuery,proto3,oneof"`
}

type FilterResult added in v0.19.0 

type FilterResult struct {

	// Number of documents that passed the filter
	DocCount int32 `protobuf:"varint,1,opt,name=docCount,proto3" json:"docCount,omitempty"`
	// Results from nested collectors
	NestedCollectorResults map[string]*CollectorResult `` /* 185-byte string literal not displayed */
	// contains filtered or unexported fields
}

Result from filter collector

func (*FilterResult) Descriptor deprecated added in v0.19.0 

func (*FilterResult) Descriptor() ([]byte, []int)

Deprecated: Use FilterResult.ProtoReflect.Descriptor instead.

func (*FilterResult) GetDocCount added in v0.19.0 

func (x *FilterResult) GetDocCount() int32

func (*FilterResult) GetNestedCollectorResults added in v0.19.0 

func (x *FilterResult) GetNestedCollectorResults() map[string]*CollectorResult

func (*FilterResult) ProtoMessage added in v0.19.0 

func (*FilterResult) ProtoMessage()

func (*FilterResult) ProtoReflect added in v0.19.0 

func (x *FilterResult) ProtoReflect() protoreflect.Message

func (*FilterResult) Reset added in v0.19.0 

func (x *FilterResult) Reset()

func (*FilterResult) String added in v0.19.0 

func (x *FilterResult) String() string

type ForceMergeDeletesRequest 

type ForceMergeDeletesRequest struct {

	// Index name whose segments having deletes must be force merged
	IndexName string `protobuf:"bytes,1,opt,name=indexName,proto3" json:"indexName,omitempty"`
	// If true, waits until the force merge is completed before returning a response. Otherwise starts force
	// merging in async and returns a response.
	DoWait bool `protobuf:"varint,2,opt,name=doWait,proto3" json:"doWait,omitempty"`
	// contains filtered or unexported fields
}

Input to forceMergeDeletes

func (*ForceMergeDeletesRequest) Descriptor deprecated 

func (*ForceMergeDeletesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ForceMergeDeletesRequest.ProtoReflect.Descriptor instead.

func (*ForceMergeDeletesRequest) GetDoWait 

func (x *ForceMergeDeletesRequest) GetDoWait() bool

func (*ForceMergeDeletesRequest) GetIndexName 

func (x *ForceMergeDeletesRequest) GetIndexName() string

func (*ForceMergeDeletesRequest) ProtoMessage 

func (*ForceMergeDeletesRequest) ProtoMessage()

func (*ForceMergeDeletesRequest) ProtoReflect 

func (x *ForceMergeDeletesRequest) ProtoReflect() protoreflect.Message

func (*ForceMergeDeletesRequest) Reset 

func (x *ForceMergeDeletesRequest) Reset()

func (*ForceMergeDeletesRequest) String 

func (x *ForceMergeDeletesRequest) String() string

type ForceMergeDeletesResponse 

type ForceMergeDeletesResponse struct {

	// Status of force merge deletes
	Status ForceMergeDeletesResponse_Status `protobuf:"varint,1,opt,name=status,proto3,enum=luceneserver.ForceMergeDeletesResponse_Status" json:"status,omitempty"`
	// contains filtered or unexported fields
}

Response from Server for forceMergeDeletes

func (*ForceMergeDeletesResponse) Descriptor deprecated 

func (*ForceMergeDeletesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ForceMergeDeletesResponse.ProtoReflect.Descriptor instead.

func (*ForceMergeDeletesResponse) GetStatus 

func (x *ForceMergeDeletesResponse) GetStatus() ForceMergeDeletesResponse_Status

func (*ForceMergeDeletesResponse) ProtoMessage 

func (*ForceMergeDeletesResponse) ProtoMessage()

func (*ForceMergeDeletesResponse) ProtoReflect 

func (x *ForceMergeDeletesResponse) ProtoReflect() protoreflect.Message

func (*ForceMergeDeletesResponse) Reset 

func (x *ForceMergeDeletesResponse) Reset()

func (*ForceMergeDeletesResponse) String 

func (x *ForceMergeDeletesResponse) String() string

type ForceMergeDeletesResponse_Status 

type ForceMergeDeletesResponse_Status int32

Status of force merge deletes 

const (
	ForceMergeDeletesResponse_FORCE_MERGE_DELETES_COMPLETED ForceMergeDeletesResponse_Status = 0
	ForceMergeDeletesResponse_FORCE_MERGE_DELETES_SUBMITTED ForceMergeDeletesResponse_Status = 1
)

func (ForceMergeDeletesResponse_Status) Descriptor 

func (ForceMergeDeletesResponse_Status) Descriptor() protoreflect.EnumDescriptor

func (ForceMergeDeletesResponse_Status) Enum 

func (x ForceMergeDeletesResponse_Status) Enum() *ForceMergeDeletesResponse_Status

func (ForceMergeDeletesResponse_Status) EnumDescriptor deprecated 

func (ForceMergeDeletesResponse_Status) EnumDescriptor() ([]byte, []int)

Deprecated: Use ForceMergeDeletesResponse_Status.Descriptor instead.

func (ForceMergeDeletesResponse_Status) Number 

func (x ForceMergeDeletesResponse_Status) Number() protoreflect.EnumNumber

func (ForceMergeDeletesResponse_Status) String 

func (x ForceMergeDeletesResponse_Status) String() string

func (ForceMergeDeletesResponse_Status) Type 

func (ForceMergeDeletesResponse_Status) Type() protoreflect.EnumType

type ForceMergeRequest 

type ForceMergeRequest struct {

	// Index name whose segments must be force merged
	IndexName string `protobuf:"bytes,1,opt,name=indexName,proto3" json:"indexName,omitempty"`
	// Maximum number of segments after force merge
	MaxNumSegments int32 `protobuf:"varint,2,opt,name=maxNumSegments,proto3" json:"maxNumSegments,omitempty"`
	// If true, waits until the force merge is completed before returning a response. Otherwise starts force
	// merging in async and returns a response.
	DoWait bool `protobuf:"varint,3,opt,name=doWait,proto3" json:"doWait,omitempty"`
	// contains filtered or unexported fields
}

Input to forceMerge

func (*ForceMergeRequest) Descriptor deprecated 

func (*ForceMergeRequest) Descriptor() ([]byte, []int)

Deprecated: Use ForceMergeRequest.ProtoReflect.Descriptor instead.

func (*ForceMergeRequest) GetDoWait 

func (x *ForceMergeRequest) GetDoWait() bool

func (*ForceMergeRequest) GetIndexName 

func (x *ForceMergeRequest) GetIndexName() string

func (*ForceMergeRequest) GetMaxNumSegments 

func (x *ForceMergeRequest) GetMaxNumSegments() int32

func (*ForceMergeRequest) ProtoMessage 

func (*ForceMergeRequest) ProtoMessage()

func (*ForceMergeRequest) ProtoReflect 

func (x *ForceMergeRequest) ProtoReflect() protoreflect.Message

func (*ForceMergeRequest) Reset 

func (x *ForceMergeRequest) Reset()

func (*ForceMergeRequest) String 

func (x *ForceMergeRequest) String() string

type ForceMergeResponse 

type ForceMergeResponse struct {

	// Status of force merge
	Status ForceMergeResponse_Status `protobuf:"varint,1,opt,name=status,proto3,enum=luceneserver.ForceMergeResponse_Status" json:"status,omitempty"`
	// contains filtered or unexported fields
}

Response from Server for forceMerge

func (*ForceMergeResponse) Descriptor deprecated 

func (*ForceMergeResponse) Descriptor() ([]byte, []int)

Deprecated: Use ForceMergeResponse.ProtoReflect.Descriptor instead.

func (*ForceMergeResponse) GetStatus 

func (x *ForceMergeResponse) GetStatus() ForceMergeResponse_Status

func (*ForceMergeResponse) ProtoMessage 

func (*ForceMergeResponse) ProtoMessage()

func (*ForceMergeResponse) ProtoReflect 

func (x *ForceMergeResponse) ProtoReflect() protoreflect.Message

func (*ForceMergeResponse) Reset 

func (x *ForceMergeResponse) Reset()

func (*ForceMergeResponse) String 

func (x *ForceMergeResponse) String() string

type ForceMergeResponse_Status 

type ForceMergeResponse_Status int32

Status of force merge 

const (
	ForceMergeResponse_FORCE_MERGE_COMPLETED ForceMergeResponse_Status = 0
	ForceMergeResponse_FORCE_MERGE_SUBMITTED ForceMergeResponse_Status = 1
)

func (ForceMergeResponse_Status) Descriptor 

func (ForceMergeResponse_Status) Descriptor() protoreflect.EnumDescriptor

func (ForceMergeResponse_Status) Enum 

func (x ForceMergeResponse_Status) Enum() *ForceMergeResponse_Status

func (ForceMergeResponse_Status) EnumDescriptor deprecated 

func (ForceMergeResponse_Status) EnumDescriptor() ([]byte, []int)

Deprecated: Use ForceMergeResponse_Status.Descriptor instead.

func (ForceMergeResponse_Status) Number 

func (x ForceMergeResponse_Status) Number() protoreflect.EnumNumber

func (ForceMergeResponse_Status) String 

func (x ForceMergeResponse_Status) String() string

func (ForceMergeResponse_Status) Type 

func (ForceMergeResponse_Status) Type() protoreflect.EnumType

type FunctionFilterQuery 

type FunctionFilterQuery struct {

	// Script definition to compute a custom document score
	Script *Script `protobuf:"bytes,1,opt,name=script,proto3" json:"script,omitempty"`
	// contains filtered or unexported fields
}

A query that retrieves all documents with a positive score calculated by the script

func (*FunctionFilterQuery) Descriptor deprecated 

func (*FunctionFilterQuery) Descriptor() ([]byte, []int)

Deprecated: Use FunctionFilterQuery.ProtoReflect.Descriptor instead.

func (*FunctionFilterQuery) GetScript 

func (x *FunctionFilterQuery) GetScript() *Script

func (*FunctionFilterQuery) ProtoMessage 

func (*FunctionFilterQuery) ProtoMessage()

func (*FunctionFilterQuery) ProtoReflect 

func (x *FunctionFilterQuery) ProtoReflect() protoreflect.Message

func (*FunctionFilterQuery) Reset 

func (x *FunctionFilterQuery) Reset()

func (*FunctionFilterQuery) String 

func (x *FunctionFilterQuery) String() string

type FunctionScoreQuery 

type FunctionScoreQuery struct {

	// Input query
	Query *Query `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
	// Script definition to compute a custom document score
	Script *Script `protobuf:"bytes,2,opt,name=script,proto3" json:"script,omitempty"`
	// contains filtered or unexported fields
}

A query that wraps another query and uses custom scoring logic to compute the wrapped query's score

func (*FunctionScoreQuery) Descriptor deprecated 

func (*FunctionScoreQuery) Descriptor() ([]byte, []int)

Deprecated: Use FunctionScoreQuery.ProtoReflect.Descriptor instead.

func (*FunctionScoreQuery) GetQuery 

func (x *FunctionScoreQuery) GetQuery() *Query

func (*FunctionScoreQuery) GetScript 

func (x *FunctionScoreQuery) GetScript() *Script

func (*FunctionScoreQuery) ProtoMessage 

func (*FunctionScoreQuery) ProtoMessage()

func (*FunctionScoreQuery) ProtoReflect 

func (x *FunctionScoreQuery) ProtoReflect() protoreflect.Message

func (*FunctionScoreQuery) Reset 

func (x *FunctionScoreQuery) Reset()

func (*FunctionScoreQuery) String 

func (x *FunctionScoreQuery) String() string

type FuzzyParams 

type FuzzyParams struct {

	// The maximum allowed Levenshtein Edit Distance (or number of edits). Possible values are 0, 1 and 2.
	// Either set this or auto.
	MaxEdits int32 `protobuf:"varint,1,opt,name=maxEdits,proto3" json:"maxEdits,omitempty"`
	// Length of common (non-fuzzy) prefix
	PrefixLength int32 `protobuf:"varint,2,opt,name=prefixLength,proto3" json:"prefixLength,omitempty"`
	// The maximum number of terms to match
	MaxExpansions int32 `protobuf:"varint,3,opt,name=maxExpansions,proto3" json:"maxExpansions,omitempty"`
	// True if transpositions should be treated as a primitive edit operation. If this is false, comparisons
	// will implement the classic Levenshtein algorithm. Default is true.
	Transpositions bool `protobuf:"varint,4,opt,name=transpositions,proto3" json:"transpositions,omitempty"`
	// Auto fuzziness which determines the max edits based on the term length. AUTO is the preferred setting.
	// Either set this or maxEdits.
	Auto *FuzzyParams_AutoFuzziness `protobuf:"bytes,5,opt,name=auto,proto3" json:"auto,omitempty"`
	// contains filtered or unexported fields
}

Parameters for fuzzy queries

func (*FuzzyParams) Descriptor deprecated 

func (*FuzzyParams) Descriptor() ([]byte, []int)

Deprecated: Use FuzzyParams.ProtoReflect.Descriptor instead.

func (*FuzzyParams) GetAuto added in v0.37.0 

func (x *FuzzyParams) GetAuto() *FuzzyParams_AutoFuzziness

func (*FuzzyParams) GetMaxEdits 

func (x *FuzzyParams) GetMaxEdits() int32

func (*FuzzyParams) GetMaxExpansions 

func (x *FuzzyParams) GetMaxExpansions() int32

func (*FuzzyParams) GetPrefixLength 

func (x *FuzzyParams) GetPrefixLength() int32

func (*FuzzyParams) GetTranspositions 

func (x *FuzzyParams) GetTranspositions() bool

func (*FuzzyParams) ProtoMessage 

func (*FuzzyParams) ProtoMessage()

func (*FuzzyParams) ProtoReflect 

func (x *FuzzyParams) ProtoReflect() protoreflect.Message

func (*FuzzyParams) Reset 

func (x *FuzzyParams) Reset()

func (*FuzzyParams) String 

func (x *FuzzyParams) String() string

type FuzzyParams_AutoFuzziness added in v0.37.0 

type FuzzyParams_AutoFuzziness struct {

	// Optional low distance argument
	Low int32 `protobuf:"varint,6,opt,name=low,proto3" json:"low,omitempty"`
	// Optional high distance argument
	High int32 `protobuf:"varint,7,opt,name=high,proto3" json:"high,omitempty"`
	// contains filtered or unexported fields
}

Optional low and high values for auto fuzziness. Defaults to low: 3 and high: 6 if both are unset. Valid values are low >= 0 and low < high

func (*FuzzyParams_AutoFuzziness) Descriptor deprecated added in v0.37.0 

func (*FuzzyParams_AutoFuzziness) Descriptor() ([]byte, []int)

Deprecated: Use FuzzyParams_AutoFuzziness.ProtoReflect.Descriptor instead.

func (*FuzzyParams_AutoFuzziness) GetHigh added in v0.37.0 

func (x *FuzzyParams_AutoFuzziness) GetHigh() int32

func (*FuzzyParams_AutoFuzziness) GetLow added in v0.37.0 

func (x *FuzzyParams_AutoFuzziness) GetLow() int32

func (*FuzzyParams_AutoFuzziness) ProtoMessage added in v0.37.0 

func (*FuzzyParams_AutoFuzziness) ProtoMessage()

func (*FuzzyParams_AutoFuzziness) ProtoReflect added in v0.37.0 

func (x *FuzzyParams_AutoFuzziness) ProtoReflect() protoreflect.Message

func (*FuzzyParams_AutoFuzziness) Reset added in v0.37.0 

func (x *FuzzyParams_AutoFuzziness) Reset()

func (*FuzzyParams_AutoFuzziness) String added in v0.37.0 

func (x *FuzzyParams_AutoFuzziness) String() string

type FuzzyQuery added in v0.39.0 

type FuzzyQuery struct {

	// Field in the document to query
	Field string `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
	// Term to search for
	Text string `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
	// The maximum allowed Levenshtein Edit Distance (or number of edits). Possible values are 0, 1 and 2.
	// Either set this or auto. Default is 2.
	MaxEdits *int32 `protobuf:"varint,3,opt,name=maxEdits,proto3,oneof" json:"maxEdits,omitempty"`
	// Length of common (non-fuzzy) prefix. Default is 0.
	PrefixLength *int32 `protobuf:"varint,4,opt,name=prefixLength,proto3,oneof" json:"prefixLength,omitempty"`
	// The maximum number of terms to match. Default is 50.
	MaxExpansions *int32 `protobuf:"varint,5,opt,name=maxExpansions,proto3,oneof" json:"maxExpansions,omitempty"`
	// True if transpositions should be treated as a primitive edit operation. If this is false, comparisons will
	// implement the classic Levenshtein algorithm. Default is true.
	Transpositions *bool `protobuf:"varint,6,opt,name=transpositions,proto3,oneof" json:"transpositions,omitempty"`
	// Method used to rewrite the query
	Rewrite RewriteMethod `protobuf:"varint,7,opt,name=rewrite,proto3,enum=luceneserver.RewriteMethod" json:"rewrite,omitempty"`
	// Specifies the size to use for the TOP_TERMS* rewrite methods
	RewriteTopTermsSize int32 `protobuf:"varint,8,opt,name=rewriteTopTermsSize,proto3" json:"rewriteTopTermsSize,omitempty"`
	// Auto fuzziness which determines the max edits based on the term length. AUTO is the preferred setting.
	// Either set this or maxEdits.
	Auto *FuzzyParams_AutoFuzziness `protobuf:"bytes,9,opt,name=auto,proto3" json:"auto,omitempty"`
	// contains filtered or unexported fields
}

A query that matches documents containing terms similar to the specified term

func (*FuzzyQuery) Descriptor deprecated added in v0.39.0 

func (*FuzzyQuery) Descriptor() ([]byte, []int)

Deprecated: Use FuzzyQuery.ProtoReflect.Descriptor instead.

func (*FuzzyQuery) GetAuto added in v0.40.0 

func (x *FuzzyQuery) GetAuto() *FuzzyParams_AutoFuzziness

func (*FuzzyQuery) GetField added in v0.39.0 

func (x *FuzzyQuery) GetField() string

func (*FuzzyQuery) GetMaxEdits added in v0.39.0 

func (x *FuzzyQuery) GetMaxEdits() int32

func (*FuzzyQuery) GetMaxExpansions added in v0.39.0 

func (x *FuzzyQuery) GetMaxExpansions() int32

func (*FuzzyQuery) GetPrefixLength added in v0.39.0 

func (x *FuzzyQuery) GetPrefixLength() int32

func (*FuzzyQuery) GetRewrite added in v0.39.0 

func (x *FuzzyQuery) GetRewrite() RewriteMethod

func (*FuzzyQuery) GetRewriteTopTermsSize added in v0.39.0 

func (x *FuzzyQuery) GetRewriteTopTermsSize() int32

func (*FuzzyQuery) GetText added in v0.39.0 

func (x *FuzzyQuery) GetText() string

func (*FuzzyQuery) GetTranspositions added in v0.39.0 

func (x *FuzzyQuery) GetTranspositions() bool

func (*FuzzyQuery) ProtoMessage added in v0.39.0 

func (*FuzzyQuery) ProtoMessage()

func (*FuzzyQuery) ProtoReflect added in v0.39.0 

func (x *FuzzyQuery) ProtoReflect() protoreflect.Message

func (*FuzzyQuery) Reset added in v0.39.0 

func (x *FuzzyQuery) Reset()

func (*FuzzyQuery) String added in v0.39.0 

func (x *FuzzyQuery) String() string

type GeoBoundingBoxQuery 

type GeoBoundingBoxQuery struct {

	// Field in the document to query
	Field string `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
	// Top left corner of the geo box
	TopLeft *latlng.LatLng `protobuf:"bytes,2,opt,name=topLeft,proto3" json:"topLeft,omitempty"`
	// Bottom right corner of the geo box
	BottomRight *latlng.LatLng `protobuf:"bytes,3,opt,name=bottomRight,proto3" json:"bottomRight,omitempty"`
	// contains filtered or unexported fields
}

A query that matches documents with geopoint within the geo box

func (*GeoBoundingBoxQuery) Descriptor deprecated 

func (*GeoBoundingBoxQuery) Descriptor() ([]byte, []int)

Deprecated: Use GeoBoundingBoxQuery.ProtoReflect.Descriptor instead.

func (*GeoBoundingBoxQuery) GetBottomRight 

func (x *GeoBoundingBoxQuery) GetBottomRight() *latlng.LatLng

func (*GeoBoundingBoxQuery) GetField 

func (x *GeoBoundingBoxQuery) GetField() string

func (*GeoBoundingBoxQuery) GetTopLeft 

func (x *GeoBoundingBoxQuery) GetTopLeft() *latlng.LatLng

func (*GeoBoundingBoxQuery) ProtoMessage 

func (*GeoBoundingBoxQuery) ProtoMessage()

func (*GeoBoundingBoxQuery) ProtoReflect 

func (x *GeoBoundingBoxQuery) ProtoReflect() protoreflect.Message

func (*GeoBoundingBoxQuery) Reset 

func (x *GeoBoundingBoxQuery) Reset()

func (*GeoBoundingBoxQuery) String 

func (x *GeoBoundingBoxQuery) String() string

type GeoPointQuery 

type GeoPointQuery struct {

	// Field in the document to query
	Field string `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
	// Point to check if the polygon contains
	Point *latlng.LatLng `protobuf:"bytes,2,opt,name=point,proto3" json:"point,omitempty"`
	// contains filtered or unexported fields
}

A query that matches documents with polygon that contains the geo point

func (*GeoPointQuery) Descriptor deprecated 

func (*GeoPointQuery) Descriptor() ([]byte, []int)

Deprecated: Use GeoPointQuery.ProtoReflect.Descriptor instead.

func (*GeoPointQuery) GetField 

func (x *GeoPointQuery) GetField() string

func (*GeoPointQuery) GetPoint 

func (x *GeoPointQuery) GetPoint() *latlng.LatLng

func (*GeoPointQuery) ProtoMessage 

func (*GeoPointQuery) ProtoMessage()

func (*GeoPointQuery) ProtoReflect 

func (x *GeoPointQuery) ProtoReflect() protoreflect.Message

func (*GeoPointQuery) Reset 

func (x *GeoPointQuery) Reset()

func (*GeoPointQuery) String 

func (x *GeoPointQuery) String() string

type GeoPolygonQuery added in v0.30.0 

type GeoPolygonQuery struct {

	// Field in the document to query
	Field string `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
	// Geo polygons to search for containing points
	Polygons []*Polygon `protobuf:"bytes,2,rep,name=polygons,proto3" json:"polygons,omitempty"`
	// contains filtered or unexported fields
}

A query that matches documents with geo points within polygons

func (*GeoPolygonQuery) Descriptor deprecated added in v0.30.0 

func (*GeoPolygonQuery) Descriptor() ([]byte, []int)

Deprecated: Use GeoPolygonQuery.ProtoReflect.Descriptor instead.

func (*GeoPolygonQuery) GetField added in v0.30.0 

func (x *GeoPolygonQuery) GetField() string

func (*GeoPolygonQuery) GetPolygons added in v0.30.0 

func (x *GeoPolygonQuery) GetPolygons() []*Polygon

func (*GeoPolygonQuery) ProtoMessage added in v0.30.0 

func (*GeoPolygonQuery) ProtoMessage()

func (*GeoPolygonQuery) ProtoReflect added in v0.30.0 

func (x *GeoPolygonQuery) ProtoReflect() protoreflect.Message

func (*GeoPolygonQuery) Reset added in v0.30.0 

func (x *GeoPolygonQuery) Reset()

func (*GeoPolygonQuery) String added in v0.30.0 

func (x *GeoPolygonQuery) String() string

type GeoRadiusQuery 

type GeoRadiusQuery struct {

	// Field in the document to query
	Field string `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
	// Target center geo point to calculate distance
	Center *latlng.LatLng `protobuf:"bytes,2,opt,name=center,proto3" json:"center,omitempty"`
	// Distance radius like "12 km". supports m, km and mi, default to m
	Radius string `protobuf:"bytes,3,opt,name=radius,proto3" json:"radius,omitempty"`
	// contains filtered or unexported fields
}

A query that matches documents with geo point within the radius of target geo point

func (*GeoRadiusQuery) Descriptor deprecated 

func (*GeoRadiusQuery) Descriptor() ([]byte, []int)

Deprecated: Use GeoRadiusQuery.ProtoReflect.Descriptor instead.

func (*GeoRadiusQuery) GetCenter 

func (x *GeoRadiusQuery) GetCenter() *latlng.LatLng

func (*GeoRadiusQuery) GetField 

func (x *GeoRadiusQuery) GetField() string

func (*GeoRadiusQuery) GetRadius 

func (x *GeoRadiusQuery) GetRadius() string

func (*GeoRadiusQuery) ProtoMessage 

func (*GeoRadiusQuery) ProtoMessage()

func (*GeoRadiusQuery) ProtoReflect 

func (x *GeoRadiusQuery) ProtoReflect() protoreflect.Message

func (*GeoRadiusQuery) Reset 

func (x *GeoRadiusQuery) Reset()

func (*GeoRadiusQuery) String 

func (x *GeoRadiusQuery) String() string

type GetAllSnapshotGenRequest 

type GetAllSnapshotGenRequest struct {

	// Name of the index to get snapshot gens
	IndexName string `protobuf:"bytes,1,opt,name=indexName,proto3" json:"indexName,omitempty"`
	// contains filtered or unexported fields
}

Input to getAllSnapshotGen

func (*GetAllSnapshotGenRequest) Descriptor deprecated 

func (*GetAllSnapshotGenRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetAllSnapshotGenRequest.ProtoReflect.Descriptor instead.

func (*GetAllSnapshotGenRequest) GetIndexName 

func (x *GetAllSnapshotGenRequest) GetIndexName() string

func (*GetAllSnapshotGenRequest) ProtoMessage 

func (*GetAllSnapshotGenRequest) ProtoMessage()

func (*GetAllSnapshotGenRequest) ProtoReflect 

func (x *GetAllSnapshotGenRequest) ProtoReflect() protoreflect.Message

func (*GetAllSnapshotGenRequest) Reset 

func (x *GetAllSnapshotGenRequest) Reset()

func (*GetAllSnapshotGenRequest) String 

func (x *GetAllSnapshotGenRequest) String() string

type GetAllSnapshotGenResponse 

type GetAllSnapshotGenResponse struct {

	// List of snapshot gens
	IndexGens []int64 `protobuf:"varint,1,rep,packed,name=indexGens,proto3" json:"indexGens,omitempty"`
	// contains filtered or unexported fields
}

Response from Server for getAllSnapshotGen

func (*GetAllSnapshotGenResponse) Descriptor deprecated 

func (*GetAllSnapshotGenResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetAllSnapshotGenResponse.ProtoReflect.Descriptor instead.

func (*GetAllSnapshotGenResponse) GetIndexGens 

func (x *GetAllSnapshotGenResponse) GetIndexGens() []int64

func (*GetAllSnapshotGenResponse) ProtoMessage 

func (*GetAllSnapshotGenResponse) ProtoMessage()

func (*GetAllSnapshotGenResponse) ProtoReflect 

func (x *GetAllSnapshotGenResponse) ProtoReflect() protoreflect.Message

func (*GetAllSnapshotGenResponse) Reset 

func (x *GetAllSnapshotGenResponse) Reset()

func (*GetAllSnapshotGenResponse) String 

func (x *GetAllSnapshotGenResponse) String() string

type GetNodesRequest 

type GetNodesRequest struct {

	// Index name
	IndexName string `protobuf:"bytes,1,opt,name=indexName,proto3" json:"indexName,omitempty"` //name of the started index whose binary connections we wish to see
	// contains filtered or unexported fields
}

Input to getNodes

func (*GetNodesRequest) Descriptor deprecated 

func (*GetNodesRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetNodesRequest.ProtoReflect.Descriptor instead.

func (*GetNodesRequest) GetIndexName 

func (x *GetNodesRequest) GetIndexName() string

func (*GetNodesRequest) ProtoMessage 

func (*GetNodesRequest) ProtoMessage()

func (*GetNodesRequest) ProtoReflect 

func (x *GetNodesRequest) ProtoReflect() protoreflect.Message

func (*GetNodesRequest) Reset 

func (x *GetNodesRequest) Reset()

func (*GetNodesRequest) String 

func (x *GetNodesRequest) String() string

type GetNodesResponse 

type GetNodesResponse struct {
	Nodes []*NodeInfo `protobuf:"bytes,2,rep,name=nodes,proto3" json:"nodes,omitempty"` //list of NodeInfo
	// contains filtered or unexported fields
}

Response from Server for getNodes

func (*GetNodesResponse) Descriptor deprecated 

func (*GetNodesResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetNodesResponse.ProtoReflect.Descriptor instead.

func (*GetNodesResponse) GetNodes 

func (x *GetNodesResponse) GetNodes() []*NodeInfo

func (*GetNodesResponse) ProtoMessage 

func (*GetNodesResponse) ProtoMessage()

func (*GetNodesResponse) ProtoReflect 

func (x *GetNodesResponse) ProtoReflect() protoreflect.Message

func (*GetNodesResponse) Reset 

func (x *GetNodesResponse) Reset()

func (*GetNodesResponse) String 

func (x *GetNodesResponse) String() string

type GlobalStateInfo added in v0.12.0 

type GlobalStateInfo struct {

	// State version generation
	Gen int64 `protobuf:"varint,1,opt,name=gen,proto3" json:"gen,omitempty"`
	// Global state for indices
	Indices map[string]*IndexGlobalState `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

Cluster global state

func (*GlobalStateInfo) Descriptor deprecated added in v0.12.0 

func (*GlobalStateInfo) Descriptor() ([]byte, []int)

Deprecated: Use GlobalStateInfo.ProtoReflect.Descriptor instead.

func (*GlobalStateInfo) GetGen added in v0.12.0 

func (x *GlobalStateInfo) GetGen() int64

func (*GlobalStateInfo) GetIndices added in v0.12.0 

func (x *GlobalStateInfo) GetIndices() map[string]*IndexGlobalState

func (*GlobalStateInfo) ProtoMessage added in v0.12.0 

func (*GlobalStateInfo) ProtoMessage()

func (*GlobalStateInfo) ProtoReflect added in v0.12.0 

func (x *GlobalStateInfo) ProtoReflect() protoreflect.Message

func (*GlobalStateInfo) Reset added in v0.12.0 

func (x *GlobalStateInfo) Reset()

func (*GlobalStateInfo) String added in v0.12.0 

func (x *GlobalStateInfo) String() string

type GlobalStateRequest 

type GlobalStateRequest struct {
	// contains filtered or unexported fields
}

Input to globalState

func (*GlobalStateRequest) Descriptor deprecated 

func (*GlobalStateRequest) Descriptor() ([]byte, []int)

Deprecated: Use GlobalStateRequest.ProtoReflect.Descriptor instead.

func (*GlobalStateRequest) ProtoMessage 

func (*GlobalStateRequest) ProtoMessage()

func (*GlobalStateRequest) ProtoReflect 

func (x *GlobalStateRequest) ProtoReflect() protoreflect.Message

func (*GlobalStateRequest) Reset 

func (x *GlobalStateRequest) Reset()

func (*GlobalStateRequest) String 

func (x *GlobalStateRequest) String() string

type GlobalStateResponse 

type GlobalStateResponse struct {

	// Cluster global state
	GlobalState *GlobalStateInfo `protobuf:"bytes,1,opt,name=global_state,json=globalState,proto3" json:"global_state,omitempty"`
	// contains filtered or unexported fields
}

Response from Server for globalState

func (*GlobalStateResponse) Descriptor deprecated 

func (*GlobalStateResponse) Descriptor() ([]byte, []int)

Deprecated: Use GlobalStateResponse.ProtoReflect.Descriptor instead.

func (*GlobalStateResponse) GetGlobalState 

func (x *GlobalStateResponse) GetGlobalState() *GlobalStateInfo

func (*GlobalStateResponse) ProtoMessage 

func (*GlobalStateResponse) ProtoMessage()

func (*GlobalStateResponse) ProtoReflect 

func (x *GlobalStateResponse) ProtoReflect() protoreflect.Message

func (*GlobalStateResponse) Reset 

func (x *GlobalStateResponse) Reset()

func (*GlobalStateResponse) String 

func (x *GlobalStateResponse) String() string

type HealthCheckRequest 

type HealthCheckRequest struct {

	// Healthcheck request
	Check bool `protobuf:"varint,1,opt,name=check,proto3" json:"check,omitempty"`
	// contains filtered or unexported fields
}

Input to healthCheck

func (*HealthCheckRequest) Descriptor deprecated 

func (*HealthCheckRequest) Descriptor() ([]byte, []int)

Deprecated: Use HealthCheckRequest.ProtoReflect.Descriptor instead.

func (*HealthCheckRequest) GetCheck 

func (x *HealthCheckRequest) GetCheck() bool

func (*HealthCheckRequest) ProtoMessage 

func (*HealthCheckRequest) ProtoMessage()

func (*HealthCheckRequest) ProtoReflect 

func (x *HealthCheckRequest) ProtoReflect() protoreflect.Message

func (*HealthCheckRequest) Reset 

func (x *HealthCheckRequest) Reset()

func (*HealthCheckRequest) String 

func (x *HealthCheckRequest) String() string

type HealthCheckResponse 

type HealthCheckResponse struct {

	// Response of healthcheck
	Health TransferStatusCode `protobuf:"varint,1,opt,name=health,proto3,enum=luceneserver.TransferStatusCode" json:"health,omitempty"`
	// contains filtered or unexported fields
}

Response from Server for healthCheck

func (*HealthCheckResponse) Descriptor deprecated 

func (*HealthCheckResponse) Descriptor() ([]byte, []int)

Deprecated: Use HealthCheckResponse.ProtoReflect.Descriptor instead.

func (*HealthCheckResponse) GetHealth 

func (x *HealthCheckResponse) GetHealth() TransferStatusCode

func (*HealthCheckResponse) ProtoMessage 

func (*HealthCheckResponse) ProtoMessage()

func (*HealthCheckResponse) ProtoReflect 

func (x *HealthCheckResponse) ProtoReflect() protoreflect.Message

func (*HealthCheckResponse) Reset 

func (x *HealthCheckResponse) Reset()

func (*HealthCheckResponse) String 

func (x *HealthCheckResponse) String() string

type Highlight added in v0.14.0 

type Highlight struct {

	// Highlight settings
	Settings *Highlight_Settings `protobuf:"bytes,1,opt,name=settings,proto3" json:"settings,omitempty"`
	// Fields to highlight
	Fields []string `protobuf:"bytes,2,rep,name=fields,proto3" json:"fields,omitempty"`
	// Map of field name to highlight settings for field, overrides request level highlight settings
	FieldSettings map[string]*Highlight_Settings `` /* 188-byte string literal not displayed */
	// contains filtered or unexported fields
}

Specify how to highlight matched text in SearchRequest

func (*Highlight) Descriptor deprecated added in v0.14.0 

func (*Highlight) Descriptor() ([]byte, []int)

Deprecated: Use Highlight.ProtoReflect.Descriptor instead.

func (*Highlight) GetFieldSettings added in v0.14.0 

func (x *Highlight) GetFieldSettings() map[string]*Highlight_Settings

func (*Highlight) GetFields added in v0.14.0 

func (x *Highlight) GetFields() []string

func (*Highlight) GetSettings added in v0.14.0 

func (x *Highlight) GetSettings() *Highlight_Settings

func (*Highlight) ProtoMessage added in v0.14.0 

func (*Highlight) ProtoMessage()

func (*Highlight) ProtoReflect added in v0.14.0 

func (x *Highlight) ProtoReflect() protoreflect.Message

func (*Highlight) Reset added in v0.14.0 

func (x *Highlight) Reset()

func (*Highlight) String added in v0.14.0 

func (x *Highlight) String() string

type Highlight_Settings added in v0.14.0 

type Highlight_Settings struct {

	// Specify type of highlighter to use. Ignored right now in nrtsearch.
	HighlighterType Highlight_Type `` /* 140-byte string literal not displayed */
	// Used along with post_tags to specify how to wrap the highlighted text
	PreTags []string `protobuf:"bytes,2,rep,name=pre_tags,json=preTags,proto3" json:"pre_tags,omitempty"`
	// Used along with pre_tags to specify how to wrap the highlighted text
	PostTags []string `protobuf:"bytes,3,rep,name=post_tags,json=postTags,proto3" json:"post_tags,omitempty"`
	// Number of characters in highlighted fragment, 100 by default. Set it to be 0 to fetch the entire field.
	FragmentSize *wrapperspb.UInt32Value `protobuf:"bytes,4,opt,name=fragment_size,json=fragmentSize,proto3" json:"fragment_size,omitempty"`
	// Maximum number of highlight fragments to return, 5 by default. If set to 0 returns entire text as a single
	// fragment ignoring fragment_size.
	MaxNumberOfFragments *wrapperspb.UInt32Value `protobuf:"bytes,5,opt,name=max_number_of_fragments,json=maxNumberOfFragments,proto3" json:"max_number_of_fragments,omitempty"`
	// Specify a query here if highlighting is desired against a different query than the search query
	HighlightQuery *Query `protobuf:"bytes,6,opt,name=highlight_query,json=highlightQuery,proto3" json:"highlight_query,omitempty"`
	// Set to true to highlight fields only if specified in the search query
	FieldMatch *wrapperspb.BoolValue `protobuf:"bytes,7,opt,name=field_match,json=fieldMatch,proto3" json:"field_match,omitempty"`
	// Sorts highlighted fragments by score when set to true. By default, fragments will be output in the order
	// they appear in the field. (Default is true)
	ScoreOrdered *wrapperspb.BoolValue `protobuf:"bytes,8,opt,name=score_ordered,json=scoreOrdered,proto3" json:"score_ordered,omitempty"`
	// Select Fragmenter between span (default) and simple. This is only applicable for plain highlighters.
	Fragmenter *wrapperspb.StringValue `protobuf:"bytes,9,opt,name=fragmenter,proto3" json:"fragmenter,omitempty"`
	// Let the fragment builder respect the multivalue fields. Each fragment won't cross multiple value fields
	// if set true. (Default is false)
	DiscreteMultivalue *wrapperspb.BoolValue `protobuf:"bytes,10,opt,name=discrete_multivalue,json=discreteMultivalue,proto3" json:"discrete_multivalue,omitempty"`
	// When highlighter_type is CUSTOM, use this string identifier to specify the highlighter. It is ignored for
	// any other highlighter_types.
	CustomHighlighterName string `` /* 127-byte string literal not displayed */
	// Optional Custom parameters for custom highlighters. If a field overriding is present, the global setting
	// will be omitted for this field, and no merge will happen.
	CustomHighlighterParams *structpb.Struct `` /* 133-byte string literal not displayed */
	// Define the boundary decision when creating fragments. Options are "simple" (default in fast vector
	// highlighter), "word" or "sentence".
	BoundaryScanner *wrapperspb.StringValue `protobuf:"bytes,13,opt,name=boundary_scanner,json=boundaryScanner,proto3" json:"boundary_scanner,omitempty"`
	// Terminating chars when using "simple" boundary_scanner. The default is ".,!? \t\n"
	BoundaryChars *wrapperspb.StringValue `protobuf:"bytes,14,opt,name=boundary_chars,json=boundaryChars,proto3" json:"boundary_chars,omitempty"`
	// Number of chars to scan before finding the boundary_chars if using "simple" boundary scanner; If
	// "boundary_chars" is not found after max scan, fragments will start/end at the original place. Default is 20.
	BoundaryMaxScan *wrapperspb.UInt32Value `protobuf:"bytes,15,opt,name=boundary_max_scan,json=boundaryMaxScan,proto3" json:"boundary_max_scan,omitempty"`
	// Locale used in boundary scanner when using "word" or "sentence" boundary_scanner. Examples: "en-US", "ch-ZH".
	BoundaryScannerLocale *wrapperspb.StringValue `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*Highlight_Settings) Descriptor deprecated added in v0.14.0 

func (*Highlight_Settings) Descriptor() ([]byte, []int)

Deprecated: Use Highlight_Settings.ProtoReflect.Descriptor instead.

func (*Highlight_Settings) GetBoundaryChars added in v0.26.0 

func (x *Highlight_Settings) GetBoundaryChars() *wrapperspb.StringValue

func (*Highlight_Settings) GetBoundaryMaxScan added in v0.26.0 

func (x *Highlight_Settings) GetBoundaryMaxScan() *wrapperspb.UInt32Value

func (*Highlight_Settings) GetBoundaryScanner added in v0.26.0 

func (x *Highlight_Settings) GetBoundaryScanner() *wrapperspb.StringValue

func (*Highlight_Settings) GetBoundaryScannerLocale added in v0.26.0 

func (x *Highlight_Settings) GetBoundaryScannerLocale() *wrapperspb.StringValue

func (*Highlight_Settings) GetCustomHighlighterName added in v0.21.0 

func (x *Highlight_Settings) GetCustomHighlighterName() string

func (*Highlight_Settings) GetCustomHighlighterParams added in v0.23.0 

func (x *Highlight_Settings) GetCustomHighlighterParams() *structpb.Struct

func (*Highlight_Settings) GetDiscreteMultivalue added in v0.21.0 

func (x *Highlight_Settings) GetDiscreteMultivalue() *wrapperspb.BoolValue

func (*Highlight_Settings) GetFieldMatch added in v0.17.0 

func (x *Highlight_Settings) GetFieldMatch() *wrapperspb.BoolValue

func (*Highlight_Settings) GetFragmentSize added in v0.14.0 

func (x *Highlight_Settings) GetFragmentSize() *wrapperspb.UInt32Value

func (*Highlight_Settings) GetFragmenter added in v0.21.0 

func (x *Highlight_Settings) GetFragmenter() *wrapperspb.StringValue

func (*Highlight_Settings) GetHighlightQuery added in v0.14.0 

func (x *Highlight_Settings) GetHighlightQuery() *Query

func (*Highlight_Settings) GetHighlighterType added in v0.14.0 

func (x *Highlight_Settings) GetHighlighterType() Highlight_Type

func (*Highlight_Settings) GetMaxNumberOfFragments added in v0.14.0 

func (x *Highlight_Settings) GetMaxNumberOfFragments() *wrapperspb.UInt32Value

func (*Highlight_Settings) GetPostTags added in v0.14.0 

func (x *Highlight_Settings) GetPostTags() []string

func (*Highlight_Settings) GetPreTags added in v0.14.0 

func (x *Highlight_Settings) GetPreTags() []string

func (*Highlight_Settings) GetScoreOrdered added in v0.21.0 

func (x *Highlight_Settings) GetScoreOrdered() *wrapperspb.BoolValue

func (*Highlight_Settings) ProtoMessage added in v0.14.0 

func (*Highlight_Settings) ProtoMessage()

func (*Highlight_Settings) ProtoReflect added in v0.14.0 

func (x *Highlight_Settings) ProtoReflect() protoreflect.Message

func (*Highlight_Settings) Reset added in v0.14.0 

func (x *Highlight_Settings) Reset()

func (*Highlight_Settings) String added in v0.14.0 

func (x *Highlight_Settings) String() string

type Highlight_Type added in v0.14.0 

type Highlight_Type int32
const (
	// When DEFAULT is set in global setting, use fast vector highlighter; when set for field setting,
	// use the type from the global setting.
	Highlight_DEFAULT     Highlight_Type = 0
	Highlight_FAST_VECTOR Highlight_Type = 1
	// not supported yet
	Highlight_PLAIN  Highlight_Type = 2
	Highlight_CUSTOM Highlight_Type = 3
)

func (Highlight_Type) Descriptor added in v0.14.0 

func (Highlight_Type) Descriptor() protoreflect.EnumDescriptor

func (Highlight_Type) Enum added in v0.14.0 

func (x Highlight_Type) Enum() *Highlight_Type

func (Highlight_Type) EnumDescriptor deprecated added in v0.14.0 

func (Highlight_Type) EnumDescriptor() ([]byte, []int)

Deprecated: Use Highlight_Type.Descriptor instead.

func (Highlight_Type) Number added in v0.14.0 

func (x Highlight_Type) Number() protoreflect.EnumNumber

func (Highlight_Type) String added in v0.14.0 

func (x Highlight_Type) String() string

func (Highlight_Type) Type added in v0.14.0 

func (Highlight_Type) Type() protoreflect.EnumType

type HitsResult added in v0.13.0 

type HitsResult struct {

	// Total hit information
	TotalHits *TotalHits `protobuf:"bytes,3,opt,name=totalHits,proto3" json:"totalHits,omitempty"`
	// Ordered hits with scoring/sorting info and retrieved fields
	Hits []*SearchResponse_Hit `protobuf:"bytes,4,rep,name=hits,proto3" json:"hits,omitempty"`
	// contains filtered or unexported fields
}

Result from top hits collector

func (*HitsResult) Descriptor deprecated added in v0.13.0 

func (*HitsResult) Descriptor() ([]byte, []int)

Deprecated: Use HitsResult.ProtoReflect.Descriptor instead.

func (*HitsResult) GetHits added in v0.13.0 

func (x *HitsResult) GetHits() []*SearchResponse_Hit

func (*HitsResult) GetTotalHits added in v0.13.0 

func (x *HitsResult) GetTotalHits() *TotalHits

func (*HitsResult) ProtoMessage added in v0.13.0 

func (*HitsResult) ProtoMessage()

func (*HitsResult) ProtoReflect added in v0.13.0 

func (x *HitsResult) ProtoReflect() protoreflect.Message

func (*HitsResult) Reset added in v0.13.0 

func (x *HitsResult) Reset()

func (*HitsResult) String added in v0.13.0 

func (x *HitsResult) String() string

type IndexGlobalState added in v0.12.0 

type IndexGlobalState struct {

	// Unique identifier for index (yyyyMMddHHmmssSSS formatted date-time string)
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// If index should be started
	Started bool `protobuf:"varint,2,opt,name=started,proto3" json:"started,omitempty"`
	// contains filtered or unexported fields
}

Per index information stored in global state

func (*IndexGlobalState) Descriptor deprecated added in v0.12.0 

func (*IndexGlobalState) Descriptor() ([]byte, []int)

Deprecated: Use IndexGlobalState.ProtoReflect.Descriptor instead.

func (*IndexGlobalState) GetId added in v0.12.0 

func (x *IndexGlobalState) GetId() string

func (*IndexGlobalState) GetStarted added in v0.12.0 

func (x *IndexGlobalState) GetStarted() bool

func (*IndexGlobalState) ProtoMessage added in v0.12.0 

func (*IndexGlobalState) ProtoMessage()

func (*IndexGlobalState) ProtoReflect added in v0.12.0 

func (x *IndexGlobalState) ProtoReflect() protoreflect.Message

func (*IndexGlobalState) Reset added in v0.12.0 

func (x *IndexGlobalState) Reset()

func (*IndexGlobalState) String added in v0.12.0 

func (x *IndexGlobalState) String() string

type IndexLiveSettings added in v0.11.0 

type IndexLiveSettings struct {

	// Longest time to wait before reopening IndexSearcher (i.e., periodic background reopen), default: 1.0
	MaxRefreshSec *wrapperspb.DoubleValue `protobuf:"bytes,1,opt,name=maxRefreshSec,proto3" json:"maxRefreshSec,omitempty"`
	// Shortest time to wait before reopening IndexSearcher (i.e., when a search is waiting for a specific indexGen),
	// default: 0.05
	MinRefreshSec *wrapperspb.DoubleValue `protobuf:"bytes,2,opt,name=minRefreshSec,proto3" json:"minRefreshSec,omitempty"`
	// Non-current searchers older than this are pruned, default: 60.0
	MaxSearcherAgeSec *wrapperspb.DoubleValue `protobuf:"bytes,3,opt,name=maxSearcherAgeSec,proto3" json:"maxSearcherAgeSec,omitempty"`
	// Size (in MB) of IndexWriter's RAM buffer, default: 16.0
	IndexRamBufferSizeMB *wrapperspb.DoubleValue `protobuf:"bytes,4,opt,name=indexRamBufferSizeMB,proto3" json:"indexRamBufferSizeMB,omitempty"`
	// Max number of documents to add at a time, default: 100
	AddDocumentsMaxBufferLen *wrapperspb.Int32Value `protobuf:"bytes,5,opt,name=addDocumentsMaxBufferLen,proto3" json:"addDocumentsMaxBufferLen,omitempty"`
	// Maximum number of documents allowed in a parallel search slice, default: 250,000
	SliceMaxDocs *wrapperspb.Int32Value `protobuf:"bytes,6,opt,name=sliceMaxDocs,proto3" json:"sliceMaxDocs,omitempty"`
	// Maximum number of segments allowed in a parallel search slice, default: 5
	SliceMaxSegments *wrapperspb.Int32Value `protobuf:"bytes,7,opt,name=sliceMaxSegments,proto3" json:"sliceMaxSegments,omitempty"`
	// Number of virtual shards to use for this index, default: 1
	VirtualShards *wrapperspb.Int32Value `protobuf:"bytes,8,opt,name=virtualShards,proto3" json:"virtualShards,omitempty"`
	// Maximum sized segment to produce during normal merging, default: 5GB
	MaxMergedSegmentMB *wrapperspb.Int32Value `protobuf:"bytes,9,opt,name=maxMergedSegmentMB,proto3" json:"maxMergedSegmentMB,omitempty"`
	// Number of segments per tier used by TieredMergePolicy, default: 10
	SegmentsPerTier *wrapperspb.Int32Value `protobuf:"bytes,10,opt,name=segmentsPerTier,proto3" json:"segmentsPerTier,omitempty"`
	// Timeout value to used when not specified in the search request, or 0 for no timeout, default: 0
	DefaultSearchTimeoutSec *wrapperspb.DoubleValue `protobuf:"bytes,11,opt,name=defaultSearchTimeoutSec,proto3" json:"defaultSearchTimeoutSec,omitempty"`
	// Timeout check every value to use when not specified in the search request, or 0 for none, default: 0
	DefaultSearchTimeoutCheckEvery *wrapperspb.Int32Value `protobuf:"bytes,12,opt,name=defaultSearchTimeoutCheckEvery,proto3" json:"defaultSearchTimeoutCheckEvery,omitempty"`
	// Terminate after value to use when not specified in the search request, or 0 for none, default: 0
	DefaultTerminateAfter *wrapperspb.Int32Value `protobuf:"bytes,13,opt,name=defaultTerminateAfter,proto3" json:"defaultTerminateAfter,omitempty"`
	// Merge precopy would be stopped after this time, or 0 for no checks, default: 0
	MaxMergePreCopyDurationSec *wrapperspb.UInt64Value `protobuf:"bytes,14,opt,name=maxMergePreCopyDurationSec,proto3" json:"maxMergePreCopyDurationSec,omitempty"`
	// Collect and publish additional index metrics, which may be more expensive in terms of volume, memory
	// and/or compute, default: false
	VerboseMetrics *wrapperspb.BoolValue `protobuf:"bytes,15,opt,name=verboseMetrics,proto3" json:"verboseMetrics,omitempty"`
	// If fetch parallelism should be done by groups of fields instead of document, default: false
	ParallelFetchByField *wrapperspb.BoolValue `protobuf:"bytes,16,opt,name=parallelFetchByField,proto3" json:"parallelFetchByField,omitempty"`
	// The number of documents/fields per parallel fetch task, default: 50
	ParallelFetchChunkSize *wrapperspb.Int32Value `protobuf:"bytes,17,opt,name=parallelFetchChunkSize,proto3" json:"parallelFetchChunkSize,omitempty"`
	// Terminate after max recall count value to use when not specified in the search request, or 0 for none, default: 0
	DefaultTerminateAfterMaxRecallCount *wrapperspb.Int32Value `protobuf:"bytes,18,opt,name=defaultTerminateAfterMaxRecallCount,proto3" json:"defaultTerminateAfterMaxRecallCount,omitempty"`
	// contains filtered or unexported fields
}

Index live settings

func (*IndexLiveSettings) Descriptor deprecated added in v0.11.0 

func (*IndexLiveSettings) Descriptor() ([]byte, []int)

Deprecated: Use IndexLiveSettings.ProtoReflect.Descriptor instead.

func (*IndexLiveSettings) GetAddDocumentsMaxBufferLen added in v0.11.0 

func (x *IndexLiveSettings) GetAddDocumentsMaxBufferLen() *wrapperspb.Int32Value

func (*IndexLiveSettings) GetDefaultSearchTimeoutCheckEvery added in v0.11.0 

func (x *IndexLiveSettings) GetDefaultSearchTimeoutCheckEvery() *wrapperspb.Int32Value

func (*IndexLiveSettings) GetDefaultSearchTimeoutSec added in v0.11.0 

func (x *IndexLiveSettings) GetDefaultSearchTimeoutSec() *wrapperspb.DoubleValue

func (*IndexLiveSettings) GetDefaultTerminateAfter added in v0.11.0 

func (x *IndexLiveSettings) GetDefaultTerminateAfter() *wrapperspb.Int32Value

func (*IndexLiveSettings) GetDefaultTerminateAfterMaxRecallCount added in v0.41.0 

func (x *IndexLiveSettings) GetDefaultTerminateAfterMaxRecallCount() *wrapperspb.Int32Value

func (*IndexLiveSettings) GetIndexRamBufferSizeMB added in v0.11.0 

func (x *IndexLiveSettings) GetIndexRamBufferSizeMB() *wrapperspb.DoubleValue

func (*IndexLiveSettings) GetMaxMergePreCopyDurationSec added in v0.17.0 

func (x *IndexLiveSettings) GetMaxMergePreCopyDurationSec() *wrapperspb.UInt64Value

func (*IndexLiveSettings) GetMaxMergedSegmentMB added in v0.11.0 

func (x *IndexLiveSettings) GetMaxMergedSegmentMB() *wrapperspb.Int32Value

func (*IndexLiveSettings) GetMaxRefreshSec added in v0.11.0 

func (x *IndexLiveSettings) GetMaxRefreshSec() *wrapperspb.DoubleValue

func (*IndexLiveSettings) GetMaxSearcherAgeSec added in v0.11.0 

func (x *IndexLiveSettings) GetMaxSearcherAgeSec() *wrapperspb.DoubleValue

func (*IndexLiveSettings) GetMinRefreshSec added in v0.11.0 

func (x *IndexLiveSettings) GetMinRefreshSec() *wrapperspb.DoubleValue

func (*IndexLiveSettings) GetParallelFetchByField 

func (x *IndexLiveSettings) GetParallelFetchByField() *wrapperspb.BoolValue

func (*IndexLiveSettings) GetParallelFetchChunkSize 

func (x *IndexLiveSettings) GetParallelFetchChunkSize() *wrapperspb.Int32Value

func (*IndexLiveSettings) GetSegmentsPerTier added in v0.11.0 

func (x *IndexLiveSettings) GetSegmentsPerTier() *wrapperspb.Int32Value

func (*IndexLiveSettings) GetSliceMaxDocs added in v0.11.0 

func (x *IndexLiveSettings) GetSliceMaxDocs() *wrapperspb.Int32Value

func (*IndexLiveSettings) GetSliceMaxSegments added in v0.11.0 

func (x *IndexLiveSettings) GetSliceMaxSegments() *wrapperspb.Int32Value

func (*IndexLiveSettings) GetVerboseMetrics added in v0.29.0 

func (x *IndexLiveSettings) GetVerboseMetrics() *wrapperspb.BoolValue

func (*IndexLiveSettings) GetVirtualShards added in v0.11.0 

func (x *IndexLiveSettings) GetVirtualShards() *wrapperspb.Int32Value

func (*IndexLiveSettings) ProtoMessage added in v0.11.0 

func (*IndexLiveSettings) ProtoMessage()

func (*IndexLiveSettings) ProtoReflect added in v0.11.0 

func (x *IndexLiveSettings) ProtoReflect() protoreflect.Message

func (*IndexLiveSettings) Reset added in v0.11.0 

func (x *IndexLiveSettings) Reset()

func (*IndexLiveSettings) String added in v0.11.0 

func (x *IndexLiveSettings) String() string

type IndexName 

type IndexName struct {

	// Magic number send on all requests since these are meant for internal communication only
	MagicNumber int32 `protobuf:"varint,1,opt,name=magicNumber,proto3" json:"magicNumber,omitempty"`
	// Index name
	IndexName string `protobuf:"bytes,2,opt,name=indexName,proto3" json:"indexName,omitempty"`
	// contains filtered or unexported fields
}

Index name with magic number

func (*IndexName) Descriptor deprecated 

func (*IndexName) Descriptor() ([]byte, []int)

Deprecated: Use IndexName.ProtoReflect.Descriptor instead.

func (*IndexName) GetIndexName 

func (x *IndexName) GetIndexName() string

func (*IndexName) GetMagicNumber 

func (x *IndexName) GetMagicNumber() int32

func (*IndexName) ProtoMessage 

func (*IndexName) ProtoMessage()

func (*IndexName) ProtoReflect 

func (x *IndexName) ProtoReflect() protoreflect.Message

func (*IndexName) Reset 

func (x *IndexName) Reset()

func (*IndexName) String 

func (x *IndexName) String() string

type IndexOptions 

type IndexOptions int32

How text tokens should be indexed 

const (
	// Use field default index options: ATOM=DOCS, TEXT=DOCS_FREQS_POSITIONS
	IndexOptions_DEFAULT IndexOptions = 0
	// Index only doc ids
	IndexOptions_DOCS IndexOptions = 1
	// Index doc ids and term frequencies
	IndexOptions_DOCS_FREQS IndexOptions = 2
	// Index doc ids, term frequencies and positions
	IndexOptions_DOCS_FREQS_POSITIONS IndexOptions = 3
	// Index doc ids, term frequencies, positions and offsets
	IndexOptions_DOCS_FREQS_POSITIONS_OFFSETS IndexOptions = 4
)

func (IndexOptions) Descriptor 

func (IndexOptions) Descriptor() protoreflect.EnumDescriptor

func (IndexOptions) Enum 

func (x IndexOptions) Enum() *IndexOptions

func (IndexOptions) EnumDescriptor deprecated 

func (IndexOptions) EnumDescriptor() ([]byte, []int)

Deprecated: Use IndexOptions.Descriptor instead.

func (IndexOptions) Number 

func (x IndexOptions) Number() protoreflect.EnumNumber

func (IndexOptions) String 

func (x IndexOptions) String() string

func (IndexOptions) Type 

func (IndexOptions) Type() protoreflect.EnumType

type IndexSettings added in v0.11.0 

type IndexSettings struct {

	// Largest merged segment size to cache in RAMDirectory, default: 5.0MB
	NrtCachingDirectoryMaxMergeSizeMB *wrapperspb.DoubleValue `protobuf:"bytes,1,opt,name=nrtCachingDirectoryMaxMergeSizeMB,proto3" json:"nrtCachingDirectoryMaxMergeSizeMB,omitempty"`
	// Largest overall size for all files cached in NRTCachingDirectory, default: 60.0MB
	NrtCachingDirectoryMaxSizeMB *wrapperspb.DoubleValue `protobuf:"bytes,2,opt,name=nrtCachingDirectoryMaxSizeMB,proto3" json:"nrtCachingDirectoryMaxSizeMB,omitempty"`
	// How many merge threads to allow at once
	ConcurrentMergeSchedulerMaxThreadCount *wrapperspb.Int32Value `` /* 129-byte string literal not displayed */
	// Maximum backlog of pending merges before indexing threads are stalled
	ConcurrentMergeSchedulerMaxMergeCount *wrapperspb.Int32Value `` /* 127-byte string literal not displayed */
	// Index time sorting; can only be written once", SearchHandler.SORT_TYPE
	IndexSort *SortFields `protobuf:"bytes,5,opt,name=indexSort,proto3" json:"indexSort,omitempty"`
	// Turn on/off the merge scheduler's auto throttling, default: off
	IndexMergeSchedulerAutoThrottle *wrapperspb.BoolValue `protobuf:"bytes,6,opt,name=indexMergeSchedulerAutoThrottle,proto3" json:"indexMergeSchedulerAutoThrottle,omitempty"`
	// Base Directory implementation to use either one of the core implementations
	// (FSDirectory, MMapDirectory, NIOFSDirectory, or a fully qualified path to a Directory
	// implementation that has a public constructor taking a single File argument default: FSDirectory.
	// This implementation will be wrapped by NRTCachingDirectory, if enabled and not using MMappedDirectory.
	Directory *wrapperspb.StringValue `protobuf:"bytes,7,opt,name=directory,proto3" json:"directory,omitempty"`
	// contains filtered or unexported fields
}

Index offline settings

func (*IndexSettings) Descriptor deprecated added in v0.11.0 

func (*IndexSettings) Descriptor() ([]byte, []int)

Deprecated: Use IndexSettings.ProtoReflect.Descriptor instead.

func (*IndexSettings) GetConcurrentMergeSchedulerMaxMergeCount added in v0.11.0 

func (x *IndexSettings) GetConcurrentMergeSchedulerMaxMergeCount() *wrapperspb.Int32Value

func (*IndexSettings) GetConcurrentMergeSchedulerMaxThreadCount added in v0.11.0 

func (x *IndexSettings) GetConcurrentMergeSchedulerMaxThreadCount() *wrapperspb.Int32Value

func (*IndexSettings) GetDirectory added in v0.11.0 

func (x *IndexSettings) GetDirectory() *wrapperspb.StringValue

func (*IndexSettings) GetIndexMergeSchedulerAutoThrottle added in v0.11.0 

func (x *IndexSettings) GetIndexMergeSchedulerAutoThrottle() *wrapperspb.BoolValue

func (*IndexSettings) GetIndexSort added in v0.11.0 

func (x *IndexSettings) GetIndexSort() *SortFields

func (*IndexSettings) GetNrtCachingDirectoryMaxMergeSizeMB added in v0.11.0 

func (x *IndexSettings) GetNrtCachingDirectoryMaxMergeSizeMB() *wrapperspb.DoubleValue

func (*IndexSettings) GetNrtCachingDirectoryMaxSizeMB added in v0.11.0 

func (x *IndexSettings) GetNrtCachingDirectoryMaxSizeMB() *wrapperspb.DoubleValue

func (*IndexSettings) ProtoMessage added in v0.11.0 

func (*IndexSettings) ProtoMessage()

func (*IndexSettings) ProtoReflect added in v0.11.0 

func (x *IndexSettings) ProtoReflect() protoreflect.Message

func (*IndexSettings) Reset added in v0.11.0 

func (x *IndexSettings) Reset()

func (*IndexSettings) String added in v0.11.0 

func (x *IndexSettings) String() string

type IndexStateInfo added in v0.11.0 

type IndexStateInfo struct {

	// Name of the index
	IndexName string `protobuf:"bytes,1,opt,name=indexName,proto3" json:"indexName,omitempty"`
	// State version generation
	Gen int64 `protobuf:"varint,2,opt,name=gen,proto3" json:"gen,omitempty"`
	// If this index has ever been committed
	Committed bool `protobuf:"varint,3,opt,name=committed,proto3" json:"committed,omitempty"`
	// Index settings
	Settings *IndexSettings `protobuf:"bytes,4,opt,name=settings,proto3" json:"settings,omitempty"`
	// Index live settings
	LiveSettings *IndexLiveSettings `protobuf:"bytes,5,opt,name=liveSettings,proto3" json:"liveSettings,omitempty"`
	// Registered fields
	Fields map[string]*Field `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

Index state

func (*IndexStateInfo) Descriptor deprecated added in v0.11.0 

func (*IndexStateInfo) Descriptor() ([]byte, []int)

Deprecated: Use IndexStateInfo.ProtoReflect.Descriptor instead.

func (*IndexStateInfo) GetCommitted added in v0.11.0 

func (x *IndexStateInfo) GetCommitted() bool

func (*IndexStateInfo) GetFields added in v0.11.0 

func (x *IndexStateInfo) GetFields() map[string]*Field

func (*IndexStateInfo) GetGen added in v0.11.0 

func (x *IndexStateInfo) GetGen() int64

func (*IndexStateInfo) GetIndexName added in v0.11.0 

func (x *IndexStateInfo) GetIndexName() string

func (*IndexStateInfo) GetLiveSettings added in v0.11.0 

func (x *IndexStateInfo) GetLiveSettings() *IndexLiveSettings

func (*IndexStateInfo) GetSettings added in v0.11.0 

func (x *IndexStateInfo) GetSettings() *IndexSettings

func (*IndexStateInfo) ProtoMessage added in v0.11.0 

func (*IndexStateInfo) ProtoMessage()

func (*IndexStateInfo) ProtoReflect added in v0.11.0 

func (x *IndexStateInfo) ProtoReflect() protoreflect.Message

func (*IndexStateInfo) Reset added in v0.11.0 

func (x *IndexStateInfo) Reset()

func (*IndexStateInfo) String added in v0.11.0 

func (x *IndexStateInfo) String() string

type IndexStateRequest 

type IndexStateRequest struct {

	// Index name
	IndexName string `protobuf:"bytes,1,opt,name=index_name,json=indexName,proto3" json:"index_name,omitempty"`
	// contains filtered or unexported fields
}

Input to indexState

func (*IndexStateRequest) Descriptor deprecated 

func (*IndexStateRequest) Descriptor() ([]byte, []int)

Deprecated: Use IndexStateRequest.ProtoReflect.Descriptor instead.

func (*IndexStateRequest) GetIndexName 

func (x *IndexStateRequest) GetIndexName() string

func (*IndexStateRequest) ProtoMessage 

func (*IndexStateRequest) ProtoMessage()

func (*IndexStateRequest) ProtoReflect 

func (x *IndexStateRequest) ProtoReflect() protoreflect.Message

func (*IndexStateRequest) Reset 

func (x *IndexStateRequest) Reset()

func (*IndexStateRequest) String 

func (x *IndexStateRequest) String() string

type IndexStateResponse 

type IndexStateResponse struct {

	// Index state
	IndexState *IndexStateInfo `protobuf:"bytes,1,opt,name=index_state,json=indexState,proto3" json:"index_state,omitempty"`
	// contains filtered or unexported fields
}

Response from Server for indexState

func (*IndexStateResponse) Descriptor deprecated 

func (*IndexStateResponse) Descriptor() ([]byte, []int)

Deprecated: Use IndexStateResponse.ProtoReflect.Descriptor instead.

func (*IndexStateResponse) GetIndexState 

func (x *IndexStateResponse) GetIndexState() *IndexStateInfo

func (*IndexStateResponse) ProtoMessage 

func (*IndexStateResponse) ProtoMessage()

func (*IndexStateResponse) ProtoReflect 

func (x *IndexStateResponse) ProtoReflect() protoreflect.Message

func (*IndexStateResponse) Reset 

func (x *IndexStateResponse) Reset()

func (*IndexStateResponse) String 

func (x *IndexStateResponse) String() string

type IndexStatsResponse 

type IndexStatsResponse struct {

	// Index name
	IndexName string `protobuf:"bytes,1,opt,name=indexName,proto3" json:"indexName,omitempty"`
	// Index stats
	StatsResponse *StatsResponse `protobuf:"bytes,2,opt,name=statsResponse,proto3" json:"statsResponse,omitempty"`
	// contains filtered or unexported fields
}

Index stats response

func (*IndexStatsResponse) Descriptor deprecated 

func (*IndexStatsResponse) Descriptor() ([]byte, []int)

Deprecated: Use IndexStatsResponse.ProtoReflect.Descriptor instead.

func (*IndexStatsResponse) GetIndexName 

func (x *IndexStatsResponse) GetIndexName() string

func (*IndexStatsResponse) GetStatsResponse 

func (x *IndexStatsResponse) GetStatsResponse() *StatsResponse

func (*IndexStatsResponse) ProtoMessage 

func (*IndexStatsResponse) ProtoMessage()

func (*IndexStatsResponse) ProtoReflect 

func (x *IndexStatsResponse) ProtoReflect() protoreflect.Message

func (*IndexStatsResponse) Reset 

func (x *IndexStatsResponse) Reset()

func (*IndexStatsResponse) String 

func (x *IndexStatsResponse) String() string

type IndicesRequest 

type IndicesRequest struct {
	// contains filtered or unexported fields
}

Input to indices

func (*IndicesRequest) Descriptor deprecated 

func (*IndicesRequest) Descriptor() ([]byte, []int)

Deprecated: Use IndicesRequest.ProtoReflect.Descriptor instead.

func (*IndicesRequest) ProtoMessage 

func (*IndicesRequest) ProtoMessage()

func (*IndicesRequest) ProtoReflect 

func (x *IndicesRequest) ProtoReflect() protoreflect.Message

func (*IndicesRequest) Reset 

func (x *IndicesRequest) Reset()

func (*IndicesRequest) String 

func (x *IndicesRequest) String() string

type IndicesResponse 

type IndicesResponse struct {

	// List of index stats
	IndicesResponse []*IndexStatsResponse `protobuf:"bytes,1,rep,name=indicesResponse,proto3" json:"indicesResponse,omitempty"`
	// contains filtered or unexported fields
}

Response from Server for indices

func (*IndicesResponse) Descriptor deprecated 

func (*IndicesResponse) Descriptor() ([]byte, []int)

Deprecated: Use IndicesResponse.ProtoReflect.Descriptor instead.

func (*IndicesResponse) GetIndicesResponse 

func (x *IndicesResponse) GetIndicesResponse() []*IndexStatsResponse

func (*IndicesResponse) ProtoMessage 

func (*IndicesResponse) ProtoMessage()

func (*IndicesResponse) ProtoReflect 

func (x *IndicesResponse) ProtoReflect() protoreflect.Message

func (*IndicesResponse) Reset 

func (x *IndicesResponse) Reset()

func (*IndicesResponse) String 

func (x *IndicesResponse) String() string

type InnerHit added in v0.25.0 

type InnerHit struct {

	// Nested path to search against assuming same index as the parent Query
	QueryNestedPath string `protobuf:"bytes,1,opt,name=query_nested_path,json=queryNestedPath,proto3" json:"query_nested_path,omitempty"`
	// Which hit to start from (for pagination); default: 0
	StartHit int32 `protobuf:"varint,2,opt,name=start_hit,json=startHit,proto3" json:"start_hit,omitempty"`
	// How many top hits to retrieve; default: 3. It limits the hits returned, starting from index 0.
	// For pagination: set it to startHit + window_size.
	TopHits int32 `protobuf:"varint,3,opt,name=top_hits,json=topHits,proto3" json:"top_hits,omitempty"`
	// InnerHit query to query against the nested documents specified by queryNestedPath
	InnerQuery *Query `protobuf:"bytes,4,opt,name=inner_query,json=innerQuery,proto3" json:"inner_query,omitempty"`
	// Fields to retrieve; Parent's fields except its id field are unavailable in the innerHit
	RetrieveFields []string `protobuf:"bytes,5,rep,name=retrieve_fields,json=retrieveFields,proto3" json:"retrieve_fields,omitempty"`
	// Sort hits by field (default is by relevance)
	QuerySort *QuerySortField `protobuf:"bytes,6,opt,name=query_sort,json=querySort,proto3" json:"query_sort,omitempty"`
	// Highlight the children documents
	Highlight *Highlight `protobuf:"bytes,7,opt,name=highlight,proto3" json:"highlight,omitempty"`
	// contains filtered or unexported fields
}

Inner Hit search request

func (*InnerHit) Descriptor deprecated added in v0.25.0 

func (*InnerHit) Descriptor() ([]byte, []int)

Deprecated: Use InnerHit.ProtoReflect.Descriptor instead.

func (*InnerHit) GetHighlight added in v0.25.0 

func (x *InnerHit) GetHighlight() *Highlight

func (*InnerHit) GetInnerQuery added in v0.25.0 

func (x *InnerHit) GetInnerQuery() *Query

func (*InnerHit) GetQueryNestedPath added in v0.25.0 

func (x *InnerHit) GetQueryNestedPath() string

func (*InnerHit) GetQuerySort added in v0.25.0 

func (x *InnerHit) GetQuerySort() *QuerySortField

func (*InnerHit) GetRetrieveFields added in v0.25.0 

func (x *InnerHit) GetRetrieveFields() []string

func (*InnerHit) GetStartHit added in v0.25.0 

func (x *InnerHit) GetStartHit() int32

func (*InnerHit) GetTopHits added in v0.25.0 

func (x *InnerHit) GetTopHits() int32

func (*InnerHit) ProtoMessage added in v0.25.0 

func (*InnerHit) ProtoMessage()

func (*InnerHit) ProtoReflect added in v0.25.0 

func (x *InnerHit) ProtoReflect() protoreflect.Message

func (*InnerHit) Reset added in v0.25.0 

func (x *InnerHit) Reset()

func (*InnerHit) String added in v0.25.0 

func (x *InnerHit) String() string

type IntObject 

type IntObject struct {

	// Value of the int
	Int int32 `protobuf:"varint,1,opt,name=int,proto3" json:"int,omitempty"`
	// contains filtered or unexported fields
}

Used to be able to check if a value was set

func (*IntObject) Descriptor deprecated 

func (*IntObject) Descriptor() ([]byte, []int)

Deprecated: Use IntObject.ProtoReflect.Descriptor instead.

func (*IntObject) GetInt 

func (x *IntObject) GetInt() int32

func (*IntObject) ProtoMessage 

func (*IntObject) ProtoMessage()

func (*IntObject) ProtoReflect 

func (x *IntObject) ProtoReflect() protoreflect.Message

func (*IntObject) Reset 

func (x *IntObject) Reset()

func (*IntObject) String 

func (x *IntObject) String() string

type KnnQuery 

type KnnQuery struct {

	// Vector field name
	Field string `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
	// Query used to filter vector search, or unset for no filter
	Filter *Query `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// Number of top nearest neighbor documents to collect, must be <= num_candidates
	K int32 `protobuf:"varint,3,opt,name=k,proto3" json:"k,omitempty"`
	// Number of nearest neighbors to consider per segment. A larger value produces a more accurate top k.
	// Must be <= 10000.
	NumCandidates int32 `protobuf:"varint,4,opt,name=num_candidates,json=numCandidates,proto3" json:"num_candidates,omitempty"`
	// Vector value to use for query vector, for fields with float element type
	QueryVector []float32 `protobuf:"fixed32,5,rep,packed,name=query_vector,json=queryVector,proto3" json:"query_vector,omitempty"`
	// Vector value to use for query vector, for fields with byte element type
	QueryByteVector []byte `protobuf:"bytes,6,opt,name=query_byte_vector,json=queryByteVector,proto3" json:"query_byte_vector,omitempty"`
	// Boost multiplier for similarity score
	Boost float32 `protobuf:"fixed32,7,opt,name=boost,proto3" json:"boost,omitempty"`
	// contains filtered or unexported fields
}

Specification for kNN vector search query

func (*KnnQuery) Descriptor deprecated 

func (*KnnQuery) Descriptor() ([]byte, []int)

Deprecated: Use KnnQuery.ProtoReflect.Descriptor instead.

func (*KnnQuery) GetBoost 

func (x *KnnQuery) GetBoost() float32

func (*KnnQuery) GetField 

func (x *KnnQuery) GetField() string

func (*KnnQuery) GetFilter 

func (x *KnnQuery) GetFilter() *Query

func (*KnnQuery) GetK 

func (x *KnnQuery) GetK() int32

func (*KnnQuery) GetNumCandidates 

func (x *KnnQuery) GetNumCandidates() int32

func (*KnnQuery) GetQueryByteVector 

func (x *KnnQuery) GetQueryByteVector() []byte

func (*KnnQuery) GetQueryVector 

func (x *KnnQuery) GetQueryVector() []float32

func (*KnnQuery) ProtoMessage 

func (*KnnQuery) ProtoMessage()

func (*KnnQuery) ProtoReflect 

func (x *KnnQuery) ProtoReflect() protoreflect.Message

func (*KnnQuery) Reset 

func (x *KnnQuery) Reset()

func (*KnnQuery) String 

func (x *KnnQuery) String() string

type LabelAndValue 

type LabelAndValue struct {
	Label string  `protobuf:"bytes,1,opt,name=label,proto3" json:"label,omitempty"`   //Facet's label.
	Value float64 `protobuf:"fixed64,2,opt,name=value,proto3" json:"value,omitempty"` // Value associated with this label.
	// contains filtered or unexported fields
}

Facet result label and value

func (*LabelAndValue) Descriptor deprecated 

func (*LabelAndValue) Descriptor() ([]byte, []int)

Deprecated: Use LabelAndValue.ProtoReflect.Descriptor instead.

func (*LabelAndValue) GetLabel 

func (x *LabelAndValue) GetLabel() string

func (*LabelAndValue) GetValue 

func (x *LabelAndValue) GetValue() float64

func (*LabelAndValue) ProtoMessage 

func (*LabelAndValue) ProtoMessage()

func (*LabelAndValue) ProtoReflect 

func (x *LabelAndValue) ProtoReflect() protoreflect.Message

func (*LabelAndValue) Reset 

func (x *LabelAndValue) Reset()

func (*LabelAndValue) String 

func (x *LabelAndValue) String() string

type LastHitInfo added in v0.40.0 

type LastHitInfo struct {

	// Last hit sort field values
	LastFieldValues []string `protobuf:"bytes,1,rep,name=lastFieldValues,proto3" json:"lastFieldValues,omitempty"`
	// Last hit Lucene doc id
	LastDocId int32 `protobuf:"varint,2,opt,name=lastDocId,proto3" json:"lastDocId,omitempty"`
	// Last hit score
	LastScore float32 `protobuf:"fixed32,3,opt,name=lastScore,proto3" json:"lastScore,omitempty"`
	// contains filtered or unexported fields
}

Last Hit info for search after

func (*LastHitInfo) Descriptor deprecated added in v0.40.0 

func (*LastHitInfo) Descriptor() ([]byte, []int)

Deprecated: Use LastHitInfo.ProtoReflect.Descriptor instead.

func (*LastHitInfo) GetLastDocId added in v0.40.0 

func (x *LastHitInfo) GetLastDocId() int32

func (*LastHitInfo) GetLastFieldValues added in v0.40.0 

func (x *LastHitInfo) GetLastFieldValues() []string

func (*LastHitInfo) GetLastScore added in v0.40.0 

func (x *LastHitInfo) GetLastScore() float32

func (*LastHitInfo) ProtoMessage added in v0.40.0 

func (*LastHitInfo) ProtoMessage()

func (*LastHitInfo) ProtoReflect added in v0.40.0 

func (x *LastHitInfo) ProtoReflect() protoreflect.Message

func (*LastHitInfo) Reset added in v0.40.0 

func (x *LastHitInfo) Reset()

func (*LastHitInfo) String added in v0.40.0 

func (x *LastHitInfo) String() string

type LiveSettingsRequest 

type LiveSettingsRequest struct {

	// Name of index whose liveSettings are to be updated
	IndexName string `protobuf:"bytes,1,opt,name=indexName,proto3" json:"indexName,omitempty"`
	// Longest time to wait before reopening IndexSearcher (i.e., periodic background reopen)
	MaxRefreshSec float64 `protobuf:"fixed64,2,opt,name=maxRefreshSec,proto3" json:"maxRefreshSec,omitempty"`
	// Shortest time to wait before reopening IndexSearcher (i.e., when a search is waiting for a specific indexGen)
	MinRefreshSec float64 `protobuf:"fixed64,3,opt,name=minRefreshSec,proto3" json:"minRefreshSec,omitempty"`
	// Non-current searchers older than this are pruned
	MaxSearcherAgeSec float64 `protobuf:"fixed64,4,opt,name=maxSearcherAgeSec,proto3" json:"maxSearcherAgeSec,omitempty"`
	// Size (in MB) of IndexWriter's RAM buffer
	IndexRamBufferSizeMB float64 `protobuf:"fixed64,5,opt,name=indexRamBufferSizeMB,proto3" json:"indexRamBufferSizeMB,omitempty"`
	// Max number of documents to add at a time
	AddDocumentsMaxBufferLen int32 `protobuf:"varint,6,opt,name=addDocumentsMaxBufferLen,proto3" json:"addDocumentsMaxBufferLen,omitempty"`
	// Maximum number of documents allowed in a parallel search slice
	SliceMaxDocs int32 `protobuf:"varint,7,opt,name=sliceMaxDocs,proto3" json:"sliceMaxDocs,omitempty"`
	// Maximum number of segments allowed in a parallel search slice
	SliceMaxSegments int32 `protobuf:"varint,8,opt,name=sliceMaxSegments,proto3" json:"sliceMaxSegments,omitempty"`
	// Number of virtual shards to use for this index
	VirtualShards int32 `protobuf:"varint,9,opt,name=virtualShards,proto3" json:"virtualShards,omitempty"`
	// Maximum sized segment to produce during normal merging
	MaxMergedSegmentMB int32 `protobuf:"varint,10,opt,name=maxMergedSegmentMB,proto3" json:"maxMergedSegmentMB,omitempty"`
	// Number of segments per tier used by TieredMergePolicy
	SegmentsPerTier int32 `protobuf:"varint,11,opt,name=segmentsPerTier,proto3" json:"segmentsPerTier,omitempty"`
	// Timeout value to used when not specified in the search request
	DefaultSearchTimeoutSec float64 `protobuf:"fixed64,12,opt,name=defaultSearchTimeoutSec,proto3" json:"defaultSearchTimeoutSec,omitempty"`
	// Timeout check every value to use when not specified in the search request
	DefaultSearchTimeoutCheckEvery int32 `protobuf:"varint,13,opt,name=defaultSearchTimeoutCheckEvery,proto3" json:"defaultSearchTimeoutCheckEvery,omitempty"`
	// Terminate after value to use when not specified in the search request
	DefaultTerminateAfter int32 `protobuf:"varint,14,opt,name=defaultTerminateAfter,proto3" json:"defaultTerminateAfter,omitempty"`
	// Terminate after max recall count value to use when not specified in the search request.
	DefaultTerminateAfterMaxRecallCount int32 `protobuf:"varint,15,opt,name=defaultTerminateAfterMaxRecallCount,proto3" json:"defaultTerminateAfterMaxRecallCount,omitempty"`
	// contains filtered or unexported fields
}

Input to liveSettings

func (*LiveSettingsRequest) Descriptor deprecated 

func (*LiveSettingsRequest) Descriptor() ([]byte, []int)

Deprecated: Use LiveSettingsRequest.ProtoReflect.Descriptor instead.

func (*LiveSettingsRequest) GetAddDocumentsMaxBufferLen 

func (x *LiveSettingsRequest) GetAddDocumentsMaxBufferLen() int32

func (*LiveSettingsRequest) GetDefaultSearchTimeoutCheckEvery 

func (x *LiveSettingsRequest) GetDefaultSearchTimeoutCheckEvery() int32

func (*LiveSettingsRequest) GetDefaultSearchTimeoutSec 

func (x *LiveSettingsRequest) GetDefaultSearchTimeoutSec() float64

func (*LiveSettingsRequest) GetDefaultTerminateAfter 

func (x *LiveSettingsRequest) GetDefaultTerminateAfter() int32

func (*LiveSettingsRequest) GetDefaultTerminateAfterMaxRecallCount added in v0.41.0 

func (x *LiveSettingsRequest) GetDefaultTerminateAfterMaxRecallCount() int32

func (*LiveSettingsRequest) GetIndexName 

func (x *LiveSettingsRequest) GetIndexName() string

func (*LiveSettingsRequest) GetIndexRamBufferSizeMB 

func (x *LiveSettingsRequest) GetIndexRamBufferSizeMB() float64

func (*LiveSettingsRequest) GetMaxMergedSegmentMB 

func (x *LiveSettingsRequest) GetMaxMergedSegmentMB() int32

func (*LiveSettingsRequest) GetMaxRefreshSec 

func (x *LiveSettingsRequest) GetMaxRefreshSec() float64

func (*LiveSettingsRequest) GetMaxSearcherAgeSec 

func (x *LiveSettingsRequest) GetMaxSearcherAgeSec() float64

func (*LiveSettingsRequest) GetMinRefreshSec 

func (x *LiveSettingsRequest) GetMinRefreshSec() float64

func (*LiveSettingsRequest) GetSegmentsPerTier 

func (x *LiveSettingsRequest) GetSegmentsPerTier() int32

func (*LiveSettingsRequest) GetSliceMaxDocs 

func (x *LiveSettingsRequest) GetSliceMaxDocs() int32

func (*LiveSettingsRequest) GetSliceMaxSegments 

func (x *LiveSettingsRequest) GetSliceMaxSegments() int32

func (*LiveSettingsRequest) GetVirtualShards 

func (x *LiveSettingsRequest) GetVirtualShards() int32

func (*LiveSettingsRequest) ProtoMessage 

func (*LiveSettingsRequest) ProtoMessage()

func (*LiveSettingsRequest) ProtoReflect 

func (x *LiveSettingsRequest) ProtoReflect() protoreflect.Message

func (*LiveSettingsRequest) Reset 

func (x *LiveSettingsRequest) Reset()

func (*LiveSettingsRequest) String 

func (x *LiveSettingsRequest) String() string

type LiveSettingsResponse 

type LiveSettingsResponse struct {

	// Json string of updated IndexLiveSettings
	Response string `protobuf:"bytes,1,opt,name=response,proto3" json:"response,omitempty"`
	// contains filtered or unexported fields
}

Response from Server to liveSettings

func (*LiveSettingsResponse) Descriptor deprecated 

func (*LiveSettingsResponse) Descriptor() ([]byte, []int)

Deprecated: Use LiveSettingsResponse.ProtoReflect.Descriptor instead.

func (*LiveSettingsResponse) GetResponse 

func (x *LiveSettingsResponse) GetResponse() string

func (*LiveSettingsResponse) ProtoMessage 

func (*LiveSettingsResponse) ProtoMessage()

func (*LiveSettingsResponse) ProtoReflect 

func (x *LiveSettingsResponse) ProtoReflect() protoreflect.Message

func (*LiveSettingsResponse) Reset 

func (x *LiveSettingsResponse) Reset()

func (*LiveSettingsResponse) String 

func (x *LiveSettingsResponse) String() string

type LiveSettingsV2Request added in v0.11.0 

type LiveSettingsV2Request struct {

	// Name of index whose liveSettings are to be updated
	IndexName string `protobuf:"bytes,1,opt,name=indexName,proto3" json:"indexName,omitempty"`
	// Live settings to merge into existing live settings, or unset to get current live settings
	LiveSettings *IndexLiveSettings `protobuf:"bytes,2,opt,name=liveSettings,proto3" json:"liveSettings,omitempty"`
	// When set to true, live settings changes are only applied to the local node. These changes are ephemeral,
	// so will not persist through a restart. Also, the live settings returned in the response will contain the
	// local overrides only when this flag is true.
	Local bool `protobuf:"varint,3,opt,name=local,proto3" json:"local,omitempty"`
	// contains filtered or unexported fields
}

Input to liveSettingsV2

func (*LiveSettingsV2Request) Descriptor deprecated added in v0.11.0 

func (*LiveSettingsV2Request) Descriptor() ([]byte, []int)

Deprecated: Use LiveSettingsV2Request.ProtoReflect.Descriptor instead.

func (*LiveSettingsV2Request) GetIndexName added in v0.11.0 

func (x *LiveSettingsV2Request) GetIndexName() string

func (*LiveSettingsV2Request) GetLiveSettings added in v0.11.0 

func (x *LiveSettingsV2Request) GetLiveSettings() *IndexLiveSettings

func (*LiveSettingsV2Request) GetLocal added in v0.30.0 

func (x *LiveSettingsV2Request) GetLocal() bool

func (*LiveSettingsV2Request) ProtoMessage added in v0.11.0 

func (*LiveSettingsV2Request) ProtoMessage()

func (*LiveSettingsV2Request) ProtoReflect added in v0.11.0 

func (x *LiveSettingsV2Request) ProtoReflect() protoreflect.Message

func (*LiveSettingsV2Request) Reset added in v0.11.0 

func (x *LiveSettingsV2Request) Reset()

func (*LiveSettingsV2Request) String added in v0.11.0 

func (x *LiveSettingsV2Request) String() string

type LiveSettingsV2Response added in v0.11.0 

type LiveSettingsV2Response struct {

	// Current live settings, including default values
	LiveSettings *IndexLiveSettings `protobuf:"bytes,1,opt,name=liveSettings,proto3" json:"liveSettings,omitempty"`
	// contains filtered or unexported fields
}

Response from Server to liveSettingsV2

func (*LiveSettingsV2Response) Descriptor deprecated added in v0.11.0 

func (*LiveSettingsV2Response) Descriptor() ([]byte, []int)

Deprecated: Use LiveSettingsV2Response.ProtoReflect.Descriptor instead.

func (*LiveSettingsV2Response) GetLiveSettings added in v0.11.0 

func (x *LiveSettingsV2Response) GetLiveSettings() *IndexLiveSettings

func (*LiveSettingsV2Response) ProtoMessage added in v0.11.0 

func (*LiveSettingsV2Response) ProtoMessage()

func (*LiveSettingsV2Response) ProtoReflect added in v0.11.0 

func (x *LiveSettingsV2Response) ProtoReflect() protoreflect.Message

func (*LiveSettingsV2Response) Reset added in v0.11.0 

func (x *LiveSettingsV2Response) Reset()

func (*LiveSettingsV2Response) String added in v0.11.0 

func (x *LiveSettingsV2Response) String() string

type LoggingHits added in v0.40.0 

type LoggingHits struct {

	// Name of the hits logger to be called, as registered by a HitsLoggerPlugin
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional logging parameters
	Params *structpb.Struct `protobuf:"bytes,2,opt,name=params,proto3" json:"params,omitempty"`
	// number of hits to log. The number of final hits to be logged can be less than this number
	// if a query has less hits.
	HitsToLog int32 `protobuf:"varint,3,opt,name=hitsToLog,proto3" json:"hitsToLog,omitempty"`
	// contains filtered or unexported fields
}

Defines logger for search hits

func (*LoggingHits) Descriptor deprecated added in v0.40.0 

func (*LoggingHits) Descriptor() ([]byte, []int)

Deprecated: Use LoggingHits.ProtoReflect.Descriptor instead.

func (*LoggingHits) GetHitsToLog added in v0.41.0 

func (x *LoggingHits) GetHitsToLog() int32

func (*LoggingHits) GetName added in v0.40.0 

func (x *LoggingHits) GetName() string

func (*LoggingHits) GetParams added in v0.40.0 

func (x *LoggingHits) GetParams() *structpb.Struct

func (*LoggingHits) ProtoMessage added in v0.40.0 

func (*LoggingHits) ProtoMessage()

func (*LoggingHits) ProtoReflect added in v0.40.0 

func (x *LoggingHits) ProtoReflect() protoreflect.Message

func (*LoggingHits) Reset added in v0.40.0 

func (x *LoggingHits) Reset()

func (*LoggingHits) String added in v0.40.0 

func (x *LoggingHits) String() string

type LuceneServerClient 

type LuceneServerClient interface {
	// Create an Index. Optionally, initial settings and live settings may be specified. The index is created
	// in the stopped state, unless specified.
	CreateIndex(ctx context.Context, in *CreateIndexRequest, opts ...grpc.CallOption) (*CreateIndexResponse, error)
	// Change live settings for an index. These settings may be changed while the index is started. Pass no
	// settings changes to retrieve current live settings.
	LiveSettings(ctx context.Context, in *LiveSettingsRequest, opts ...grpc.CallOption) (*LiveSettingsResponse, error)
	// Change live settings for an index. These settings may be changed while the index is started. Pass no
	// settings changes to retrieve current live settings.
	LiveSettingsV2(ctx context.Context, in *LiveSettingsV2Request, opts ...grpc.CallOption) (*LiveSettingsV2Response, error)
	// Adds one or more fields. Fields must be registered before they can be added in a document (via @addDocument).
	// Pass a list of Fields and an indexName. Any number of fields may be registered in a single request,
	// and once a field is registered it cannot be changed (write-once).
	// This returns the full set of fields currently registered.
	RegisterFields(ctx context.Context, in *FieldDefRequest, opts ...grpc.CallOption) (*FieldDefResponse, error)
	// Adds one or more fields to an index. The behavior is currently the same as registerFields.
	UpdateFields(ctx context.Context, in *FieldDefRequest, opts ...grpc.CallOption) (*FieldDefResponse, error)
	// Change offline settings for an index. The index must be in a stopped state to make settings changes.
	// This returns the currently set settings. Passing no settings changes retrieves the current settings.
	Settings(ctx context.Context, in *SettingsRequest, opts ...grpc.CallOption) (*SettingsResponse, error)
	// Change offline settings for an index. The index must be in a stopped state to make settings changes.
	// This returns the currently set settings. Passing no settings changes retrieves the current settings.
	SettingsV2(ctx context.Context, in *SettingsV2Request, opts ...grpc.CallOption) (*SettingsV2Response, error)
	// Starts an index
	StartIndex(ctx context.Context, in *StartIndexRequest, opts ...grpc.CallOption) (*StartIndexResponse, error)
	// Starts an index based on configuration in IndexStartConfig
	StartIndexV2(ctx context.Context, in *StartIndexV2Request, opts ...grpc.CallOption) (*StartIndexResponse, error)
	// Stops an index
	StopIndex(ctx context.Context, in *StopIndexRequest, opts ...grpc.CallOption) (*DummyResponse, error)
	// Reload state from the backend. When run on replicas, this processes state changes made by the primary.
	// New indices are created/started, and existing indices state is updated as needed.
	ReloadState(ctx context.Context, in *ReloadStateRequest, opts ...grpc.CallOption) (*ReloadStateResponse, error)
	// Adds a stream of Documents to an index. Changes are not durable until after the next successful @commit call.
	AddDocuments(ctx context.Context, opts ...grpc.CallOption) (LuceneServer_AddDocumentsClient, error)
	// Refresh the latest searcher for an index
	Refresh(ctx context.Context, in *RefreshRequest, opts ...grpc.CallOption) (*RefreshResponse, error)
	// Commits all pending index data changes to durable storage
	Commit(ctx context.Context, in *CommitRequest, opts ...grpc.CallOption) (*CommitResponse, error)
	// Retrieve index statistics
	Stats(ctx context.Context, in *StatsRequest, opts ...grpc.CallOption) (*StatsResponse, error)
	// Execute a search query against an index
	Search(ctx context.Context, in *SearchRequest, opts ...grpc.CallOption) (*SearchResponse, error)
	// Execute a search query against an index. Return response as an Any gRPC message. Useful if the client does
	// not need to process the response and wants to avoid some deserialization work.
	SearchV2(ctx context.Context, in *SearchRequest, opts ...grpc.CallOption) (*anypb.Any, error)
	// Delete documents from an index. Changes are not durable until after the next successful @commit call.
	Delete(ctx context.Context, in *AddDocumentRequest, opts ...grpc.CallOption) (*AddDocumentResponse, error)
	// Delete documents matching a query from an index. Changes are not durable until after the next successful
	// @commit call.
	DeleteByQuery(ctx context.Context, in *DeleteByQueryRequest, opts ...grpc.CallOption) (*AddDocumentResponse, error)
	// Delete all documents for index. Changes are not durable until after the next successful @commit call.
	DeleteAll(ctx context.Context, in *DeleteAllDocumentsRequest, opts ...grpc.CallOption) (*DeleteAllDocumentsResponse, error)
	// Delete index and all of its local data
	DeleteIndex(ctx context.Context, in *DeleteIndexRequest, opts ...grpc.CallOption) (*DeleteIndexResponse, error)
	// Creates a snapshot in the index, which is saved point-in-time view of the last commit
	// in the index such that no files referenced by that snapshot will be deleted by ongoing
	// indexing until the snapshot is released with @releaseSnapshot.  Note that this will
	// reference the last commit, so be sure to call commit first if you have pending changes
	// that you'd like to be included in the snapshot.
	// This can be used for backup purposes, i.e. after creating the snapshot you can copy
	// all referenced files to backup storage, and then release the snapshot once complete.
	// To restore the backup, just copy all the files back and restart the server.
	// It can also be used for transactional purposes, i.e. if you sometimes need to search a
	// specific snapshot instead of the current live index. Creating a snapshot is very fast
	// (does not require any file copying), but over time it will consume extra disk space as
	// old segments are merged in the index.  Be sure to release the snapshot once you're done.
	// Snapshots survive shutdown and restart of the server.  Returns all protected filenames
	// referenced by this snapshot: these files will not change and will not be deleted until
	// the snapshot is released. This returns the directories and files referenced by the snapshot.
	CreateSnapshot(ctx context.Context, in *CreateSnapshotRequest, opts ...grpc.CallOption) (*CreateSnapshotResponse, error)
	// Releases a snapshot previously created with @createSnapshot.
	ReleaseSnapshot(ctx context.Context, in *ReleaseSnapshotRequest, opts ...grpc.CallOption) (*ReleaseSnapshotResponse, error)
	// Gets all unreleased index gens of snapshots previously created with @createSnapshot
	GetAllSnapshotIndexGen(ctx context.Context, in *GetAllSnapshotGenRequest, opts ...grpc.CallOption) (*GetAllSnapshotGenResponse, error)
	// Backup warming queries for an index to S3
	BackupWarmingQueries(ctx context.Context, in *BackupWarmingQueriesRequest, opts ...grpc.CallOption) (*BackupWarmingQueriesResponse, error)
	// Get information about this node
	NodeInfo(ctx context.Context, in *NodeInfoRequest, opts ...grpc.CallOption) (*NodeInfoResponse, error)
	// Get the global state of the cluster
	GlobalState(ctx context.Context, in *GlobalStateRequest, opts ...grpc.CallOption) (*GlobalStateResponse, error)
	// Gets the state of an index, includes settings, live_settings, search schema
	State(ctx context.Context, in *StateRequest, opts ...grpc.CallOption) (*StateResponse, error)
	// Gets the state information for an index, includes settings, live_settings, search schema
	IndexState(ctx context.Context, in *IndexStateRequest, opts ...grpc.CallOption) (*IndexStateResponse, error)
	// Basic healthcheck, successful if the server is running
	Status(ctx context.Context, in *HealthCheckRequest, opts ...grpc.CallOption) (*HealthCheckResponse, error)
	// Checks if a node is ready to receive traffic by checking if all the indices configured to be started
	// are started. Can specify comma-separated list of index names to only check specific indices if needed.
	Ready(ctx context.Context, in *ReadyCheckRequest, opts ...grpc.CallOption) (*HealthCheckResponse, error)
	// Get prometheus metrics
	Metrics(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*httpbody.HttpBody, error)
	// Get information for all created indices
	Indices(ctx context.Context, in *IndicesRequest, opts ...grpc.CallOption) (*IndicesResponse, error)
	// Forces merge policy to merge segments until there are <= maxNumSegments. The actual
	// merges to be executed are determined by the MergePolicy. This call will merge those
	// segments present in the index when the call started. If other threads are still
	// adding documents and flushing segments, those newly created segments will not be
	// merged unless you call forceMerge again.
	ForceMerge(ctx context.Context, in *ForceMergeRequest, opts ...grpc.CallOption) (*ForceMergeResponse, error)
	// Forces merging of all segments that have deleted documents. The actual merges to be
	// executed are determined by the MergePolicy. For example, the default TieredMergePolicy
	// will only pick a segment if the percentage of deleted docs is over 10%.
	// This method first flushes a new segment (if there are indexed documents), and applies
	// all buffered deletes.
	ForceMergeDeletes(ctx context.Context, in *ForceMergeDeletesRequest, opts ...grpc.CallOption) (*ForceMergeDeletesResponse, error)
	// Process request in a plugin which implements CustomRequestPlugin interface.
	Custom(ctx context.Context, in *CustomRequest, opts ...grpc.CallOption) (*CustomResponse, error)
}

LuceneServerClient is the client API for LuceneServer service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewLuceneServerClient 

func NewLuceneServerClient(cc grpc.ClientConnInterface) LuceneServerClient

type LuceneServerServer 

type LuceneServerServer interface {
	// Create an Index. Optionally, initial settings and live settings may be specified. The index is created
	// in the stopped state, unless specified.
	CreateIndex(context.Context, *CreateIndexRequest) (*CreateIndexResponse, error)
	// Change live settings for an index. These settings may be changed while the index is started. Pass no
	// settings changes to retrieve current live settings.
	LiveSettings(context.Context, *LiveSettingsRequest) (*LiveSettingsResponse, error)
	// Change live settings for an index. These settings may be changed while the index is started. Pass no
	// settings changes to retrieve current live settings.
	LiveSettingsV2(context.Context, *LiveSettingsV2Request) (*LiveSettingsV2Response, error)
	// Adds one or more fields. Fields must be registered before they can be added in a document (via @addDocument).
	// Pass a list of Fields and an indexName. Any number of fields may be registered in a single request,
	// and once a field is registered it cannot be changed (write-once).
	// This returns the full set of fields currently registered.
	RegisterFields(context.Context, *FieldDefRequest) (*FieldDefResponse, error)
	// Adds one or more fields to an index. The behavior is currently the same as registerFields.
	UpdateFields(context.Context, *FieldDefRequest) (*FieldDefResponse, error)
	// Change offline settings for an index. The index must be in a stopped state to make settings changes.
	// This returns the currently set settings. Passing no settings changes retrieves the current settings.
	Settings(context.Context, *SettingsRequest) (*SettingsResponse, error)
	// Change offline settings for an index. The index must be in a stopped state to make settings changes.
	// This returns the currently set settings. Passing no settings changes retrieves the current settings.
	SettingsV2(context.Context, *SettingsV2Request) (*SettingsV2Response, error)
	// Starts an index
	StartIndex(context.Context, *StartIndexRequest) (*StartIndexResponse, error)
	// Starts an index based on configuration in IndexStartConfig
	StartIndexV2(context.Context, *StartIndexV2Request) (*StartIndexResponse, error)
	// Stops an index
	StopIndex(context.Context, *StopIndexRequest) (*DummyResponse, error)
	// Reload state from the backend. When run on replicas, this processes state changes made by the primary.
	// New indices are created/started, and existing indices state is updated as needed.
	ReloadState(context.Context, *ReloadStateRequest) (*ReloadStateResponse, error)
	// Adds a stream of Documents to an index. Changes are not durable until after the next successful @commit call.
	AddDocuments(LuceneServer_AddDocumentsServer) error
	// Refresh the latest searcher for an index
	Refresh(context.Context, *RefreshRequest) (*RefreshResponse, error)
	// Commits all pending index data changes to durable storage
	Commit(context.Context, *CommitRequest) (*CommitResponse, error)
	// Retrieve index statistics
	Stats(context.Context, *StatsRequest) (*StatsResponse, error)
	// Execute a search query against an index
	Search(context.Context, *SearchRequest) (*SearchResponse, error)
	// Execute a search query against an index. Return response as an Any gRPC message. Useful if the client does
	// not need to process the response and wants to avoid some deserialization work.
	SearchV2(context.Context, *SearchRequest) (*anypb.Any, error)
	// Delete documents from an index. Changes are not durable until after the next successful @commit call.
	Delete(context.Context, *AddDocumentRequest) (*AddDocumentResponse, error)
	// Delete documents matching a query from an index. Changes are not durable until after the next successful
	// @commit call.
	DeleteByQuery(context.Context, *DeleteByQueryRequest) (*AddDocumentResponse, error)
	// Delete all documents for index. Changes are not durable until after the next successful @commit call.
	DeleteAll(context.Context, *DeleteAllDocumentsRequest) (*DeleteAllDocumentsResponse, error)
	// Delete index and all of its local data
	DeleteIndex(context.Context, *DeleteIndexRequest) (*DeleteIndexResponse, error)
	// Creates a snapshot in the index, which is saved point-in-time view of the last commit
	// in the index such that no files referenced by that snapshot will be deleted by ongoing
	// indexing until the snapshot is released with @releaseSnapshot.  Note that this will
	// reference the last commit, so be sure to call commit first if you have pending changes
	// that you'd like to be included in the snapshot.
	// This can be used for backup purposes, i.e. after creating the snapshot you can copy
	// all referenced files to backup storage, and then release the snapshot once complete.
	// To restore the backup, just copy all the files back and restart the server.
	// It can also be used for transactional purposes, i.e. if you sometimes need to search a
	// specific snapshot instead of the current live index. Creating a snapshot is very fast
	// (does not require any file copying), but over time it will consume extra disk space as
	// old segments are merged in the index.  Be sure to release the snapshot once you're done.
	// Snapshots survive shutdown and restart of the server.  Returns all protected filenames
	// referenced by this snapshot: these files will not change and will not be deleted until
	// the snapshot is released. This returns the directories and files referenced by the snapshot.
	CreateSnapshot(context.Context, *CreateSnapshotRequest) (*CreateSnapshotResponse, error)
	// Releases a snapshot previously created with @createSnapshot.
	ReleaseSnapshot(context.Context, *ReleaseSnapshotRequest) (*ReleaseSnapshotResponse, error)
	// Gets all unreleased index gens of snapshots previously created with @createSnapshot
	GetAllSnapshotIndexGen(context.Context, *GetAllSnapshotGenRequest) (*GetAllSnapshotGenResponse, error)
	// Backup warming queries for an index to S3
	BackupWarmingQueries(context.Context, *BackupWarmingQueriesRequest) (*BackupWarmingQueriesResponse, error)
	// Get information about this node
	NodeInfo(context.Context, *NodeInfoRequest) (*NodeInfoResponse, error)
	// Get the global state of the cluster
	GlobalState(context.Context, *GlobalStateRequest) (*GlobalStateResponse, error)
	// Gets the state of an index, includes settings, live_settings, search schema
	State(context.Context, *StateRequest) (*StateResponse, error)
	// Gets the state information for an index, includes settings, live_settings, search schema
	IndexState(context.Context, *IndexStateRequest) (*IndexStateResponse, error)
	// Basic healthcheck, successful if the server is running
	Status(context.Context, *HealthCheckRequest) (*HealthCheckResponse, error)
	// Checks if a node is ready to receive traffic by checking if all the indices configured to be started
	// are started. Can specify comma-separated list of index names to only check specific indices if needed.
	Ready(context.Context, *ReadyCheckRequest) (*HealthCheckResponse, error)
	// Get prometheus metrics
	Metrics(context.Context, *emptypb.Empty) (*httpbody.HttpBody, error)
	// Get information for all created indices
	Indices(context.Context, *IndicesRequest) (*IndicesResponse, error)
	// Forces merge policy to merge segments until there are <= maxNumSegments. The actual
	// merges to be executed are determined by the MergePolicy. This call will merge those
	// segments present in the index when the call started. If other threads are still
	// adding documents and flushing segments, those newly created segments will not be
	// merged unless you call forceMerge again.
	ForceMerge(context.Context, *ForceMergeRequest) (*ForceMergeResponse, error)
	// Forces merging of all segments that have deleted documents. The actual merges to be
	// executed are determined by the MergePolicy. For example, the default TieredMergePolicy
	// will only pick a segment if the percentage of deleted docs is over 10%.
	// This method first flushes a new segment (if there are indexed documents), and applies
	// all buffered deletes.
	ForceMergeDeletes(context.Context, *ForceMergeDeletesRequest) (*ForceMergeDeletesResponse, error)
	// Process request in a plugin which implements CustomRequestPlugin interface.
	Custom(context.Context, *CustomRequest) (*CustomResponse, error)
}

LuceneServerServer is the server API for LuceneServer service.

type LuceneServer_AddDocumentsClient 

type LuceneServer_AddDocumentsClient interface {
	Send(*AddDocumentRequest) error
	CloseAndRecv() (*AddDocumentResponse, error)
	grpc.ClientStream
}

type LuceneServer_AddDocumentsServer 

type LuceneServer_AddDocumentsServer interface {
	SendAndClose(*AddDocumentResponse) error
	Recv() (*AddDocumentRequest, error)
	grpc.ServerStream
}

type MatchAllQuery 

type MatchAllQuery struct {
	// contains filtered or unexported fields
}

A query that matches all documents.

func (*MatchAllQuery) Descriptor deprecated 

func (*MatchAllQuery) Descriptor() ([]byte, []int)

Deprecated: Use MatchAllQuery.ProtoReflect.Descriptor instead.

func (*MatchAllQuery) ProtoMessage 

func (*MatchAllQuery) ProtoMessage()

func (*MatchAllQuery) ProtoReflect 

func (x *MatchAllQuery) ProtoReflect() protoreflect.Message

func (*MatchAllQuery) Reset 

func (x *MatchAllQuery) Reset()

func (*MatchAllQuery) String 

func (x *MatchAllQuery) String() string

type MatchOperator 

type MatchOperator int32

Type of match operator used in MatchQuery 

const (
	// Or operation
	MatchOperator_SHOULD MatchOperator = 0
	// And operation
	MatchOperator_MUST MatchOperator = 1
)

func (MatchOperator) Descriptor 

func (MatchOperator) Descriptor() protoreflect.EnumDescriptor

func (MatchOperator) Enum 

func (x MatchOperator) Enum() *MatchOperator

func (MatchOperator) EnumDescriptor deprecated 

func (MatchOperator) EnumDescriptor() ([]byte, []int)

Deprecated: Use MatchOperator.Descriptor instead.

func (MatchOperator) Number 

func (x MatchOperator) Number() protoreflect.EnumNumber

func (MatchOperator) String 

func (x MatchOperator) String() string

func (MatchOperator) Type 

func (MatchOperator) Type() protoreflect.EnumType

type MatchPhrasePrefixQuery added in v0.18.0 

type MatchPhrasePrefixQuery struct {

	// Field in the document to query
	Field string `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
	// The text to query with
	Query string `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
	// Edit distance between respective positions of tokens generated by analyzing this query and the positions
	// of terms in a document
	Slop int32 `protobuf:"varint,3,opt,name=slop,proto3" json:"slop,omitempty"`
	// Analyzer used to analyze the query. If not provided, the default search analyzer for the field would
	// be used instead.
	Analyzer *Analyzer `protobuf:"bytes,4,opt,name=analyzer,proto3" json:"analyzer,omitempty"`
	// Maximum number of terms to which the last provided term of the query value will expand. Defaults to 50.
	MaxExpansions int32 `protobuf:"varint,5,opt,name=max_expansions,json=maxExpansions,proto3" json:"max_expansions,omitempty"`
	// contains filtered or unexported fields
}

A query that matches documents containing terms in the same order as those in the analyzed query string. The final analyzed token is treated as a prefix

func (*MatchPhrasePrefixQuery) Descriptor deprecated added in v0.18.0 

func (*MatchPhrasePrefixQuery) Descriptor() ([]byte, []int)

Deprecated: Use MatchPhrasePrefixQuery.ProtoReflect.Descriptor instead.

func (*MatchPhrasePrefixQuery) GetAnalyzer added in v0.18.0 

func (x *MatchPhrasePrefixQuery) GetAnalyzer() *Analyzer

func (*MatchPhrasePrefixQuery) GetField added in v0.18.0 

func (x *MatchPhrasePrefixQuery) GetField() string

func (*MatchPhrasePrefixQuery) GetMaxExpansions added in v0.18.0 

func (x *MatchPhrasePrefixQuery) GetMaxExpansions() int32

func (*MatchPhrasePrefixQuery) GetQuery added in v0.18.0 

func (x *MatchPhrasePrefixQuery) GetQuery() string

func (*MatchPhrasePrefixQuery) GetSlop added in v0.18.0 

func (x *MatchPhrasePrefixQuery) GetSlop() int32

func (*MatchPhrasePrefixQuery) ProtoMessage added in v0.18.0 

func (*MatchPhrasePrefixQuery) ProtoMessage()

func (*MatchPhrasePrefixQuery) ProtoReflect added in v0.18.0 

func (x *MatchPhrasePrefixQuery) ProtoReflect() protoreflect.Message

func (*MatchPhrasePrefixQuery) Reset added in v0.18.0 

func (x *MatchPhrasePrefixQuery) Reset()

func (*MatchPhrasePrefixQuery) String added in v0.18.0 

func (x *MatchPhrasePrefixQuery) String() string

type MatchPhraseQuery 

type MatchPhraseQuery struct {

	// Field in the document to query
	Field string `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
	// The text to query with
	Query string `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
	// Edit distance between respective positions of tokens generated by analyzing this query and the positions of
	// terms in a document
	Slop int32 `protobuf:"varint,3,opt,name=slop,proto3" json:"slop,omitempty"`
	// Analyzer used to analyze the query. If not provided, the default search analyzer for the field would be
	// used instead.
	Analyzer *Analyzer `protobuf:"bytes,4,opt,name=analyzer,proto3" json:"analyzer,omitempty"`
	// Indicates whether none or all documents are returned if the analyzer removes all tokens. Valid values
	// are NONE_ZERO_TERMS and ALL_ZERO_TERMS.
	ZeroTermsQuery MatchPhraseQuery_ZeroTerms `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

A query that analyzes the text before finding matching documents. The tokens resulting from the analysis are combined into a PhraseQuery.

func (*MatchPhraseQuery) Descriptor deprecated 

func (*MatchPhraseQuery) Descriptor() ([]byte, []int)

Deprecated: Use MatchPhraseQuery.ProtoReflect.Descriptor instead.

func (*MatchPhraseQuery) GetAnalyzer 

func (x *MatchPhraseQuery) GetAnalyzer() *Analyzer

func (*MatchPhraseQuery) GetField 

func (x *MatchPhraseQuery) GetField() string

func (*MatchPhraseQuery) GetQuery 

func (x *MatchPhraseQuery) GetQuery() string

func (*MatchPhraseQuery) GetSlop 

func (x *MatchPhraseQuery) GetSlop() int32

func (*MatchPhraseQuery) GetZeroTermsQuery added in v0.37.0 

func (x *MatchPhraseQuery) GetZeroTermsQuery() MatchPhraseQuery_ZeroTerms

func (*MatchPhraseQuery) ProtoMessage 

func (*MatchPhraseQuery) ProtoMessage()

func (*MatchPhraseQuery) ProtoReflect 

func (x *MatchPhraseQuery) ProtoReflect() protoreflect.Message

func (*MatchPhraseQuery) Reset 

func (x *MatchPhraseQuery) Reset()

func (*MatchPhraseQuery) String 

func (x *MatchPhraseQuery) String() string

type MatchPhraseQuery_ZeroTerms added in v0.37.0 

type MatchPhraseQuery_ZeroTerms int32

Zero Terms options when analyzer removes all tokens. 

const (
	// No documents are returned if the analyzer removes all tokens.
	MatchPhraseQuery_NONE_ZERO_TERMS MatchPhraseQuery_ZeroTerms = 0
	// All documents are returned if the analyzer removes all tokens.
	MatchPhraseQuery_ALL_ZERO_TERMS MatchPhraseQuery_ZeroTerms = 1
)

func (MatchPhraseQuery_ZeroTerms) Descriptor added in v0.37.0 

func (MatchPhraseQuery_ZeroTerms) Descriptor() protoreflect.EnumDescriptor

func (MatchPhraseQuery_ZeroTerms) Enum added in v0.37.0 

func (x MatchPhraseQuery_ZeroTerms) Enum() *MatchPhraseQuery_ZeroTerms

func (MatchPhraseQuery_ZeroTerms) EnumDescriptor deprecated added in v0.37.0 

func (MatchPhraseQuery_ZeroTerms) EnumDescriptor() ([]byte, []int)

Deprecated: Use MatchPhraseQuery_ZeroTerms.Descriptor instead.

func (MatchPhraseQuery_ZeroTerms) Number added in v0.37.0 

func (x MatchPhraseQuery_ZeroTerms) Number() protoreflect.EnumNumber

func (MatchPhraseQuery_ZeroTerms) String added in v0.37.0 

func (x MatchPhraseQuery_ZeroTerms) String() string

func (MatchPhraseQuery_ZeroTerms) Type added in v0.37.0 

func (MatchPhraseQuery_ZeroTerms) Type() protoreflect.EnumType

type MatchQuery 

type MatchQuery struct {

	// Field in the document to query
	Field string `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
	// The text to query with
	Query string `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
	// Boolean logic used to interpret text in the query. The possible values are SHOULD (default) and MUST.
	Operator MatchOperator `protobuf:"varint,3,opt,name=operator,proto3,enum=luceneserver.MatchOperator" json:"operator,omitempty"`
	// Minimum number of optional clauses that must match
	MinimumNumberShouldMatch int32 `protobuf:"varint,4,opt,name=minimumNumberShouldMatch,proto3" json:"minimumNumberShouldMatch,omitempty"`
	// Analyzer used to analyze the query. If not provided, the default search analyzer for the field would be
	// used instead.
	Analyzer *Analyzer `protobuf:"bytes,5,opt,name=analyzer,proto3" json:"analyzer,omitempty"`
	// Parameters to set the fuzziness of the query
	FuzzyParams *FuzzyParams `protobuf:"bytes,6,opt,name=fuzzyParams,proto3" json:"fuzzyParams,omitempty"`
	// contains filtered or unexported fields
}

A query that analyzes the text before finding matching documents. The tokens resulting from the analysis are combined using term queries in boolean clauses.

func (*MatchQuery) Descriptor deprecated 

func (*MatchQuery) Descriptor() ([]byte, []int)

Deprecated: Use MatchQuery.ProtoReflect.Descriptor instead.

func (*MatchQuery) GetAnalyzer 

func (x *MatchQuery) GetAnalyzer() *Analyzer

func (*MatchQuery) GetField 

func (x *MatchQuery) GetField() string

func (*MatchQuery) GetFuzzyParams 

func (x *MatchQuery) GetFuzzyParams() *FuzzyParams

func (*MatchQuery) GetMinimumNumberShouldMatch 

func (x *MatchQuery) GetMinimumNumberShouldMatch() int32

func (*MatchQuery) GetOperator 

func (x *MatchQuery) GetOperator() MatchOperator

func (*MatchQuery) GetQuery 

func (x *MatchQuery) GetQuery() string

func (*MatchQuery) ProtoMessage 

func (*MatchQuery) ProtoMessage()

func (*MatchQuery) ProtoReflect 

func (x *MatchQuery) ProtoReflect() protoreflect.Message

func (*MatchQuery) Reset 

func (x *MatchQuery) Reset()

func (*MatchQuery) String 

func (x *MatchQuery) String() string

type MaxCollector added in v0.23.0 

type MaxCollector struct {

	// Types that are assignable to ValueSource:
	//
	//	*MaxCollector_Script
	ValueSource isMaxCollector_ValueSource `protobuf_oneof:"ValueSource"`
	// contains filtered or unexported fields
}

Definition of collector to find a max double value over documents. Currently only allows for script based value production.

func (*MaxCollector) Descriptor deprecated added in v0.23.0 

func (*MaxCollector) Descriptor() ([]byte, []int)

Deprecated: Use MaxCollector.ProtoReflect.Descriptor instead.

func (*MaxCollector) GetScript added in v0.23.0 

func (x *MaxCollector) GetScript() *Script

func (*MaxCollector) GetValueSource added in v0.23.0 

func (m *MaxCollector) GetValueSource() isMaxCollector_ValueSource

func (*MaxCollector) ProtoMessage added in v0.23.0 

func (*MaxCollector) ProtoMessage()

func (*MaxCollector) ProtoReflect added in v0.23.0 

func (x *MaxCollector) ProtoReflect() protoreflect.Message

func (*MaxCollector) Reset added in v0.23.0 

func (x *MaxCollector) Reset()

func (*MaxCollector) String added in v0.23.0 

func (x *MaxCollector) String() string

type MaxCollector_Script added in v0.23.0 

type MaxCollector_Script struct {
	// Script to produce a double value
	Script *Script `protobuf:"bytes,1,opt,name=script,proto3,oneof"`
}

type MinCollector added in v0.37.0 

type MinCollector struct {

	// Types that are assignable to ValueSource:
	//
	//	*MinCollector_Script
	ValueSource isMinCollector_ValueSource `protobuf_oneof:"ValueSource"`
	// contains filtered or unexported fields
}

Definition of collector to find a min double value over documents. Currently only allows for script based value production.

func (*MinCollector) Descriptor deprecated added in v0.37.0 

func (*MinCollector) Descriptor() ([]byte, []int)

Deprecated: Use MinCollector.ProtoReflect.Descriptor instead.

func (*MinCollector) GetScript added in v0.37.0 

func (x *MinCollector) GetScript() *Script

func (*MinCollector) GetValueSource added in v0.37.0 

func (m *MinCollector) GetValueSource() isMinCollector_ValueSource

func (*MinCollector) ProtoMessage added in v0.37.0 

func (*MinCollector) ProtoMessage()

func (*MinCollector) ProtoReflect added in v0.37.0 

func (x *MinCollector) ProtoReflect() protoreflect.Message

func (*MinCollector) Reset added in v0.37.0 

func (x *MinCollector) Reset()

func (*MinCollector) String added in v0.37.0 

func (x *MinCollector) String() string

type MinCollector_Script added in v0.37.0 

type MinCollector_Script struct {
	// Script to produce a double value
	Script *Script `protobuf:"bytes,1,opt,name=script,proto3,oneof"`
}

type Mode 

type Mode int32

Index start mode 

const (
	// Standalone index with no replication
	Mode_STANDALONE Mode = 0
	// Primary index in an nrt cluster setup
	Mode_PRIMARY Mode = 1
	// Replica index in an nrt cluster setup
	Mode_REPLICA Mode = 2
)

func (Mode) Descriptor 

func (Mode) Descriptor() protoreflect.EnumDescriptor

func (Mode) Enum 

func (x Mode) Enum() *Mode

func (Mode) EnumDescriptor deprecated 

func (Mode) EnumDescriptor() ([]byte, []int)

Deprecated: Use Mode.Descriptor instead.

func (Mode) Number 

func (x Mode) Number() protoreflect.EnumNumber

func (Mode) String 

func (x Mode) String() string

func (Mode) Type 

func (Mode) Type() protoreflect.EnumType

type MultiFunctionScoreQuery added in v0.18.0 

type MultiFunctionScoreQuery struct {

	// Main query to produce recalled docs and scores, which will be modified by the final function score
	Query *Query `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
	// Functions to produce final function score
	Functions []*MultiFunctionScoreQuery_FilterFunction `protobuf:"bytes,2,rep,name=functions,proto3" json:"functions,omitempty"`
	// Method to combine functions scores
	ScoreMode MultiFunctionScoreQuery_FunctionScoreMode `` /* 149-byte string literal not displayed */
	// Method to modify query document scores with final function score
	BoostMode MultiFunctionScoreQuery_BoostMode `` /* 141-byte string literal not displayed */
	// Optional minimal score to match a document. By default, it's 0.
	MinScore float32 `protobuf:"fixed32,5,opt,name=min_score,json=minScore,proto3" json:"min_score,omitempty"`
	// Determine minimal score is excluded or not. By default, it's false.
	MinExcluded bool `protobuf:"varint,6,opt,name=min_excluded,json=minExcluded,proto3" json:"min_excluded,omitempty"`
	// contains filtered or unexported fields
}

A query to modify the score of documents with a given set of functions

func (*MultiFunctionScoreQuery) Descriptor deprecated added in v0.18.0 

func (*MultiFunctionScoreQuery) Descriptor() ([]byte, []int)

Deprecated: Use MultiFunctionScoreQuery.ProtoReflect.Descriptor instead.

func (*MultiFunctionScoreQuery) GetBoostMode added in v0.18.0 

func (x *MultiFunctionScoreQuery) GetBoostMode() MultiFunctionScoreQuery_BoostMode

func (*MultiFunctionScoreQuery) GetFunctions added in v0.18.0 

func (x *MultiFunctionScoreQuery) GetFunctions() []*MultiFunctionScoreQuery_FilterFunction

func (*MultiFunctionScoreQuery) GetMinExcluded added in v0.24.0 

func (x *MultiFunctionScoreQuery) GetMinExcluded() bool

func (*MultiFunctionScoreQuery) GetMinScore added in v0.24.0 

func (x *MultiFunctionScoreQuery) GetMinScore() float32

func (*MultiFunctionScoreQuery) GetQuery added in v0.18.0 

func (x *MultiFunctionScoreQuery) GetQuery() *Query

func (*MultiFunctionScoreQuery) GetScoreMode added in v0.18.0 

func (x *MultiFunctionScoreQuery) GetScoreMode() MultiFunctionScoreQuery_FunctionScoreMode

func (*MultiFunctionScoreQuery) ProtoMessage added in v0.18.0 

func (*MultiFunctionScoreQuery) ProtoMessage()

func (*MultiFunctionScoreQuery) ProtoReflect added in v0.18.0 

func (x *MultiFunctionScoreQuery) ProtoReflect() protoreflect.Message

func (*MultiFunctionScoreQuery) Reset added in v0.18.0 

func (x *MultiFunctionScoreQuery) Reset()

func (*MultiFunctionScoreQuery) String added in v0.18.0 

func (x *MultiFunctionScoreQuery) String() string

type MultiFunctionScoreQuery_BoostMode added in v0.18.0 

type MultiFunctionScoreQuery_BoostMode int32

How to combine final function score with query score 

const (
	// Multiply scores together
	MultiFunctionScoreQuery_BOOST_MODE_MULTIPLY MultiFunctionScoreQuery_BoostMode = 0
	// Add scores together
	MultiFunctionScoreQuery_BOOST_MODE_SUM MultiFunctionScoreQuery_BoostMode = 1
	// Ignore the query score, and use the function score only
	MultiFunctionScoreQuery_BOOST_MODE_REPLACE MultiFunctionScoreQuery_BoostMode = 2
)

func (MultiFunctionScoreQuery_BoostMode) Descriptor added in v0.18.0 

func (MultiFunctionScoreQuery_BoostMode) Descriptor() protoreflect.EnumDescriptor

func (MultiFunctionScoreQuery_BoostMode) Enum added in v0.18.0 

func (x MultiFunctionScoreQuery_BoostMode) Enum() *MultiFunctionScoreQuery_BoostMode

func (MultiFunctionScoreQuery_BoostMode) EnumDescriptor deprecated added in v0.18.0 

func (MultiFunctionScoreQuery_BoostMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use MultiFunctionScoreQuery_BoostMode.Descriptor instead.

func (MultiFunctionScoreQuery_BoostMode) Number added in v0.18.0 

func (x MultiFunctionScoreQuery_BoostMode) Number() protoreflect.EnumNumber

func (MultiFunctionScoreQuery_BoostMode) String added in v0.18.0 

func (x MultiFunctionScoreQuery_BoostMode) String() string

func (MultiFunctionScoreQuery_BoostMode) Type added in v0.18.0 

func (MultiFunctionScoreQuery_BoostMode) Type() protoreflect.EnumType

type MultiFunctionScoreQuery_DecayFunction added in v0.37.0 

type MultiFunctionScoreQuery_DecayFunction struct {

	// Document field name to use
	FieldName string `protobuf:"bytes,1,opt,name=fieldName,proto3" json:"fieldName,omitempty"`
	// Type of decay function to apply
	DecayType MultiFunctionScoreQuery_DecayType `protobuf:"varint,2,opt,name=decayType,proto3,enum=luceneserver.MultiFunctionScoreQuery_DecayType" json:"decayType,omitempty"`
	// Origin point to calculate the distance
	//
	// Types that are assignable to Origin:
	//
	//	*MultiFunctionScoreQuery_DecayFunction_GeoPoint
	Origin isMultiFunctionScoreQuery_DecayFunction_Origin `protobuf_oneof:"Origin"`
	// Currently only distance based scale and offset units are supported
	// Distance from origin + offset at which computed score will be equal to decay. Scale should be distance,
	// unit (m, km, mi) with space is optional. Default unit will be meters. Ex: "10", "15 km", "5 m", "7 mi"
	Scale string `protobuf:"bytes,4,opt,name=scale,proto3" json:"scale,omitempty"`
	// Compute decay function for docs with a distance greater than offset, will be 0.0 if none is set. Offset
	// should be distance, unit (m, km, mi) with space is optional. Default unit will be meters.
	// Ex: "10", "15 km", "5 m", "7 mi"
	Offset string `protobuf:"bytes,5,opt,name=offset,proto3" json:"offset,omitempty"`
	// Defines decay rate for scoring. Should be between (0, 1)
	Decay float32 `protobuf:"fixed32,6,opt,name=decay,proto3" json:"decay,omitempty"`
	// contains filtered or unexported fields
}

Apply decay function to docs

func (*MultiFunctionScoreQuery_DecayFunction) Descriptor deprecated added in v0.37.0 

func (*MultiFunctionScoreQuery_DecayFunction) Descriptor() ([]byte, []int)

Deprecated: Use MultiFunctionScoreQuery_DecayFunction.ProtoReflect.Descriptor instead.

func (*MultiFunctionScoreQuery_DecayFunction) GetDecay added in v0.37.0 

func (x *MultiFunctionScoreQuery_DecayFunction) GetDecay() float32

func (*MultiFunctionScoreQuery_DecayFunction) GetDecayType added in v0.37.0 

func (x *MultiFunctionScoreQuery_DecayFunction) GetDecayType() MultiFunctionScoreQuery_DecayType

func (*MultiFunctionScoreQuery_DecayFunction) GetFieldName added in v0.37.0 

func (x *MultiFunctionScoreQuery_DecayFunction) GetFieldName() string

func (*MultiFunctionScoreQuery_DecayFunction) GetGeoPoint added in v0.37.0 

func (x *MultiFunctionScoreQuery_DecayFunction) GetGeoPoint() *latlng.LatLng

func (*MultiFunctionScoreQuery_DecayFunction) GetOffset added in v0.37.0 

func (x *MultiFunctionScoreQuery_DecayFunction) GetOffset() string

func (*MultiFunctionScoreQuery_DecayFunction) GetOrigin added in v0.37.0 

func (m *MultiFunctionScoreQuery_DecayFunction) GetOrigin() isMultiFunctionScoreQuery_DecayFunction_Origin

func (*MultiFunctionScoreQuery_DecayFunction) GetScale added in v0.37.0 

func (x *MultiFunctionScoreQuery_DecayFunction) GetScale() string

func (*MultiFunctionScoreQuery_DecayFunction) ProtoMessage added in v0.37.0 

func (*MultiFunctionScoreQuery_DecayFunction) ProtoMessage()

func (*MultiFunctionScoreQuery_DecayFunction) ProtoReflect added in v0.37.0 

func (x *MultiFunctionScoreQuery_DecayFunction) ProtoReflect() protoreflect.Message

func (*MultiFunctionScoreQuery_DecayFunction) Reset added in v0.37.0 

func (x *MultiFunctionScoreQuery_DecayFunction) Reset()

func (*MultiFunctionScoreQuery_DecayFunction) String added in v0.37.0 

func (x *MultiFunctionScoreQuery_DecayFunction) String() string

type MultiFunctionScoreQuery_DecayFunction_GeoPoint added in v0.37.0 

type MultiFunctionScoreQuery_DecayFunction_GeoPoint struct {
	GeoPoint *latlng.LatLng `protobuf:"bytes,3,opt,name=geoPoint,proto3,oneof"`
}

type MultiFunctionScoreQuery_DecayType added in v0.37.0 

type MultiFunctionScoreQuery_DecayType int32

Decay function types 

const (
	// Exponential decay function
	MultiFunctionScoreQuery_DECAY_TYPE_EXPONENTIAL MultiFunctionScoreQuery_DecayType = 0
	// Linear decay function
	MultiFunctionScoreQuery_DECAY_TYPE_LINEAR MultiFunctionScoreQuery_DecayType = 1
	// Gaussian decay function
	MultiFunctionScoreQuery_DECAY_TYPE_GUASSIAN MultiFunctionScoreQuery_DecayType = 2
)

func (MultiFunctionScoreQuery_DecayType) Descriptor added in v0.37.0 

func (MultiFunctionScoreQuery_DecayType) Descriptor() protoreflect.EnumDescriptor

func (MultiFunctionScoreQuery_DecayType) Enum added in v0.37.0 

func (x MultiFunctionScoreQuery_DecayType) Enum() *MultiFunctionScoreQuery_DecayType

func (MultiFunctionScoreQuery_DecayType) EnumDescriptor deprecated added in v0.37.0 

func (MultiFunctionScoreQuery_DecayType) EnumDescriptor() ([]byte, []int)

Deprecated: Use MultiFunctionScoreQuery_DecayType.Descriptor instead.

func (MultiFunctionScoreQuery_DecayType) Number added in v0.37.0 

func (x MultiFunctionScoreQuery_DecayType) Number() protoreflect.EnumNumber

func (MultiFunctionScoreQuery_DecayType) String added in v0.37.0 

func (x MultiFunctionScoreQuery_DecayType) String() string

func (MultiFunctionScoreQuery_DecayType) Type added in v0.37.0 

func (MultiFunctionScoreQuery_DecayType) Type() protoreflect.EnumType

type MultiFunctionScoreQuery_FilterFunction added in v0.18.0 

type MultiFunctionScoreQuery_FilterFunction struct {

	// Apply function only to docs that pass this filter, match all if not specified
	Filter *Query `protobuf:"bytes,1,opt,name=filter,proto3" json:"filter,omitempty"`
	// Weight to multiply with function score, 1.0 if not specified
	Weight float32 `protobuf:"fixed32,2,opt,name=weight,proto3" json:"weight,omitempty"`
	// Function to produce score, will be 1.0 if none are set
	//
	// Types that are assignable to Function:
	//
	//	*MultiFunctionScoreQuery_FilterFunction_Script
	//	*MultiFunctionScoreQuery_FilterFunction_DecayFunction
	Function isMultiFunctionScoreQuery_FilterFunction_Function `protobuf_oneof:"Function"`
	// contains filtered or unexported fields
}

Function to produce a weighted value

func (*MultiFunctionScoreQuery_FilterFunction) Descriptor deprecated added in v0.18.0 

func (*MultiFunctionScoreQuery_FilterFunction) Descriptor() ([]byte, []int)

Deprecated: Use MultiFunctionScoreQuery_FilterFunction.ProtoReflect.Descriptor instead.

func (*MultiFunctionScoreQuery_FilterFunction) GetDecayFunction added in v0.37.0 

func (x *MultiFunctionScoreQuery_FilterFunction) GetDecayFunction() *MultiFunctionScoreQuery_DecayFunction

func (*MultiFunctionScoreQuery_FilterFunction) GetFilter added in v0.18.0 

func (x *MultiFunctionScoreQuery_FilterFunction) GetFilter() *Query

func (*MultiFunctionScoreQuery_FilterFunction) GetFunction added in v0.18.0 

func (m *MultiFunctionScoreQuery_FilterFunction) GetFunction() isMultiFunctionScoreQuery_FilterFunction_Function

func (*MultiFunctionScoreQuery_FilterFunction) GetScript added in v0.18.0 

func (x *MultiFunctionScoreQuery_FilterFunction) GetScript() *Script

func (*MultiFunctionScoreQuery_FilterFunction) GetWeight added in v0.18.0 

func (x *MultiFunctionScoreQuery_FilterFunction) GetWeight() float32

func (*MultiFunctionScoreQuery_FilterFunction) ProtoMessage added in v0.18.0 

func (*MultiFunctionScoreQuery_FilterFunction) ProtoMessage()

func (*MultiFunctionScoreQuery_FilterFunction) ProtoReflect added in v0.18.0 

func (x *MultiFunctionScoreQuery_FilterFunction) ProtoReflect() protoreflect.Message

func (*MultiFunctionScoreQuery_FilterFunction) Reset added in v0.18.0 

func (x *MultiFunctionScoreQuery_FilterFunction) Reset()

func (*MultiFunctionScoreQuery_FilterFunction) String added in v0.18.0 

func (x *MultiFunctionScoreQuery_FilterFunction) String() string

type MultiFunctionScoreQuery_FilterFunction_DecayFunction added in v0.37.0 

type MultiFunctionScoreQuery_FilterFunction_DecayFunction struct {
	// Produce score with a decay function
	DecayFunction *MultiFunctionScoreQuery_DecayFunction `protobuf:"bytes,4,opt,name=decayFunction,proto3,oneof"`
}

type MultiFunctionScoreQuery_FilterFunction_Script added in v0.18.0 

type MultiFunctionScoreQuery_FilterFunction_Script struct {
	// Produce score with score script definition
	Script *Script `protobuf:"bytes,3,opt,name=script,proto3,oneof"`
}

type MultiFunctionScoreQuery_FunctionScoreMode added in v0.18.0 

type MultiFunctionScoreQuery_FunctionScoreMode int32

How to combine multiple function scores to produce a final function score 

const (
	// Multiply weighted function scores together
	MultiFunctionScoreQuery_SCORE_MODE_MULTIPLY MultiFunctionScoreQuery_FunctionScoreMode = 0
	// Add weighted function scores together
	MultiFunctionScoreQuery_SCORE_MODE_SUM MultiFunctionScoreQuery_FunctionScoreMode = 1
)

func (MultiFunctionScoreQuery_FunctionScoreMode) Descriptor added in v0.18.0 

func (MultiFunctionScoreQuery_FunctionScoreMode) Descriptor() protoreflect.EnumDescriptor

func (MultiFunctionScoreQuery_FunctionScoreMode) Enum added in v0.18.0 

func (x MultiFunctionScoreQuery_FunctionScoreMode) Enum() *MultiFunctionScoreQuery_FunctionScoreMode

func (MultiFunctionScoreQuery_FunctionScoreMode) EnumDescriptor deprecated added in v0.18.0 

func (MultiFunctionScoreQuery_FunctionScoreMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use MultiFunctionScoreQuery_FunctionScoreMode.Descriptor instead.

func (MultiFunctionScoreQuery_FunctionScoreMode) Number added in v0.18.0 

func (x MultiFunctionScoreQuery_FunctionScoreMode) Number() protoreflect.EnumNumber

func (MultiFunctionScoreQuery_FunctionScoreMode) String added in v0.18.0 

func (x MultiFunctionScoreQuery_FunctionScoreMode) String() string

func (MultiFunctionScoreQuery_FunctionScoreMode) Type added in v0.18.0 

func (MultiFunctionScoreQuery_FunctionScoreMode) Type() protoreflect.EnumType

type MultiMatchQuery 

type MultiMatchQuery struct {

	// Fields in the document to query
	Fields []string `protobuf:"bytes,1,rep,name=fields,proto3" json:"fields,omitempty"`
	// The text to query with
	Query string `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
	// Boosts for each field, if any
	FieldBoosts map[string]float32 `` /* 165-byte string literal not displayed */
	// Boolean logic used to interpret text in the query. The possible values are SHOULD (default) and MUST.
	Operator MatchOperator `protobuf:"varint,4,opt,name=operator,proto3,enum=luceneserver.MatchOperator" json:"operator,omitempty"`
	// Minimum number of optional clauses that must match
	MinimumNumberShouldMatch int32 `protobuf:"varint,5,opt,name=minimumNumberShouldMatch,proto3" json:"minimumNumberShouldMatch,omitempty"`
	// Analyzer used to analyze the query. If not provided, the default search analyzer for the field would
	// be used instead.
	Analyzer *Analyzer `protobuf:"bytes,6,opt,name=analyzer,proto3" json:"analyzer,omitempty"`
	// Parameters to set the fuzziness of the query
	FuzzyParams *FuzzyParams `protobuf:"bytes,7,opt,name=fuzzyParams,proto3" json:"fuzzyParams,omitempty"`
	// The score of each non-maximum match query disjunct for a document will be multiplied by this weight
	// and added into the final score
	TieBreakerMultiplier float32 `protobuf:"fixed32,8,opt,name=tieBreakerMultiplier,proto3" json:"tieBreakerMultiplier,omitempty"`
	// Type defining match behavior of query
	Type MultiMatchQuery_MatchType `protobuf:"varint,9,opt,name=type,proto3,enum=luceneserver.MultiMatchQuery_MatchType" json:"type,omitempty"`
	// Edit distance between respective positions of tokens generated by analyzing this query and the positions
	// of terms in a document, applies to PHRASE_PREFIX type matching
	Slop int32 `protobuf:"varint,10,opt,name=slop,proto3" json:"slop,omitempty"`
	// Maximum number of terms to which the prefix token will expand when using PHRASE_PREFIX matching. Defaults to 50.
	MaxExpansions int32 `protobuf:"varint,11,opt,name=maxExpansions,proto3" json:"maxExpansions,omitempty"`
	// contains filtered or unexported fields
}

A query that creates a match query for each field provided and wraps all the match queries in a disjunction max query.

func (*MultiMatchQuery) Descriptor deprecated 

func (*MultiMatchQuery) Descriptor() ([]byte, []int)

Deprecated: Use MultiMatchQuery.ProtoReflect.Descriptor instead.

func (*MultiMatchQuery) GetAnalyzer 

func (x *MultiMatchQuery) GetAnalyzer() *Analyzer

func (*MultiMatchQuery) GetFieldBoosts 

func (x *MultiMatchQuery) GetFieldBoosts() map[string]float32

func (*MultiMatchQuery) GetFields 

func (x *MultiMatchQuery) GetFields() []string

func (*MultiMatchQuery) GetFuzzyParams 

func (x *MultiMatchQuery) GetFuzzyParams() *FuzzyParams

func (*MultiMatchQuery) GetMaxExpansions added in v0.18.0 

func (x *MultiMatchQuery) GetMaxExpansions() int32

func (*MultiMatchQuery) GetMinimumNumberShouldMatch 

func (x *MultiMatchQuery) GetMinimumNumberShouldMatch() int32

func (*MultiMatchQuery) GetOperator 

func (x *MultiMatchQuery) GetOperator() MatchOperator

func (*MultiMatchQuery) GetQuery 

func (x *MultiMatchQuery) GetQuery() string

func (*MultiMatchQuery) GetSlop added in v0.18.0 

func (x *MultiMatchQuery) GetSlop() int32

func (*MultiMatchQuery) GetTieBreakerMultiplier 

func (x *MultiMatchQuery) GetTieBreakerMultiplier() float32

func (*MultiMatchQuery) GetType added in v0.18.0 

func (x *MultiMatchQuery) GetType() MultiMatchQuery_MatchType

func (*MultiMatchQuery) ProtoMessage 

func (*MultiMatchQuery) ProtoMessage()

func (*MultiMatchQuery) ProtoReflect 

func (x *MultiMatchQuery) ProtoReflect() protoreflect.Message

func (*MultiMatchQuery) Reset 

func (x *MultiMatchQuery) Reset()

func (*MultiMatchQuery) String 

func (x *MultiMatchQuery) String() string

type MultiMatchQuery_MatchType added in v0.18.0 

type MultiMatchQuery_MatchType int32

Type defining the execution behavior of the match 

const (
	// Finds documents which match any field, but uses the _score from the best field
	MultiMatchQuery_BEST_FIELDS MultiMatchQuery_MatchType = 0
	// Runs a MatchPhrasePrefixQuery query on each field and uses the _score from the best field
	MultiMatchQuery_PHRASE_PREFIX MultiMatchQuery_MatchType = 1
	// Finds documents that match across multiple fields, as if they were a single field
	MultiMatchQuery_CROSS_FIELDS MultiMatchQuery_MatchType = 2
)

func (MultiMatchQuery_MatchType) Descriptor added in v0.18.0 

func (MultiMatchQuery_MatchType) Descriptor() protoreflect.EnumDescriptor

func (MultiMatchQuery_MatchType) Enum added in v0.18.0 

func (x MultiMatchQuery_MatchType) Enum() *MultiMatchQuery_MatchType

func (MultiMatchQuery_MatchType) EnumDescriptor deprecated added in v0.18.0 

func (MultiMatchQuery_MatchType) EnumDescriptor() ([]byte, []int)

Deprecated: Use MultiMatchQuery_MatchType.Descriptor instead.

func (MultiMatchQuery_MatchType) Number added in v0.18.0 

func (x MultiMatchQuery_MatchType) Number() protoreflect.EnumNumber

func (MultiMatchQuery_MatchType) String added in v0.18.0 

func (x MultiMatchQuery_MatchType) String() string

func (MultiMatchQuery_MatchType) Type added in v0.18.0 

func (MultiMatchQuery_MatchType) Type() protoreflect.EnumType

type NameAndParams 

type NameAndParams struct {

	// Name of the analysis component
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Parameters for the analysis component
	Params map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

Name of analysis component and its parameters

func (*NameAndParams) Descriptor deprecated 

func (*NameAndParams) Descriptor() ([]byte, []int)

Deprecated: Use NameAndParams.ProtoReflect.Descriptor instead.

func (*NameAndParams) GetName 

func (x *NameAndParams) GetName() string

func (*NameAndParams) GetParams 

func (x *NameAndParams) GetParams() map[string]string

func (*NameAndParams) ProtoMessage 

func (*NameAndParams) ProtoMessage()

func (*NameAndParams) ProtoReflect 

func (x *NameAndParams) ProtoReflect() protoreflect.Message

func (*NameAndParams) Reset 

func (x *NameAndParams) Reset()

func (*NameAndParams) String 

func (x *NameAndParams) String() string

type NestedQuery 

type NestedQuery struct {

	// Query for the child documents
	Query *Query `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
	// Path to the child document
	Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	// How child documents score affects final score
	ScoreMode NestedQuery_ScoreMode `protobuf:"varint,3,opt,name=scoreMode,proto3,enum=luceneserver.NestedQuery_ScoreMode" json:"scoreMode,omitempty"`
	// contains filtered or unexported fields
}

Query that matches nested documents

func (*NestedQuery) Descriptor deprecated 

func (*NestedQuery) Descriptor() ([]byte, []int)

Deprecated: Use NestedQuery.ProtoReflect.Descriptor instead.

func (*NestedQuery) GetPath 

func (x *NestedQuery) GetPath() string

func (*NestedQuery) GetQuery 

func (x *NestedQuery) GetQuery() *Query

func (*NestedQuery) GetScoreMode 

func (x *NestedQuery) GetScoreMode() NestedQuery_ScoreMode

func (*NestedQuery) ProtoMessage 

func (*NestedQuery) ProtoMessage()

func (*NestedQuery) ProtoReflect 

func (x *NestedQuery) ProtoReflect() protoreflect.Message

func (*NestedQuery) Reset 

func (x *NestedQuery) Reset()

func (*NestedQuery) String 

func (x *NestedQuery) String() string

type NestedQuery_ScoreMode 

type NestedQuery_ScoreMode int32

How child documents score affects final score 

const (
	NestedQuery_NONE NestedQuery_ScoreMode = 0
	NestedQuery_AVG  NestedQuery_ScoreMode = 1
	NestedQuery_MAX  NestedQuery_ScoreMode = 2
	NestedQuery_MIN  NestedQuery_ScoreMode = 3
	NestedQuery_SUM  NestedQuery_ScoreMode = 4
)

func (NestedQuery_ScoreMode) Descriptor 

func (NestedQuery_ScoreMode) Descriptor() protoreflect.EnumDescriptor

func (NestedQuery_ScoreMode) Enum 

func (x NestedQuery_ScoreMode) Enum() *NestedQuery_ScoreMode

func (NestedQuery_ScoreMode) EnumDescriptor deprecated 

func (NestedQuery_ScoreMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use NestedQuery_ScoreMode.Descriptor instead.

func (NestedQuery_ScoreMode) Number 

func (x NestedQuery_ScoreMode) Number() protoreflect.EnumNumber

func (NestedQuery_ScoreMode) String 

func (x NestedQuery_ScoreMode) String() string

func (NestedQuery_ScoreMode) Type 

func (NestedQuery_ScoreMode) Type() protoreflect.EnumType

type NewNRTPoint 

type NewNRTPoint struct {

	// Magic number send on all requests since these are meant for internal communication only
	MagicNumber int32 `protobuf:"varint,1,opt,name=magicNumber,proto3" json:"magicNumber,omitempty"`
	// Index name
	IndexName string `protobuf:"bytes,2,opt,name=indexName,proto3" json:"indexName,omitempty"`
	// Primary generation
	PrimaryGen int64 `protobuf:"varint,3,opt,name=primaryGen,proto3" json:"primaryGen,omitempty"`
	// Version number when this SegmentInfos was generated
	Version int64 `protobuf:"varint,4,opt,name=version,proto3" json:"version,omitempty"`
	// Index id
	IndexId string `protobuf:"bytes,5,opt,name=indexId,proto3" json:"indexId,omitempty"`
	// contains filtered or unexported fields
}

Input to newNRTPoint

func (*NewNRTPoint) Descriptor deprecated 

func (*NewNRTPoint) Descriptor() ([]byte, []int)

Deprecated: Use NewNRTPoint.ProtoReflect.Descriptor instead.

func (*NewNRTPoint) GetIndexId added in v0.39.0 

func (x *NewNRTPoint) GetIndexId() string

func (*NewNRTPoint) GetIndexName 

func (x *NewNRTPoint) GetIndexName() string

func (*NewNRTPoint) GetMagicNumber 

func (x *NewNRTPoint) GetMagicNumber() int32

func (*NewNRTPoint) GetPrimaryGen 

func (x *NewNRTPoint) GetPrimaryGen() int64

func (*NewNRTPoint) GetVersion 

func (x *NewNRTPoint) GetVersion() int64

func (*NewNRTPoint) ProtoMessage 

func (*NewNRTPoint) ProtoMessage()

func (*NewNRTPoint) ProtoReflect 

func (x *NewNRTPoint) ProtoReflect() protoreflect.Message

func (*NewNRTPoint) Reset 

func (x *NewNRTPoint) Reset()

func (*NewNRTPoint) String 

func (x *NewNRTPoint) String() string

type NodeInfo 

type NodeInfo struct {

	// Name or ip address of the remote host that this node is connected to for binary replication
	Hostname string `protobuf:"bytes,1,opt,name=hostname,proto3" json:"hostname,omitempty"`
	// Port number of the remote host that this node is connected to for binary replication
	Port int32 `protobuf:"varint,2,opt,name=port,proto3" json:"port,omitempty"`
	// Name of the remote node
	NodeName string `protobuf:"bytes,3,opt,name=nodeName,proto3" json:"nodeName,omitempty"`
	// contains filtered or unexported fields
}

Node information

func (*NodeInfo) Descriptor deprecated 

func (*NodeInfo) Descriptor() ([]byte, []int)

Deprecated: Use NodeInfo.ProtoReflect.Descriptor instead.

func (*NodeInfo) GetHostname 

func (x *NodeInfo) GetHostname() string

func (*NodeInfo) GetNodeName 

func (x *NodeInfo) GetNodeName() string

func (*NodeInfo) GetPort 

func (x *NodeInfo) GetPort() int32

func (*NodeInfo) ProtoMessage 

func (*NodeInfo) ProtoMessage()

func (*NodeInfo) ProtoReflect 

func (x *NodeInfo) ProtoReflect() protoreflect.Message

func (*NodeInfo) Reset 

func (x *NodeInfo) Reset()

func (*NodeInfo) String 

func (x *NodeInfo) String() string

type NodeInfoRequest 

type NodeInfoRequest struct {
	// contains filtered or unexported fields
}

Input to nodeInfo

func (*NodeInfoRequest) Descriptor deprecated 

func (*NodeInfoRequest) Descriptor() ([]byte, []int)

Deprecated: Use NodeInfoRequest.ProtoReflect.Descriptor instead.

func (*NodeInfoRequest) ProtoMessage 

func (*NodeInfoRequest) ProtoMessage()

func (*NodeInfoRequest) ProtoReflect 

func (x *NodeInfoRequest) ProtoReflect() protoreflect.Message

func (*NodeInfoRequest) Reset 

func (x *NodeInfoRequest) Reset()

func (*NodeInfoRequest) String 

func (x *NodeInfoRequest) String() string

type NodeInfoResponse 

type NodeInfoResponse struct {

	// Node name
	NodeName string `protobuf:"bytes,1,opt,name=node_name,json=nodeName,proto3" json:"node_name,omitempty"`
	// Service name
	ServiceName string `protobuf:"bytes,2,opt,name=service_name,json=serviceName,proto3" json:"service_name,omitempty"`
	// Host name
	HostName string `protobuf:"bytes,3,opt,name=host_name,json=hostName,proto3" json:"host_name,omitempty"`
	// Nrtsearch version
	Version string `protobuf:"bytes,4,opt,name=version,proto3" json:"version,omitempty"`
	// Node ephemeral id
	EphemeralId string `protobuf:"bytes,5,opt,name=ephemeral_id,json=ephemeralId,proto3" json:"ephemeral_id,omitempty"`
	// contains filtered or unexported fields
}

Response from Server for nodeInfo

func (*NodeInfoResponse) Descriptor deprecated 

func (*NodeInfoResponse) Descriptor() ([]byte, []int)

Deprecated: Use NodeInfoResponse.ProtoReflect.Descriptor instead.

func (*NodeInfoResponse) GetEphemeralId 

func (x *NodeInfoResponse) GetEphemeralId() string

func (*NodeInfoResponse) GetHostName 

func (x *NodeInfoResponse) GetHostName() string

func (*NodeInfoResponse) GetNodeName 

func (x *NodeInfoResponse) GetNodeName() string

func (*NodeInfoResponse) GetServiceName 

func (x *NodeInfoResponse) GetServiceName() string

func (*NodeInfoResponse) GetVersion 

func (x *NodeInfoResponse) GetVersion() string

func (*NodeInfoResponse) ProtoMessage 

func (*NodeInfoResponse) ProtoMessage()

func (*NodeInfoResponse) ProtoReflect 

func (x *NodeInfoResponse) ProtoReflect() protoreflect.Message

func (*NodeInfoResponse) Reset 

func (x *NodeInfoResponse) Reset()

func (*NodeInfoResponse) String 

func (x *NodeInfoResponse) String() string

type NumericRangeType 

type NumericRangeType struct {

	// Label for this range
	Label string `protobuf:"bytes,1,opt,name=label,proto3" json:"label,omitempty"`
	// Min value for the range
	Min int64 `protobuf:"varint,2,opt,name=min,proto3" json:"min,omitempty"`
	// True if the min value is inclusive
	MinInclusive bool `protobuf:"varint,3,opt,name=minInclusive,proto3" json:"minInclusive,omitempty"`
	// Max value for the range
	Max int64 `protobuf:"varint,4,opt,name=max,proto3" json:"max,omitempty"`
	// True if the max value is inclusive
	MaxInclusive bool `protobuf:"varint,5,opt,name=maxInclusive,proto3" json:"maxInclusive,omitempty"`
	// contains filtered or unexported fields
}

Define numeric range for facet

func (*NumericRangeType) Descriptor deprecated 

func (*NumericRangeType) Descriptor() ([]byte, []int)

Deprecated: Use NumericRangeType.ProtoReflect.Descriptor instead.

func (*NumericRangeType) GetLabel 

func (x *NumericRangeType) GetLabel() string

func (*NumericRangeType) GetMax 

func (x *NumericRangeType) GetMax() int64

func (*NumericRangeType) GetMaxInclusive 

func (x *NumericRangeType) GetMaxInclusive() bool

func (*NumericRangeType) GetMin 

func (x *NumericRangeType) GetMin() int64

func (*NumericRangeType) GetMinInclusive 

func (x *NumericRangeType) GetMinInclusive() bool

func (*NumericRangeType) ProtoMessage 

func (*NumericRangeType) ProtoMessage()

func (*NumericRangeType) ProtoReflect 

func (x *NumericRangeType) ProtoReflect() protoreflect.Message

func (*NumericRangeType) Reset 

func (x *NumericRangeType) Reset()

func (*NumericRangeType) String 

func (x *NumericRangeType) String() string

type PhraseQuery 

type PhraseQuery struct {

	// Edit distance between respective positions of terms as defined in this PhraseQuery and the positions
	// of terms in a document
	Slop int32 `protobuf:"varint,1,opt,name=slop,proto3" json:"slop,omitempty"`
	// Field in the document to query
	Field string `protobuf:"bytes,2,opt,name=field,proto3" json:"field,omitempty"`
	// Terms to match
	Terms []string `protobuf:"bytes,3,rep,name=terms,proto3" json:"terms,omitempty"`
	// contains filtered or unexported fields
}

A Query that matches documents containing a particular sequence of terms

func (*PhraseQuery) Descriptor deprecated 

func (*PhraseQuery) Descriptor() ([]byte, []int)

Deprecated: Use PhraseQuery.ProtoReflect.Descriptor instead.

func (*PhraseQuery) GetField 

func (x *PhraseQuery) GetField() string

func (*PhraseQuery) GetSlop 

func (x *PhraseQuery) GetSlop() int32

func (*PhraseQuery) GetTerms 

func (x *PhraseQuery) GetTerms() []string

func (*PhraseQuery) ProtoMessage 

func (*PhraseQuery) ProtoMessage()

func (*PhraseQuery) ProtoReflect 

func (x *PhraseQuery) ProtoReflect() protoreflect.Message

func (*PhraseQuery) Reset 

func (x *PhraseQuery) Reset()

func (*PhraseQuery) String 

func (x *PhraseQuery) String() string

type PluginCollector added in v0.10.5 

type PluginCollector struct {

	// Name of plugin registered collector
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Arguments passed to the plugin collector
	Params *structpb.Struct `protobuf:"bytes,2,opt,name=params,proto3" json:"params,omitempty"`
	// contains filtered or unexported fields
}

Defines an entry point for using a collector from a plugin

func (*PluginCollector) Descriptor deprecated added in v0.10.5 

func (*PluginCollector) Descriptor() ([]byte, []int)

Deprecated: Use PluginCollector.ProtoReflect.Descriptor instead.

func (*PluginCollector) GetName added in v0.10.5 

func (x *PluginCollector) GetName() string

func (*PluginCollector) GetParams added in v0.10.5 

func (x *PluginCollector) GetParams() *structpb.Struct

func (*PluginCollector) ProtoMessage added in v0.10.5 

func (*PluginCollector) ProtoMessage()

func (*PluginCollector) ProtoReflect added in v0.10.5 

func (x *PluginCollector) ProtoReflect() protoreflect.Message

func (*PluginCollector) Reset added in v0.10.5 

func (x *PluginCollector) Reset()

func (*PluginCollector) String added in v0.10.5 

func (x *PluginCollector) String() string

type PluginRescorer 

type PluginRescorer struct {

	// Rescorer name registered by plugin
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Arguments passed to the plugin rescorer
	Params *structpb.Struct `protobuf:"bytes,2,opt,name=params,proto3" json:"params,omitempty"`
	// contains filtered or unexported fields
}

Defines an entry point for using a rescorer from plugin

func (*PluginRescorer) Descriptor deprecated 

func (*PluginRescorer) Descriptor() ([]byte, []int)

Deprecated: Use PluginRescorer.ProtoReflect.Descriptor instead.

func (*PluginRescorer) GetName 

func (x *PluginRescorer) GetName() string

func (*PluginRescorer) GetParams 

func (x *PluginRescorer) GetParams() *structpb.Struct

func (*PluginRescorer) ProtoMessage 

func (*PluginRescorer) ProtoMessage()

func (*PluginRescorer) ProtoReflect 

func (x *PluginRescorer) ProtoReflect() protoreflect.Message

func (*PluginRescorer) Reset 

func (x *PluginRescorer) Reset()

func (*PluginRescorer) String 

func (x *PluginRescorer) String() string

type Point 

type Point struct {

	// Latitude of the point
	Latitude float64 `protobuf:"fixed64,1,opt,name=latitude,proto3" json:"latitude,omitempty"`
	// Longitude of the point
	Longitude float64 `protobuf:"fixed64,2,opt,name=longitude,proto3" json:"longitude,omitempty"`
	// contains filtered or unexported fields
}

Point representation

func (*Point) Descriptor deprecated 

func (*Point) Descriptor() ([]byte, []int)

Deprecated: Use Point.ProtoReflect.Descriptor instead.

func (*Point) GetLatitude 

func (x *Point) GetLatitude() float64

func (*Point) GetLongitude 

func (x *Point) GetLongitude() float64

func (*Point) ProtoMessage 

func (*Point) ProtoMessage()

func (*Point) ProtoReflect 

func (x *Point) ProtoReflect() protoreflect.Message

func (*Point) Reset 

func (x *Point) Reset()

func (*Point) String 

func (x *Point) String() string

type Polygon added in v0.30.0 

type Polygon struct {

	// Points defining the polygon, conforming to the https://geojson.org/ standard. The polygon must not be
	// self-crossing, otherwise may result in unexpected behavior. Polygons cannot cross the 180th meridian.
	// Instead, use two polygons: one on each side.
	Points []*latlng.LatLng `protobuf:"bytes,1,rep,name=points,proto3" json:"points,omitempty"`
	// Specify holes in the polygon. Hole polygons cannot themselves contain holes.
	Holes []*Polygon `protobuf:"bytes,2,rep,name=holes,proto3" json:"holes,omitempty"`
	// contains filtered or unexported fields
}

Polygon defined by a list of geo points

func (*Polygon) Descriptor deprecated added in v0.30.0 

func (*Polygon) Descriptor() ([]byte, []int)

Deprecated: Use Polygon.ProtoReflect.Descriptor instead.

func (*Polygon) GetHoles added in v0.30.0 

func (x *Polygon) GetHoles() []*Polygon

func (*Polygon) GetPoints added in v0.30.0 

func (x *Polygon) GetPoints() []*latlng.LatLng

func (*Polygon) ProtoMessage added in v0.30.0 

func (*Polygon) ProtoMessage()

func (*Polygon) ProtoReflect added in v0.30.0 

func (x *Polygon) ProtoReflect() protoreflect.Message

func (*Polygon) Reset added in v0.30.0 

func (x *Polygon) Reset()

func (*Polygon) String added in v0.30.0 

func (x *Polygon) String() string

type PrefixQuery added in v0.18.0 

type PrefixQuery struct {

	// Document field name
	Field string `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
	// Prefix to search for
	Prefix string `protobuf:"bytes,2,opt,name=prefix,proto3" json:"prefix,omitempty"`
	// Method used to rewrite the query
	Rewrite RewriteMethod `protobuf:"varint,3,opt,name=rewrite,proto3,enum=luceneserver.RewriteMethod" json:"rewrite,omitempty"`
	// Specifies the size to use for the TOP_TERMS* rewrite methods
	RewriteTopTermsSize int32 `protobuf:"varint,4,opt,name=rewriteTopTermsSize,proto3" json:"rewriteTopTermsSize,omitempty"`
	// contains filtered or unexported fields
}

A query that matches documents that contain a specific prefix in a provided field

func (*PrefixQuery) Descriptor deprecated added in v0.18.0 

func (*PrefixQuery) Descriptor() ([]byte, []int)

Deprecated: Use PrefixQuery.ProtoReflect.Descriptor instead.

func (*PrefixQuery) GetField added in v0.18.0 

func (x *PrefixQuery) GetField() string

func (*PrefixQuery) GetPrefix added in v0.18.0 

func (x *PrefixQuery) GetPrefix() string

func (*PrefixQuery) GetRewrite added in v0.18.0 

func (x *PrefixQuery) GetRewrite() RewriteMethod

func (*PrefixQuery) GetRewriteTopTermsSize added in v0.18.0 

func (x *PrefixQuery) GetRewriteTopTermsSize() int32

func (*PrefixQuery) ProtoMessage added in v0.18.0 

func (*PrefixQuery) ProtoMessage()

func (*PrefixQuery) ProtoReflect added in v0.18.0 

func (x *PrefixQuery) ProtoReflect() protoreflect.Message

func (*PrefixQuery) Reset added in v0.18.0 

func (x *PrefixQuery) Reset()

func (*PrefixQuery) String added in v0.18.0 

func (x *PrefixQuery) String() string

type ProfileResult 

type ProfileResult struct {

	// Stats for search phase
	SearchStats *ProfileResult_SearchStats `protobuf:"bytes,1,opt,name=searchStats,proto3" json:"searchStats,omitempty"`
	// Parsed query string
	ParsedQuery string `protobuf:"bytes,2,opt,name=parsedQuery,proto3" json:"parsedQuery,omitempty"`
	// Rewritten query string
	RewrittenQuery string `protobuf:"bytes,3,opt,name=rewrittenQuery,proto3" json:"rewrittenQuery,omitempty"`
	// Drill down query string
	DrillDownQuery string `protobuf:"bytes,4,opt,name=drillDownQuery,proto3" json:"drillDownQuery,omitempty"`
	// contains filtered or unexported fields
}

Defines detailed profiling stats for queries that set profile=true

func (*ProfileResult) Descriptor deprecated 

func (*ProfileResult) Descriptor() ([]byte, []int)

Deprecated: Use ProfileResult.ProtoReflect.Descriptor instead.

func (*ProfileResult) GetDrillDownQuery 

func (x *ProfileResult) GetDrillDownQuery() string

func (*ProfileResult) GetParsedQuery 

func (x *ProfileResult) GetParsedQuery() string

func (*ProfileResult) GetRewrittenQuery 

func (x *ProfileResult) GetRewrittenQuery() string

func (*ProfileResult) GetSearchStats 

func (x *ProfileResult) GetSearchStats() *ProfileResult_SearchStats

func (*ProfileResult) ProtoMessage 

func (*ProfileResult) ProtoMessage()

func (*ProfileResult) ProtoReflect 

func (x *ProfileResult) ProtoReflect() protoreflect.Message

func (*ProfileResult) Reset 

func (x *ProfileResult) Reset()

func (*ProfileResult) String 

func (x *ProfileResult) String() string

type ProfileResult_AdditionalCollectorStats 

type ProfileResult_AdditionalCollectorStats struct {

	// Sum of all collection time
	CollectTimeMs float64 `protobuf:"fixed64,1,opt,name=collectTimeMs,proto3" json:"collectTimeMs,omitempty"`
	// contains filtered or unexported fields
}

Stats for aggregating collector

func (*ProfileResult_AdditionalCollectorStats) Descriptor deprecated 

func (*ProfileResult_AdditionalCollectorStats) Descriptor() ([]byte, []int)

Deprecated: Use ProfileResult_AdditionalCollectorStats.ProtoReflect.Descriptor instead.

func (*ProfileResult_AdditionalCollectorStats) GetCollectTimeMs 

func (x *ProfileResult_AdditionalCollectorStats) GetCollectTimeMs() float64

func (*ProfileResult_AdditionalCollectorStats) ProtoMessage 

func (*ProfileResult_AdditionalCollectorStats) ProtoMessage()

func (*ProfileResult_AdditionalCollectorStats) ProtoReflect 

func (x *ProfileResult_AdditionalCollectorStats) ProtoReflect() protoreflect.Message

func (*ProfileResult_AdditionalCollectorStats) Reset 

func (x *ProfileResult_AdditionalCollectorStats) Reset()

func (*ProfileResult_AdditionalCollectorStats) String 

func (x *ProfileResult_AdditionalCollectorStats) String() string

type ProfileResult_CollectorStats 

type ProfileResult_CollectorStats struct {

	// If collection for this index slice was terminated early, such as by a timeout
	Terminated bool `protobuf:"varint,1,opt,name=terminated,proto3" json:"terminated,omitempty"`
	// Stats for each collector segment
	SegmentStats []*ProfileResult_SegmentStats `protobuf:"bytes,2,rep,name=segmentStats,proto3" json:"segmentStats,omitempty"`
	// Total docs collected by this collector
	TotalCollectedCount int32 `protobuf:"varint,3,opt,name=totalCollectedCount,proto3" json:"totalCollectedCount,omitempty"`
	// Sum of all segment collection time
	TotalCollectTimeMs float64 `protobuf:"fixed64,4,opt,name=totalCollectTimeMs,proto3" json:"totalCollectTimeMs,omitempty"`
	// Stats for additional collection operations
	AdditionalCollectorStats map[string]*ProfileResult_AdditionalCollectorStats `` /* 189-byte string literal not displayed */
	// contains filtered or unexported fields
}

Stats for parallel search collector

func (*ProfileResult_CollectorStats) Descriptor deprecated 

func (*ProfileResult_CollectorStats) Descriptor() ([]byte, []int)

Deprecated: Use ProfileResult_CollectorStats.ProtoReflect.Descriptor instead.

func (*ProfileResult_CollectorStats) GetAdditionalCollectorStats 

func (x *ProfileResult_CollectorStats) GetAdditionalCollectorStats() map[string]*ProfileResult_AdditionalCollectorStats

func (*ProfileResult_CollectorStats) GetSegmentStats 

func (x *ProfileResult_CollectorStats) GetSegmentStats() []*ProfileResult_SegmentStats

func (*ProfileResult_CollectorStats) GetTerminated 

func (x *ProfileResult_CollectorStats) GetTerminated() bool

func (*ProfileResult_CollectorStats) GetTotalCollectTimeMs 

func (x *ProfileResult_CollectorStats) GetTotalCollectTimeMs() float64

func (*ProfileResult_CollectorStats) GetTotalCollectedCount 

func (x *ProfileResult_CollectorStats) GetTotalCollectedCount() int32

func (*ProfileResult_CollectorStats) ProtoMessage 

func (*ProfileResult_CollectorStats) ProtoMessage()

func (*ProfileResult_CollectorStats) ProtoReflect 

func (x *ProfileResult_CollectorStats) ProtoReflect() protoreflect.Message

func (*ProfileResult_CollectorStats) Reset 

func (x *ProfileResult_CollectorStats) Reset()

func (*ProfileResult_CollectorStats) String 

func (x *ProfileResult_CollectorStats) String() string

type ProfileResult_SearchStats 

type ProfileResult_SearchStats struct {

	// Total time for all document collection
	TotalCollectTimeMs float64 `protobuf:"fixed64,1,opt,name=totalCollectTimeMs,proto3" json:"totalCollectTimeMs,omitempty"`
	// Total time to reduce results from all parallel search slices
	TotalReduceTimeMs float64 `protobuf:"fixed64,2,opt,name=totalReduceTimeMs,proto3" json:"totalReduceTimeMs,omitempty"`
	// Stats for each collector
	CollectorStats []*ProfileResult_CollectorStats `protobuf:"bytes,3,rep,name=collectorStats,proto3" json:"collectorStats,omitempty"`
	// contains filtered or unexported fields
}

Stats for search phase

func (*ProfileResult_SearchStats) Descriptor deprecated 

func (*ProfileResult_SearchStats) Descriptor() ([]byte, []int)

Deprecated: Use ProfileResult_SearchStats.ProtoReflect.Descriptor instead.

func (*ProfileResult_SearchStats) GetCollectorStats 

func (x *ProfileResult_SearchStats) GetCollectorStats() []*ProfileResult_CollectorStats

func (*ProfileResult_SearchStats) GetTotalCollectTimeMs 

func (x *ProfileResult_SearchStats) GetTotalCollectTimeMs() float64

func (*ProfileResult_SearchStats) GetTotalReduceTimeMs 

func (x *ProfileResult_SearchStats) GetTotalReduceTimeMs() float64

func (*ProfileResult_SearchStats) ProtoMessage 

func (*ProfileResult_SearchStats) ProtoMessage()

func (*ProfileResult_SearchStats) ProtoReflect 

func (x *ProfileResult_SearchStats) ProtoReflect() protoreflect.Message

func (*ProfileResult_SearchStats) Reset 

func (x *ProfileResult_SearchStats) Reset()

func (*ProfileResult_SearchStats) String 

func (x *ProfileResult_SearchStats) String() string

type ProfileResult_SegmentStats 

type ProfileResult_SegmentStats struct {

	// Total docs in segment
	MaxDoc int32 `protobuf:"varint,1,opt,name=maxDoc,proto3" json:"maxDoc,omitempty"`
	// Total live docs in segment
	NumDocs int32 `protobuf:"varint,2,opt,name=numDocs,proto3" json:"numDocs,omitempty"`
	// How many docs were collected
	CollectedCount int32 `protobuf:"varint,3,opt,name=collectedCount,proto3" json:"collectedCount,omitempty"`
	// Start time of segment processing in relation to the start of the search phase
	RelativeStartTimeMs float64 `protobuf:"fixed64,4,opt,name=relativeStartTimeMs,proto3" json:"relativeStartTimeMs,omitempty"`
	// Collection duration
	CollectTimeMs float64 `protobuf:"fixed64,5,opt,name=collectTimeMs,proto3" json:"collectTimeMs,omitempty"`
	// contains filtered or unexported fields
}

Stats for a single collector segment

func (*ProfileResult_SegmentStats) Descriptor deprecated 

func (*ProfileResult_SegmentStats) Descriptor() ([]byte, []int)

Deprecated: Use ProfileResult_SegmentStats.ProtoReflect.Descriptor instead.

func (*ProfileResult_SegmentStats) GetCollectTimeMs 

func (x *ProfileResult_SegmentStats) GetCollectTimeMs() float64

func (*ProfileResult_SegmentStats) GetCollectedCount 

func (x *ProfileResult_SegmentStats) GetCollectedCount() int32

func (*ProfileResult_SegmentStats) GetMaxDoc 

func (x *ProfileResult_SegmentStats) GetMaxDoc() int32

func (*ProfileResult_SegmentStats) GetNumDocs 

func (x *ProfileResult_SegmentStats) GetNumDocs() int32

func (*ProfileResult_SegmentStats) GetRelativeStartTimeMs 

func (x *ProfileResult_SegmentStats) GetRelativeStartTimeMs() float64

func (*ProfileResult_SegmentStats) ProtoMessage 

func (*ProfileResult_SegmentStats) ProtoMessage()

func (*ProfileResult_SegmentStats) ProtoReflect 

func (x *ProfileResult_SegmentStats) ProtoReflect() protoreflect.Message

func (*ProfileResult_SegmentStats) Reset 

func (x *ProfileResult_SegmentStats) Reset()

func (*ProfileResult_SegmentStats) String 

func (x *ProfileResult_SegmentStats) String() string

type Query 

type Query struct {

	// No longer needed, type inferred from set QueryNode
	//
	// Deprecated: Do not use.
	QueryType QueryType `protobuf:"varint,1,opt,name=queryType,proto3,enum=luceneserver.QueryType" json:"queryType,omitempty"`
	// Boost values that are less than one will give less importance to this query compared to other ones while
	// values that are greater than one will give more importance to the scores returned by this query. Boost
	// value of zero will do nothing (default). Boost less than 0 is invalid.
	Boost float32 `protobuf:"fixed32,2,opt,name=boost,proto3" json:"boost,omitempty"`
	// Types that are assignable to QueryNode:
	//
	//	*Query_BooleanQuery
	//	*Query_PhraseQuery
	//	*Query_FunctionScoreQuery
	//	*Query_TermQuery
	//	*Query_TermInSetQuery
	//	*Query_DisjunctionMaxQuery
	//	*Query_MatchQuery
	//	*Query_MatchPhraseQuery
	//	*Query_MultiMatchQuery
	//	*Query_RangeQuery
	//	*Query_GeoBoundingBoxQuery
	//	*Query_GeoPointQuery
	//	*Query_NestedQuery
	//	*Query_ExistsQuery
	//	*Query_GeoRadiusQuery
	//	*Query_FunctionFilterQuery
	//	*Query_CompletionQuery
	//	*Query_MultiFunctionScoreQuery
	//	*Query_MatchPhrasePrefixQuery
	//	*Query_PrefixQuery
	//	*Query_ConstantScoreQuery
	//	*Query_GeoPolygonQuery
	//	*Query_SpanQuery
	//	*Query_MatchAllQuery
	//	*Query_ExactVectorQuery
	QueryNode isQuery_QueryNode `protobuf_oneof:"QueryNode"`
	// contains filtered or unexported fields
}

Defines a full query consisting of a QueryNode which may be one of several types

func (*Query) Descriptor deprecated 

func (*Query) Descriptor() ([]byte, []int)

Deprecated: Use Query.ProtoReflect.Descriptor instead.

func (*Query) GetBooleanQuery 

func (x *Query) GetBooleanQuery() *BooleanQuery

func (*Query) GetBoost 

func (x *Query) GetBoost() float32

func (*Query) GetCompletionQuery added in v0.16.0 

func (x *Query) GetCompletionQuery() *CompletionQuery

func (*Query) GetConstantScoreQuery added in v0.21.0 

func (x *Query) GetConstantScoreQuery() *ConstantScoreQuery

func (*Query) GetDisjunctionMaxQuery 

func (x *Query) GetDisjunctionMaxQuery() *DisjunctionMaxQuery

func (*Query) GetExactVectorQuery 

func (x *Query) GetExactVectorQuery() *ExactVectorQuery

func (*Query) GetExistsQuery 

func (x *Query) GetExistsQuery() *ExistsQuery

func (*Query) GetFunctionFilterQuery 

func (x *Query) GetFunctionFilterQuery() *FunctionFilterQuery

func (*Query) GetFunctionScoreQuery 

func (x *Query) GetFunctionScoreQuery() *FunctionScoreQuery

func (*Query) GetGeoBoundingBoxQuery 

func (x *Query) GetGeoBoundingBoxQuery() *GeoBoundingBoxQuery

func (*Query) GetGeoPointQuery 

func (x *Query) GetGeoPointQuery() *GeoPointQuery

func (*Query) GetGeoPolygonQuery added in v0.30.0 

func (x *Query) GetGeoPolygonQuery() *GeoPolygonQuery

func (*Query) GetGeoRadiusQuery 

func (x *Query) GetGeoRadiusQuery() *GeoRadiusQuery

func (*Query) GetMatchAllQuery 

func (x *Query) GetMatchAllQuery() *MatchAllQuery

func (*Query) GetMatchPhrasePrefixQuery added in v0.18.0 

func (x *Query) GetMatchPhrasePrefixQuery() *MatchPhrasePrefixQuery

func (*Query) GetMatchPhraseQuery 

func (x *Query) GetMatchPhraseQuery() *MatchPhraseQuery

func (*Query) GetMatchQuery 

func (x *Query) GetMatchQuery() *MatchQuery

func (*Query) GetMultiFunctionScoreQuery added in v0.18.0 

func (x *Query) GetMultiFunctionScoreQuery() *MultiFunctionScoreQuery

func (*Query) GetMultiMatchQuery 

func (x *Query) GetMultiMatchQuery() *MultiMatchQuery

func (*Query) GetNestedQuery 

func (x *Query) GetNestedQuery() *NestedQuery

func (*Query) GetPhraseQuery 

func (x *Query) GetPhraseQuery() *PhraseQuery

func (*Query) GetPrefixQuery added in v0.18.0 

func (x *Query) GetPrefixQuery() *PrefixQuery

func (*Query) GetQueryNode 

func (m *Query) GetQueryNode() isQuery_QueryNode

func (*Query) GetQueryType deprecated 

func (x *Query) GetQueryType() QueryType

Deprecated: Do not use.

func (*Query) GetRangeQuery 

func (x *Query) GetRangeQuery() *RangeQuery

func (*Query) GetSpanQuery added in v0.39.0 

func (x *Query) GetSpanQuery() *SpanQuery

func (*Query) GetTermInSetQuery 

func (x *Query) GetTermInSetQuery() *TermInSetQuery

func (*Query) GetTermQuery 

func (x *Query) GetTermQuery() *TermQuery

func (*Query) ProtoMessage 

func (*Query) ProtoMessage()

func (*Query) ProtoReflect 

func (x *Query) ProtoReflect() protoreflect.Message

func (*Query) Reset 

func (x *Query) Reset()

func (*Query) String 

func (x *Query) String() string

type QueryRescorer 

type QueryRescorer struct {

	// Query to rescore documents
	RescoreQuery *Query `protobuf:"bytes,1,opt,name=rescoreQuery,proto3" json:"rescoreQuery,omitempty"`
	// Weight to multiply with original query score
	QueryWeight float64 `protobuf:"fixed64,2,opt,name=queryWeight,proto3" json:"queryWeight,omitempty"`
	// Weight to multiply with rescore query score
	RescoreQueryWeight float64 `protobuf:"fixed64,3,opt,name=rescoreQueryWeight,proto3" json:"rescoreQueryWeight,omitempty"`
	// contains filtered or unexported fields
}

Defines a rescorer which uses query to rescore documents in the second pass

func (*QueryRescorer) Descriptor deprecated 

func (*QueryRescorer) Descriptor() ([]byte, []int)

Deprecated: Use QueryRescorer.ProtoReflect.Descriptor instead.

func (*QueryRescorer) GetQueryWeight 

func (x *QueryRescorer) GetQueryWeight() float64

func (*QueryRescorer) GetRescoreQuery 

func (x *QueryRescorer) GetRescoreQuery() *Query

func (*QueryRescorer) GetRescoreQueryWeight 

func (x *QueryRescorer) GetRescoreQueryWeight() float64

func (*QueryRescorer) ProtoMessage 

func (*QueryRescorer) ProtoMessage()

func (*QueryRescorer) ProtoReflect 

func (x *QueryRescorer) ProtoReflect() protoreflect.Message

func (*QueryRescorer) Reset 

func (x *QueryRescorer) Reset()

func (*QueryRescorer) String 

func (x *QueryRescorer) String() string

type QuerySortField 

type QuerySortField struct {

	// Compute the doc score for each collected (costs added CPU); default:false
	DoDocScores bool `protobuf:"varint,1,opt,name=doDocScores,proto3" json:"doDocScores,omitempty"`
	// Compute the max score across all hits (costs added CPU); default: false
	DoMaxScore bool `protobuf:"varint,2,opt,name=doMaxScore,proto3" json:"doMaxScore,omitempty"`
	// List of Fields to sort on
	Fields *SortFields `protobuf:"bytes,3,opt,name=fields,proto3" json:"fields,omitempty"`
	// contains filtered or unexported fields
}

Definition doing ranking by sorting on fields

func (*QuerySortField) Descriptor deprecated 

func (*QuerySortField) Descriptor() ([]byte, []int)

Deprecated: Use QuerySortField.ProtoReflect.Descriptor instead.

func (*QuerySortField) GetDoDocScores 

func (x *QuerySortField) GetDoDocScores() bool

func (*QuerySortField) GetDoMaxScore 

func (x *QuerySortField) GetDoMaxScore() bool

func (*QuerySortField) GetFields 

func (x *QuerySortField) GetFields() *SortFields

func (*QuerySortField) ProtoMessage 

func (*QuerySortField) ProtoMessage()

func (*QuerySortField) ProtoReflect 

func (x *QuerySortField) ProtoReflect() protoreflect.Message

func (*QuerySortField) Reset 

func (x *QuerySortField) Reset()

func (*QuerySortField) String 

func (x *QuerySortField) String() string

type QueryType deprecated 

type QueryType int32

Deprecated: Defines different types of QueryNodes 

const (
	QueryType_NONE                       QueryType = 0
	QueryType_BOOLEAN_QUERY              QueryType = 1
	QueryType_PHRASE_QUERY               QueryType = 2
	QueryType_FUNCTION_SCORE_QUERY       QueryType = 3
	QueryType_TERM_QUERY                 QueryType = 4
	QueryType_TERM_IN_SET_QUERY          QueryType = 5
	QueryType_DISJUNCTION_MAX            QueryType = 6
	QueryType_MATCH                      QueryType = 7
	QueryType_MATCH_PHRASE               QueryType = 8
	QueryType_MULTI_MATCH                QueryType = 9
	QueryType_RANGE                      QueryType = 10
	QueryType_GEO_BOUNDING_BOX           QueryType = 11
	QueryType_GEO_POINT                  QueryType = 12
	QueryType_NESTED                     QueryType = 13
	QueryType_EXISTS                     QueryType = 14
	QueryType_GEO_RADIUS                 QueryType = 15
	QueryType_COMPLETION                 QueryType = 16
	QueryType_MULTI_FUNCTION_SCORE_QUERY QueryType = 17
	QueryType_MATCH_PHRASE_PREFIX        QueryType = 18
	QueryType_PREFIX                     QueryType = 19
	QueryType_CONSTANT_SCORE_QUERY       QueryType = 20
	QueryType_GEO_POLYGON                QueryType = 21
	QueryType_SPAN_QUERY                 QueryType = 22
)

func (QueryType) Descriptor 

func (QueryType) Descriptor() protoreflect.EnumDescriptor

func (QueryType) Enum 

func (x QueryType) Enum() *QueryType

func (QueryType) EnumDescriptor deprecated 

func (QueryType) EnumDescriptor() ([]byte, []int)

Deprecated: Use QueryType.Descriptor instead.

func (QueryType) Number 

func (x QueryType) Number() protoreflect.EnumNumber

func (QueryType) String 

func (x QueryType) String() string

func (QueryType) Type 

func (QueryType) Type() protoreflect.EnumType

type Query_BooleanQuery 

type Query_BooleanQuery struct {
	BooleanQuery *BooleanQuery `protobuf:"bytes,3,opt,name=booleanQuery,proto3,oneof"`
}

type Query_CompletionQuery added in v0.16.0 

type Query_CompletionQuery struct {
	CompletionQuery *CompletionQuery `protobuf:"bytes,19,opt,name=completionQuery,proto3,oneof"`
}

type Query_ConstantScoreQuery added in v0.21.0 

type Query_ConstantScoreQuery struct {
	ConstantScoreQuery *ConstantScoreQuery `protobuf:"bytes,23,opt,name=constantScoreQuery,proto3,oneof"`
}

type Query_DisjunctionMaxQuery 

type Query_DisjunctionMaxQuery struct {
	DisjunctionMaxQuery *DisjunctionMaxQuery `protobuf:"bytes,8,opt,name=disjunctionMaxQuery,proto3,oneof"`
}

type Query_ExactVectorQuery 

type Query_ExactVectorQuery struct {
	ExactVectorQuery *ExactVectorQuery `protobuf:"bytes,27,opt,name=exactVectorQuery,proto3,oneof"`
}

type Query_ExistsQuery 

type Query_ExistsQuery struct {
	ExistsQuery *ExistsQuery `protobuf:"bytes,16,opt,name=existsQuery,proto3,oneof"`
}

type Query_FunctionFilterQuery 

type Query_FunctionFilterQuery struct {
	FunctionFilterQuery *FunctionFilterQuery `protobuf:"bytes,18,opt,name=functionFilterQuery,proto3,oneof"`
}

type Query_FunctionScoreQuery 

type Query_FunctionScoreQuery struct {
	FunctionScoreQuery *FunctionScoreQuery `protobuf:"bytes,5,opt,name=functionScoreQuery,proto3,oneof"`
}

type Query_GeoBoundingBoxQuery 

type Query_GeoBoundingBoxQuery struct {
	GeoBoundingBoxQuery *GeoBoundingBoxQuery `protobuf:"bytes,13,opt,name=geoBoundingBoxQuery,proto3,oneof"`
}

type Query_GeoPointQuery 

type Query_GeoPointQuery struct {
	GeoPointQuery *GeoPointQuery `protobuf:"bytes,14,opt,name=geoPointQuery,proto3,oneof"`
}

type Query_GeoPolygonQuery added in v0.30.0 

type Query_GeoPolygonQuery struct {
	GeoPolygonQuery *GeoPolygonQuery `protobuf:"bytes,24,opt,name=geoPolygonQuery,proto3,oneof"`
}

type Query_GeoRadiusQuery 

type Query_GeoRadiusQuery struct {
	GeoRadiusQuery *GeoRadiusQuery `protobuf:"bytes,17,opt,name=geoRadiusQuery,proto3,oneof"`
}

type Query_MatchAllQuery 

type Query_MatchAllQuery struct {
	MatchAllQuery *MatchAllQuery `protobuf:"bytes,26,opt,name=matchAllQuery,proto3,oneof"`
}

type Query_MatchPhrasePrefixQuery added in v0.18.0 

type Query_MatchPhrasePrefixQuery struct {
	MatchPhrasePrefixQuery *MatchPhrasePrefixQuery `protobuf:"bytes,21,opt,name=matchPhrasePrefixQuery,proto3,oneof"`
}

type Query_MatchPhraseQuery 

type Query_MatchPhraseQuery struct {
	MatchPhraseQuery *MatchPhraseQuery `protobuf:"bytes,10,opt,name=matchPhraseQuery,proto3,oneof"`
}

type Query_MatchQuery 

type Query_MatchQuery struct {
	MatchQuery *MatchQuery `protobuf:"bytes,9,opt,name=matchQuery,proto3,oneof"`
}

type Query_MultiFunctionScoreQuery added in v0.18.0 

type Query_MultiFunctionScoreQuery struct {
	MultiFunctionScoreQuery *MultiFunctionScoreQuery `protobuf:"bytes,20,opt,name=multiFunctionScoreQuery,proto3,oneof"`
}

type Query_MultiMatchQuery 

type Query_MultiMatchQuery struct {
	MultiMatchQuery *MultiMatchQuery `protobuf:"bytes,11,opt,name=multiMatchQuery,proto3,oneof"`
}

type Query_NestedQuery 

type Query_NestedQuery struct {
	NestedQuery *NestedQuery `protobuf:"bytes,15,opt,name=nestedQuery,proto3,oneof"`
}

type Query_PhraseQuery 

type Query_PhraseQuery struct {
	PhraseQuery *PhraseQuery `protobuf:"bytes,4,opt,name=phraseQuery,proto3,oneof"`
}

type Query_PrefixQuery added in v0.18.0 

type Query_PrefixQuery struct {
	PrefixQuery *PrefixQuery `protobuf:"bytes,22,opt,name=prefixQuery,proto3,oneof"`
}

type Query_RangeQuery 

type Query_RangeQuery struct {
	RangeQuery *RangeQuery `protobuf:"bytes,12,opt,name=rangeQuery,proto3,oneof"`
}

type Query_SpanQuery added in v0.39.0 

type Query_SpanQuery struct {
	SpanQuery *SpanQuery `protobuf:"bytes,25,opt,name=spanQuery,proto3,oneof"`
}

type Query_TermInSetQuery 

type Query_TermInSetQuery struct {
	TermInSetQuery *TermInSetQuery `protobuf:"bytes,7,opt,name=termInSetQuery,proto3,oneof"`
}

type Query_TermQuery 

type Query_TermQuery struct {
	TermQuery *TermQuery `protobuf:"bytes,6,opt,name=termQuery,proto3,oneof"`
}

type RangeQuery 

type RangeQuery struct {

	// Field in the document to query
	Field string `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
	// Lower bound, inclusive by default
	Lower string `protobuf:"bytes,2,opt,name=lower,proto3" json:"lower,omitempty"`
	// Upper bound, inclusive by default
	Upper string `protobuf:"bytes,3,opt,name=upper,proto3" json:"upper,omitempty"`
	// Set true to make lower bound exclusive
	LowerExclusive bool `protobuf:"varint,4,opt,name=lowerExclusive,proto3" json:"lowerExclusive,omitempty"`
	// Set true to make upper bound exclusive
	UpperExclusive bool `protobuf:"varint,5,opt,name=upperExclusive,proto3" json:"upperExclusive,omitempty"`
	// contains filtered or unexported fields
}

A query that matches documents with values within the specified range. The lower and upper values though provided as strings will be converted to the type of the field. This works with INT, LONG, FLOAT, DOUBLE and DATE_TIME field types.

func (*RangeQuery) Descriptor deprecated 

func (*RangeQuery) Descriptor() ([]byte, []int)

Deprecated: Use RangeQuery.ProtoReflect.Descriptor instead.

func (*RangeQuery) GetField 

func (x *RangeQuery) GetField() string

func (*RangeQuery) GetLower 

func (x *RangeQuery) GetLower() string

func (*RangeQuery) GetLowerExclusive 

func (x *RangeQuery) GetLowerExclusive() bool

func (*RangeQuery) GetUpper 

func (x *RangeQuery) GetUpper() string

func (*RangeQuery) GetUpperExclusive 

func (x *RangeQuery) GetUpperExclusive() bool

func (*RangeQuery) ProtoMessage 

func (*RangeQuery) ProtoMessage()

func (*RangeQuery) ProtoReflect 

func (x *RangeQuery) ProtoReflect() protoreflect.Message

func (*RangeQuery) Reset 

func (x *RangeQuery) Reset()

func (*RangeQuery) String 

func (x *RangeQuery) String() string

type RawFileChunk 

type RawFileChunk struct {

	// Raw contents of file
	Content []byte `protobuf:"bytes,1,opt,name=content,proto3" json:"content,omitempty"`
	// Sequence number for this chunk, only used for acked file copy
	SeqNum int32 `protobuf:"varint,2,opt,name=seqNum,proto3" json:"seqNum,omitempty"`
	// If this chunk should be acked, only used for acked file copy
	Ack bool `protobuf:"varint,3,opt,name=ack,proto3" json:"ack,omitempty"`
	// contains filtered or unexported fields
}

Chunk of file data

func (*RawFileChunk) Descriptor deprecated 

func (*RawFileChunk) Descriptor() ([]byte, []int)

Deprecated: Use RawFileChunk.ProtoReflect.Descriptor instead.

func (*RawFileChunk) GetAck 

func (x *RawFileChunk) GetAck() bool

func (*RawFileChunk) GetContent 

func (x *RawFileChunk) GetContent() []byte

func (*RawFileChunk) GetSeqNum 

func (x *RawFileChunk) GetSeqNum() int32

func (*RawFileChunk) ProtoMessage 

func (*RawFileChunk) ProtoMessage()

func (*RawFileChunk) ProtoReflect 

func (x *RawFileChunk) ProtoReflect() protoreflect.Message

func (*RawFileChunk) Reset 

func (x *RawFileChunk) Reset()

func (*RawFileChunk) String 

func (x *RawFileChunk) String() string

type ReadyCheckRequest 

type ReadyCheckRequest struct {
	IndexNames string `protobuf:"bytes,1,opt,name=indexNames,proto3" json:"indexNames,omitempty"`
	// contains filtered or unexported fields
}

Input to readyCheck

func (*ReadyCheckRequest) Descriptor deprecated 

func (*ReadyCheckRequest) Descriptor() ([]byte, []int)

Deprecated: Use ReadyCheckRequest.ProtoReflect.Descriptor instead.

func (*ReadyCheckRequest) GetIndexNames 

func (x *ReadyCheckRequest) GetIndexNames() string

func (*ReadyCheckRequest) ProtoMessage 

func (*ReadyCheckRequest) ProtoMessage()

func (*ReadyCheckRequest) ProtoReflect 

func (x *ReadyCheckRequest) ProtoReflect() protoreflect.Message

func (*ReadyCheckRequest) Reset 

func (x *ReadyCheckRequest) Reset()

func (*ReadyCheckRequest) String 

func (x *ReadyCheckRequest) String() string

type RefreshRequest 

type RefreshRequest struct {

	// Index name to be refreshed
	IndexName string `protobuf:"bytes,1,opt,name=indexName,proto3" json:"indexName,omitempty"`
	// contains filtered or unexported fields
}

Input to refresh

func (*RefreshRequest) Descriptor deprecated 

func (*RefreshRequest) Descriptor() ([]byte, []int)

Deprecated: Use RefreshRequest.ProtoReflect.Descriptor instead.

func (*RefreshRequest) GetIndexName 

func (x *RefreshRequest) GetIndexName() string

func (*RefreshRequest) ProtoMessage 

func (*RefreshRequest) ProtoMessage()

func (*RefreshRequest) ProtoReflect 

func (x *RefreshRequest) ProtoReflect() protoreflect.Message

func (*RefreshRequest) Reset 

func (x *RefreshRequest) Reset()

func (*RefreshRequest) String 

func (x *RefreshRequest) String() string

type RefreshResponse 

type RefreshResponse struct {

	// Time taken in milliseconds to refresh the index
	RefreshTimeMS float64 `protobuf:"fixed64,1,opt,name=refreshTimeMS,proto3" json:"refreshTimeMS,omitempty"`
	// contains filtered or unexported fields
}

Response from Server for refresh

func (*RefreshResponse) Descriptor deprecated 

func (*RefreshResponse) Descriptor() ([]byte, []int)

Deprecated: Use RefreshResponse.ProtoReflect.Descriptor instead.

func (*RefreshResponse) GetRefreshTimeMS 

func (x *RefreshResponse) GetRefreshTimeMS() float64

func (*RefreshResponse) ProtoMessage 

func (*RefreshResponse) ProtoMessage()

func (*RefreshResponse) ProtoReflect 

func (x *RefreshResponse) ProtoReflect() protoreflect.Message

func (*RefreshResponse) Reset 

func (x *RefreshResponse) Reset()

func (*RefreshResponse) String 

func (x *RefreshResponse) String() string

type RegexpFlag added in v0.39.0 

type RegexpFlag int32

Enum for RegexpQuery flags 

const (
	// Syntax flag, enables all optional regexp syntax
	RegexpFlag_REGEXP_ALL RegexpFlag = 0
	// Syntax flag, enables anystring (@)
	RegexpFlag_REGEXP_ANYSTRING RegexpFlag = 1
	// Syntax flag, enables named automata (<identifier>)
	RegexpFlag_REGEXP_AUTOMATON RegexpFlag = 2
	// Syntax flag, enables complement (~)
	RegexpFlag_REGEXP_COMPLEMENT RegexpFlag = 3
	// Syntax flag, enables empty language (#)
	RegexpFlag_REGEXP_EMPTY RegexpFlag = 4
	// Syntax flag, enables intersection (&)
	RegexpFlag_REGEXP_INTERSECTION RegexpFlag = 5
	// Syntax flag, enables numerical intervals (<n-m>)
	RegexpFlag_REGEXP_INTERVAL RegexpFlag = 6
	// Syntax flag, enables no optional regexp syntax
	RegexpFlag_REGEXP_NONE RegexpFlag = 7
)

func (RegexpFlag) Descriptor added in v0.39.0 

func (RegexpFlag) Descriptor() protoreflect.EnumDescriptor

func (RegexpFlag) Enum added in v0.39.0 

func (x RegexpFlag) Enum() *RegexpFlag

func (RegexpFlag) EnumDescriptor deprecated added in v0.39.0 

func (RegexpFlag) EnumDescriptor() ([]byte, []int)

Deprecated: Use RegexpFlag.Descriptor instead.

func (RegexpFlag) Number added in v0.39.0 

func (x RegexpFlag) Number() protoreflect.EnumNumber

func (RegexpFlag) String added in v0.39.0 

func (x RegexpFlag) String() string

func (RegexpFlag) Type added in v0.39.0 

func (RegexpFlag) Type() protoreflect.EnumType

type RegexpQuery added in v0.39.0 

type RegexpQuery struct {

	// Field in the document to query
	Field string `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
	// Regular expression to search for
	Text string `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
	// Optional flags for the regular expression
	Flag RegexpFlag `protobuf:"varint,3,opt,name=flag,proto3,enum=luceneserver.RegexpFlag" json:"flag,omitempty"`
	// Maximum number of states that compiling the automaton for the regexp can result in. Set higher to allow more
	// complex queries and lower to prevent memory exhaustion. Default is 10000.
	MaxDeterminizedStates *int32 `protobuf:"varint,4,opt,name=maxDeterminizedStates,proto3,oneof" json:"maxDeterminizedStates,omitempty"`
	// Method used to rewrite the query
	Rewrite RewriteMethod `protobuf:"varint,5,opt,name=rewrite,proto3,enum=luceneserver.RewriteMethod" json:"rewrite,omitempty"`
	// Specifies the size to use for the TOP_TERMS* rewrite methods
	RewriteTopTermsSize int32 `protobuf:"varint,6,opt,name=rewriteTopTermsSize,proto3" json:"rewriteTopTermsSize,omitempty"`
	// contains filtered or unexported fields
}

Message for RegexpQuery

func (*RegexpQuery) Descriptor deprecated added in v0.39.0 

func (*RegexpQuery) Descriptor() ([]byte, []int)

Deprecated: Use RegexpQuery.ProtoReflect.Descriptor instead.

func (*RegexpQuery) GetField added in v0.39.0 

func (x *RegexpQuery) GetField() string

func (*RegexpQuery) GetFlag added in v0.39.0 

func (x *RegexpQuery) GetFlag() RegexpFlag

func (*RegexpQuery) GetMaxDeterminizedStates added in v0.39.0 

func (x *RegexpQuery) GetMaxDeterminizedStates() int32

func (*RegexpQuery) GetRewrite added in v0.39.0 

func (x *RegexpQuery) GetRewrite() RewriteMethod

func (*RegexpQuery) GetRewriteTopTermsSize added in v0.39.0 

func (x *RegexpQuery) GetRewriteTopTermsSize() int32

func (*RegexpQuery) GetText added in v0.39.0 

func (x *RegexpQuery) GetText() string

func (*RegexpQuery) ProtoMessage added in v0.39.0 

func (*RegexpQuery) ProtoMessage()

func (*RegexpQuery) ProtoReflect added in v0.39.0 

func (x *RegexpQuery) ProtoReflect() protoreflect.Message

func (*RegexpQuery) Reset added in v0.39.0 

func (x *RegexpQuery) Reset()

func (*RegexpQuery) String added in v0.39.0 

func (x *RegexpQuery) String() string

type ReleaseSnapshotRequest 

type ReleaseSnapshotRequest struct {

	// Name of the index to release snapshot
	IndexName string `protobuf:"bytes,1,opt,name=indexName,proto3" json:"indexName,omitempty"`
	// Id of snapshot to release, previously returned by @createSnapshot
	SnapshotId *SnapshotId `protobuf:"bytes,2,opt,name=snapshotId,proto3" json:"snapshotId,omitempty"`
	// contains filtered or unexported fields
}

Input to releaseSnapshot

func (*ReleaseSnapshotRequest) Descriptor deprecated 

func (*ReleaseSnapshotRequest) Descriptor() ([]byte, []int)

Deprecated: Use ReleaseSnapshotRequest.ProtoReflect.Descriptor instead.

func (*ReleaseSnapshotRequest) GetIndexName 

func (x *ReleaseSnapshotRequest) GetIndexName() string

func (*ReleaseSnapshotRequest) GetSnapshotId 

func (x *ReleaseSnapshotRequest) GetSnapshotId() *SnapshotId

func (*ReleaseSnapshotRequest) ProtoMessage 

func (*ReleaseSnapshotRequest) ProtoMessage()

func (*ReleaseSnapshotRequest) ProtoReflect 

func (x *ReleaseSnapshotRequest) ProtoReflect() protoreflect.Message

func (*ReleaseSnapshotRequest) Reset 

func (x *ReleaseSnapshotRequest) Reset()

func (*ReleaseSnapshotRequest) String 

func (x *ReleaseSnapshotRequest) String() string

type ReleaseSnapshotResponse 

type ReleaseSnapshotResponse struct {

	// True if successful
	Success bool `protobuf:"varint,1,opt,name=success,proto3" json:"success,omitempty"`
	// contains filtered or unexported fields
}

Response from Server for releaseSnapshot

func (*ReleaseSnapshotResponse) Descriptor deprecated 

func (*ReleaseSnapshotResponse) Descriptor() ([]byte, []int)

Deprecated: Use ReleaseSnapshotResponse.ProtoReflect.Descriptor instead.

func (*ReleaseSnapshotResponse) GetSuccess 

func (x *ReleaseSnapshotResponse) GetSuccess() bool

func (*ReleaseSnapshotResponse) ProtoMessage 

func (*ReleaseSnapshotResponse) ProtoMessage()

func (*ReleaseSnapshotResponse) ProtoReflect 

func (x *ReleaseSnapshotResponse) ProtoReflect() protoreflect.Message

func (*ReleaseSnapshotResponse) Reset 

func (x *ReleaseSnapshotResponse) Reset()

func (*ReleaseSnapshotResponse) String 

func (x *ReleaseSnapshotResponse) String() string

type ReloadStateRequest added in v0.13.0 

type ReloadStateRequest struct {
	// contains filtered or unexported fields
}

Input to reloadState

func (*ReloadStateRequest) Descriptor deprecated added in v0.13.0 

func (*ReloadStateRequest) Descriptor() ([]byte, []int)

Deprecated: Use ReloadStateRequest.ProtoReflect.Descriptor instead.

func (*ReloadStateRequest) ProtoMessage added in v0.13.0 

func (*ReloadStateRequest) ProtoMessage()

func (*ReloadStateRequest) ProtoReflect added in v0.13.0 

func (x *ReloadStateRequest) ProtoReflect() protoreflect.Message

func (*ReloadStateRequest) Reset added in v0.13.0 

func (x *ReloadStateRequest) Reset()

func (*ReloadStateRequest) String added in v0.13.0 

func (x *ReloadStateRequest) String() string

type ReloadStateResponse added in v0.13.0 

type ReloadStateResponse struct {
	// contains filtered or unexported fields
}

Response from Server for reloadState

func (*ReloadStateResponse) Descriptor deprecated added in v0.13.0 

func (*ReloadStateResponse) Descriptor() ([]byte, []int)

Deprecated: Use ReloadStateResponse.ProtoReflect.Descriptor instead.

func (*ReloadStateResponse) ProtoMessage added in v0.13.0 

func (*ReloadStateResponse) ProtoMessage()

func (*ReloadStateResponse) ProtoReflect added in v0.13.0 

func (x *ReloadStateResponse) ProtoReflect() protoreflect.Message

func (*ReloadStateResponse) Reset added in v0.13.0 

func (x *ReloadStateResponse) Reset()

func (*ReloadStateResponse) String added in v0.13.0 

func (x *ReloadStateResponse) String() string

type ReplicationServerClient 

type ReplicationServerClient interface {
	// Issued by replica on primary node when it comes up
	AddReplicas(ctx context.Context, in *AddReplicaRequest, opts ...grpc.CallOption) (*AddReplicaResponse, error)
	// Issued by replica to receive CopyState from primary
	RecvCopyState(ctx context.Context, in *CopyStateRequest, opts ...grpc.CallOption) (*CopyState, error)
	// Send a file as a stream in chunks
	SendRawFile(ctx context.Context, opts ...grpc.CallOption) (ReplicationServer_SendRawFileClient, error)
	// Receives a file as a stream in chunks. Typically issued by replica on primary
	RecvRawFile(ctx context.Context, in *FileInfo, opts ...grpc.CallOption) (ReplicationServer_RecvRawFileClient, error)
	// Receives a file as a stream in chunks. Uses bidirectional streaming for acks to control in flight data.
	RecvRawFileV2(ctx context.Context, opts ...grpc.CallOption) (ReplicationServer_RecvRawFileV2Client, error)
	// Issued by primary on replica to inform it to start copying files either pre-warming (new merged segments)
	// or when replica comes up first time
	CopyFiles(ctx context.Context, in *CopyFiles, opts ...grpc.CallOption) (ReplicationServer_CopyFilesClient, error)
	// Invoked externally to replica, to notify it that a new NRT point was just created on the primary
	NewNRTPoint(ctx context.Context, in *NewNRTPoint, opts ...grpc.CallOption) (*TransferStatus, error)
	// Invoked externally to primary, to make all recent index operations searchable on the primary and,
	// once copying is done, on the replicas
	WriteNRTPoint(ctx context.Context, in *IndexName, opts ...grpc.CallOption) (*SearcherVersion, error)
	// Invoked externally to replica, to get the current Searcher version on replica
	GetCurrentSearcherVersion(ctx context.Context, in *IndexName, opts ...grpc.CallOption) (*SearcherVersion, error)
	// Invoked externally on primary to find the list of replica nodes this node is connected to for binary
	// replication for an index
	GetConnectedNodes(ctx context.Context, in *GetNodesRequest, opts ...grpc.CallOption) (*GetNodesResponse, error)
}

ReplicationServerClient is the client API for ReplicationServer service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewReplicationServerClient 

func NewReplicationServerClient(cc grpc.ClientConnInterface) ReplicationServerClient

type ReplicationServerServer 

type ReplicationServerServer interface {
	// Issued by replica on primary node when it comes up
	AddReplicas(context.Context, *AddReplicaRequest) (*AddReplicaResponse, error)
	// Issued by replica to receive CopyState from primary
	RecvCopyState(context.Context, *CopyStateRequest) (*CopyState, error)
	// Send a file as a stream in chunks
	SendRawFile(ReplicationServer_SendRawFileServer) error
	// Receives a file as a stream in chunks. Typically issued by replica on primary
	RecvRawFile(*FileInfo, ReplicationServer_RecvRawFileServer) error
	// Receives a file as a stream in chunks. Uses bidirectional streaming for acks to control in flight data.
	RecvRawFileV2(ReplicationServer_RecvRawFileV2Server) error
	// Issued by primary on replica to inform it to start copying files either pre-warming (new merged segments)
	// or when replica comes up first time
	CopyFiles(*CopyFiles, ReplicationServer_CopyFilesServer) error
	// Invoked externally to replica, to notify it that a new NRT point was just created on the primary
	NewNRTPoint(context.Context, *NewNRTPoint) (*TransferStatus, error)
	// Invoked externally to primary, to make all recent index operations searchable on the primary and,
	// once copying is done, on the replicas
	WriteNRTPoint(context.Context, *IndexName) (*SearcherVersion, error)
	// Invoked externally to replica, to get the current Searcher version on replica
	GetCurrentSearcherVersion(context.Context, *IndexName) (*SearcherVersion, error)
	// Invoked externally on primary to find the list of replica nodes this node is connected to for binary
	// replication for an index
	GetConnectedNodes(context.Context, *GetNodesRequest) (*GetNodesResponse, error)
}

ReplicationServerServer is the server API for ReplicationServer service.

type ReplicationServer_CopyFilesClient 

type ReplicationServer_CopyFilesClient interface {
	Recv() (*TransferStatus, error)
	grpc.ClientStream
}

type ReplicationServer_CopyFilesServer 

type ReplicationServer_CopyFilesServer interface {
	Send(*TransferStatus) error
	grpc.ServerStream
}

type ReplicationServer_RecvRawFileClient 

type ReplicationServer_RecvRawFileClient interface {
	Recv() (*RawFileChunk, error)
	grpc.ClientStream
}

type ReplicationServer_RecvRawFileServer 

type ReplicationServer_RecvRawFileServer interface {
	Send(*RawFileChunk) error
	grpc.ServerStream
}

type ReplicationServer_RecvRawFileV2Client 

type ReplicationServer_RecvRawFileV2Client interface {
	Send(*FileInfo) error
	Recv() (*RawFileChunk, error)
	grpc.ClientStream
}

type ReplicationServer_RecvRawFileV2Server 

type ReplicationServer_RecvRawFileV2Server interface {
	Send(*RawFileChunk) error
	Recv() (*FileInfo, error)
	grpc.ServerStream
}

type ReplicationServer_SendRawFileClient 

type ReplicationServer_SendRawFileClient interface {
	Send(*RawFileChunk) error
	CloseAndRecv() (*TransferStatus, error)
	grpc.ClientStream
}

type ReplicationServer_SendRawFileServer 

type ReplicationServer_SendRawFileServer interface {
	SendAndClose(*TransferStatus) error
	Recv() (*RawFileChunk, error)
	grpc.ServerStream
}

type Rescorer 

type Rescorer struct {

	// Maximum number of hits from previous phase to rescore
	WindowSize int32 `protobuf:"varint,1,opt,name=windowSize,proto3" json:"windowSize,omitempty"`
	// Types that are assignable to Rescorers:
	//
	//	*Rescorer_QueryRescorer
	//	*Rescorer_PluginRescorer
	Rescorers isRescorer_Rescorers `protobuf_oneof:"Rescorers"`
	// Must be unique for each Rescorer
	Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Defines a rescorer which is executed after the first search pass

func (*Rescorer) Descriptor deprecated 

func (*Rescorer) Descriptor() ([]byte, []int)

Deprecated: Use Rescorer.ProtoReflect.Descriptor instead.

func (*Rescorer) GetName 

func (x *Rescorer) GetName() string

func (*Rescorer) GetPluginRescorer 

func (x *Rescorer) GetPluginRescorer() *PluginRescorer

func (*Rescorer) GetQueryRescorer 

func (x *Rescorer) GetQueryRescorer() *QueryRescorer

func (*Rescorer) GetRescorers 

func (m *Rescorer) GetRescorers() isRescorer_Rescorers

func (*Rescorer) GetWindowSize 

func (x *Rescorer) GetWindowSize() int32

func (*Rescorer) ProtoMessage 

func (*Rescorer) ProtoMessage()

func (*Rescorer) ProtoReflect 

func (x *Rescorer) ProtoReflect() protoreflect.Message

func (*Rescorer) Reset 

func (x *Rescorer) Reset()

func (*Rescorer) String 

func (x *Rescorer) String() string

type Rescorer_PluginRescorer 

type Rescorer_PluginRescorer struct {
	// Rescore with plugin registered rescorer
	PluginRescorer *PluginRescorer `protobuf:"bytes,3,opt,name=pluginRescorer,proto3,oneof"`
}

type Rescorer_QueryRescorer 

type Rescorer_QueryRescorer struct {
	// Rescore with Lucene query
	QueryRescorer *QueryRescorer `protobuf:"bytes,2,opt,name=queryRescorer,proto3,oneof"`
}

type RestoreIndex 

type RestoreIndex struct {

	// Remote storage namespace qualifier for service
	ServiceName string `protobuf:"bytes,1,opt,name=serviceName,proto3" json:"serviceName,omitempty"`
	// Remote storage namespace qualifier for resource e.g. indexName
	ResourceName string `protobuf:"bytes,2,opt,name=resourceName,proto3" json:"resourceName,omitempty"`
	// Delete any existing local data for the index
	DeleteExistingData bool `protobuf:"varint,3,opt,name=deleteExistingData,proto3" json:"deleteExistingData,omitempty"`
	// contains filtered or unexported fields
}

Index restore information

func (*RestoreIndex) Descriptor deprecated 

func (*RestoreIndex) Descriptor() ([]byte, []int)

Deprecated: Use RestoreIndex.ProtoReflect.Descriptor instead.

func (*RestoreIndex) GetDeleteExistingData 

func (x *RestoreIndex) GetDeleteExistingData() bool

func (*RestoreIndex) GetResourceName 

func (x *RestoreIndex) GetResourceName() string

func (*RestoreIndex) GetServiceName 

func (x *RestoreIndex) GetServiceName() string

func (*RestoreIndex) ProtoMessage 

func (*RestoreIndex) ProtoMessage()

func (*RestoreIndex) ProtoReflect 

func (x *RestoreIndex) ProtoReflect() protoreflect.Message

func (*RestoreIndex) Reset 

func (x *RestoreIndex) Reset()

func (*RestoreIndex) String 

func (x *RestoreIndex) String() string

type RewriteMethod added in v0.18.0 

type RewriteMethod int32

Method used to rewrite a MultiTermQuery 

const (
	// Uses the CONSTANT_SCORE_BOOLEAN method for fewer matching terms. Otherwise, this method finds all matching
	// terms in sequence and returns matching documents using a bit set.
	RewriteMethod_CONSTANT_SCORE RewriteMethod = 0
	// This method changes the original query to a BooleanQuery, containing a SHOULD clause and TermQuery for each
	// matching term.
	RewriteMethod_CONSTANT_SCORE_BOOLEAN RewriteMethod = 1
	// This method changes the original query to a BooleanQuery, containing a SHOULD clause and TermQuery for each
	// matching term. Calculates the relevance score for each matching document.
	RewriteMethod_SCORING_BOOLEAN RewriteMethod = 2
	// This method changes the original query to a BooleanQuery, containing a SHOULD clause and TermQuery for each
	// matching term. Calculates a relevance score for each matching document as if all terms had the same frequency,
	// the maximum frequency of all matching terms. The final BooleanQuery query only includes Term queries for
	// the top N (specified separately) scoring terms.
	RewriteMethod_TOP_TERMS_BLENDED_FREQS RewriteMethod = 3
	// This method changes the original query to a BooleanQuery, containing a SHOULD clause and TermQuery for each
	// matching term. Assigns each matching document a relevance score equal to the boost parameter. The final
	// BooleanQuery query only includes Term queries for the top N (specified separately) terms.
	RewriteMethod_TOP_TERMS_BOOST RewriteMethod = 4
	// This method changes the original query to a BooleanQuery, containing a SHOULD clause and TermQuery for each
	// matching term. Calculates a relevance score for each matching document. The final BooleanQuery query only
	// includes Term queries for the top N (specified separately) scoring terms.
	RewriteMethod_TOP_TERMS RewriteMethod = 5
)

func (RewriteMethod) Descriptor added in v0.18.0 

func (RewriteMethod) Descriptor() protoreflect.EnumDescriptor

func (RewriteMethod) Enum added in v0.18.0 

func (x RewriteMethod) Enum() *RewriteMethod

func (RewriteMethod) EnumDescriptor deprecated added in v0.18.0 

func (RewriteMethod) EnumDescriptor() ([]byte, []int)

Deprecated: Use RewriteMethod.Descriptor instead.

func (RewriteMethod) Number added in v0.18.0 

func (x RewriteMethod) Number() protoreflect.EnumNumber

func (RewriteMethod) String added in v0.18.0 

func (x RewriteMethod) String() string

func (RewriteMethod) Type added in v0.18.0 

func (RewriteMethod) Type() protoreflect.EnumType

type RuntimeField added in v0.37.0 

type RuntimeField struct {

	// Script defining this field's values
	Script *Script `protobuf:"bytes,1,opt,name=script,proto3" json:"script,omitempty"`
	// Runtime field's name. Must be different from registered fields and any other runtime fields.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Runtime field used during search

func (*RuntimeField) Descriptor deprecated added in v0.37.0 

func (*RuntimeField) Descriptor() ([]byte, []int)

Deprecated: Use RuntimeField.ProtoReflect.Descriptor instead.

func (*RuntimeField) GetName added in v0.37.0 

func (x *RuntimeField) GetName() string

func (*RuntimeField) GetScript added in v0.37.0 

func (x *RuntimeField) GetScript() *Script

func (*RuntimeField) ProtoMessage added in v0.37.0 

func (*RuntimeField) ProtoMessage()

func (*RuntimeField) ProtoReflect added in v0.37.0 

func (x *RuntimeField) ProtoReflect() protoreflect.Message

func (*RuntimeField) Reset added in v0.37.0 

func (x *RuntimeField) Reset()

func (*RuntimeField) String added in v0.37.0 

func (x *RuntimeField) String() string

type Script 

type Script struct {

	// Script language
	Lang string `protobuf:"bytes,1,opt,name=lang,proto3" json:"lang,omitempty"`
	// Script source
	Source string `protobuf:"bytes,2,opt,name=source,proto3" json:"source,omitempty"`
	// Parameters passed into script execution
	Params map[string]*Script_ParamValue `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

Definition of user-defined script

func (*Script) Descriptor deprecated 

func (*Script) Descriptor() ([]byte, []int)

Deprecated: Use Script.ProtoReflect.Descriptor instead.

func (*Script) GetLang 

func (x *Script) GetLang() string

func (*Script) GetParams 

func (x *Script) GetParams() map[string]*Script_ParamValue

func (*Script) GetSource 

func (x *Script) GetSource() string

func (*Script) ProtoMessage 

func (*Script) ProtoMessage()

func (*Script) ProtoReflect 

func (x *Script) ProtoReflect() protoreflect.Message

func (*Script) Reset 

func (x *Script) Reset()

func (*Script) String 

func (x *Script) String() string

type Script_ParamFloatVectorValue 

type Script_ParamFloatVectorValue struct {

	// Float vector value
	Values []float32 `protobuf:"fixed32,1,rep,packed,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

Float vector parameter value

func (*Script_ParamFloatVectorValue) Descriptor deprecated 

func (*Script_ParamFloatVectorValue) Descriptor() ([]byte, []int)

Deprecated: Use Script_ParamFloatVectorValue.ProtoReflect.Descriptor instead.

func (*Script_ParamFloatVectorValue) GetValues 

func (x *Script_ParamFloatVectorValue) GetValues() []float32

func (*Script_ParamFloatVectorValue) ProtoMessage 

func (*Script_ParamFloatVectorValue) ProtoMessage()

func (*Script_ParamFloatVectorValue) ProtoReflect 

func (x *Script_ParamFloatVectorValue) ProtoReflect() protoreflect.Message

func (*Script_ParamFloatVectorValue) Reset 

func (x *Script_ParamFloatVectorValue) Reset()

func (*Script_ParamFloatVectorValue) String 

func (x *Script_ParamFloatVectorValue) String() string

type Script_ParamListValue 

type Script_ParamListValue struct {

	// Parameter values list
	Values []*Script_ParamValue `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

List parameter value

func (*Script_ParamListValue) Descriptor deprecated 

func (*Script_ParamListValue) Descriptor() ([]byte, []int)

Deprecated: Use Script_ParamListValue.ProtoReflect.Descriptor instead.

func (*Script_ParamListValue) GetValues 

func (x *Script_ParamListValue) GetValues() []*Script_ParamValue

func (*Script_ParamListValue) ProtoMessage 

func (*Script_ParamListValue) ProtoMessage()

func (*Script_ParamListValue) ProtoReflect 

func (x *Script_ParamListValue) ProtoReflect() protoreflect.Message

func (*Script_ParamListValue) Reset 

func (x *Script_ParamListValue) Reset()

func (*Script_ParamListValue) String 

func (x *Script_ParamListValue) String() string

type Script_ParamNullValue 

type Script_ParamNullValue int32

Null parameter value 

const (
	Script_NULL_VALUE Script_ParamNullValue = 0
)

func (Script_ParamNullValue) Descriptor 

func (Script_ParamNullValue) Descriptor() protoreflect.EnumDescriptor

func (Script_ParamNullValue) Enum 

func (x Script_ParamNullValue) Enum() *Script_ParamNullValue

func (Script_ParamNullValue) EnumDescriptor deprecated 

func (Script_ParamNullValue) EnumDescriptor() ([]byte, []int)

Deprecated: Use Script_ParamNullValue.Descriptor instead.

func (Script_ParamNullValue) Number 

func (x Script_ParamNullValue) Number() protoreflect.EnumNumber

func (Script_ParamNullValue) String 

func (x Script_ParamNullValue) String() string

func (Script_ParamNullValue) Type 

func (Script_ParamNullValue) Type() protoreflect.EnumType

type Script_ParamStructValue 

type Script_ParamStructValue struct {

	// Parameter values map
	Fields map[string]*Script_ParamValue `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

Map parameter value

func (*Script_ParamStructValue) Descriptor deprecated 

func (*Script_ParamStructValue) Descriptor() ([]byte, []int)

Deprecated: Use Script_ParamStructValue.ProtoReflect.Descriptor instead.

func (*Script_ParamStructValue) GetFields 

func (x *Script_ParamStructValue) GetFields() map[string]*Script_ParamValue

func (*Script_ParamStructValue) ProtoMessage 

func (*Script_ParamStructValue) ProtoMessage()

func (*Script_ParamStructValue) ProtoReflect 

func (x *Script_ParamStructValue) ProtoReflect() protoreflect.Message

func (*Script_ParamStructValue) Reset 

func (x *Script_ParamStructValue) Reset()

func (*Script_ParamStructValue) String 

func (x *Script_ParamStructValue) String() string

type Script_ParamValue 

type Script_ParamValue struct {

	// Types that are assignable to ParamValues:
	//
	//	*Script_ParamValue_TextValue
	//	*Script_ParamValue_BooleanValue
	//	*Script_ParamValue_IntValue
	//	*Script_ParamValue_LongValue
	//	*Script_ParamValue_FloatValue
	//	*Script_ParamValue_DoubleValue
	//	*Script_ParamValue_NullValue
	//	*Script_ParamValue_ListValue
	//	*Script_ParamValue_StructValue
	//	*Script_ParamValue_FloatVectorValue
	ParamValues isScript_ParamValue_ParamValues `protobuf_oneof:"ParamValues"`
	// contains filtered or unexported fields
}

Script parameter entry

func (*Script_ParamValue) Descriptor deprecated 

func (*Script_ParamValue) Descriptor() ([]byte, []int)

Deprecated: Use Script_ParamValue.ProtoReflect.Descriptor instead.

func (*Script_ParamValue) GetBooleanValue 

func (x *Script_ParamValue) GetBooleanValue() bool

func (*Script_ParamValue) GetDoubleValue 

func (x *Script_ParamValue) GetDoubleValue() float64

func (*Script_ParamValue) GetFloatValue 

func (x *Script_ParamValue) GetFloatValue() float32

func (*Script_ParamValue) GetFloatVectorValue 

func (x *Script_ParamValue) GetFloatVectorValue() *Script_ParamFloatVectorValue

func (*Script_ParamValue) GetIntValue 

func (x *Script_ParamValue) GetIntValue() int32

func (*Script_ParamValue) GetListValue 

func (x *Script_ParamValue) GetListValue() *Script_ParamListValue

func (*Script_ParamValue) GetLongValue 

func (x *Script_ParamValue) GetLongValue() int64

func (*Script_ParamValue) GetNullValue 

func (x *Script_ParamValue) GetNullValue() Script_ParamNullValue

func (*Script_ParamValue) GetParamValues 

func (m *Script_ParamValue) GetParamValues() isScript_ParamValue_ParamValues

func (*Script_ParamValue) GetStructValue 

func (x *Script_ParamValue) GetStructValue() *Script_ParamStructValue

func (*Script_ParamValue) GetTextValue 

func (x *Script_ParamValue) GetTextValue() string

func (*Script_ParamValue) ProtoMessage 

func (*Script_ParamValue) ProtoMessage()

func (*Script_ParamValue) ProtoReflect 

func (x *Script_ParamValue) ProtoReflect() protoreflect.Message

func (*Script_ParamValue) Reset 

func (x *Script_ParamValue) Reset()

func (*Script_ParamValue) String 

func (x *Script_ParamValue) String() string

type Script_ParamValue_BooleanValue 

type Script_ParamValue_BooleanValue struct {
	BooleanValue bool `protobuf:"varint,2,opt,name=booleanValue,proto3,oneof"`
}

type Script_ParamValue_DoubleValue 

type Script_ParamValue_DoubleValue struct {
	DoubleValue float64 `protobuf:"fixed64,6,opt,name=doubleValue,proto3,oneof"`
}

type Script_ParamValue_FloatValue 

type Script_ParamValue_FloatValue struct {
	FloatValue float32 `protobuf:"fixed32,5,opt,name=floatValue,proto3,oneof"`
}

type Script_ParamValue_FloatVectorValue 

type Script_ParamValue_FloatVectorValue struct {
	FloatVectorValue *Script_ParamFloatVectorValue `protobuf:"bytes,10,opt,name=floatVectorValue,proto3,oneof"`
}

type Script_ParamValue_IntValue 

type Script_ParamValue_IntValue struct {
	IntValue int32 `protobuf:"varint,3,opt,name=intValue,proto3,oneof"`
}

type Script_ParamValue_ListValue 

type Script_ParamValue_ListValue struct {
	ListValue *Script_ParamListValue `protobuf:"bytes,8,opt,name=listValue,proto3,oneof"`
}

type Script_ParamValue_LongValue 

type Script_ParamValue_LongValue struct {
	LongValue int64 `protobuf:"varint,4,opt,name=longValue,proto3,oneof"`
}

type Script_ParamValue_NullValue 

type Script_ParamValue_NullValue struct {
	NullValue Script_ParamNullValue `protobuf:"varint,7,opt,name=nullValue,proto3,enum=luceneserver.Script_ParamNullValue,oneof"`
}

type Script_ParamValue_StructValue 

type Script_ParamValue_StructValue struct {
	StructValue *Script_ParamStructValue `protobuf:"bytes,9,opt,name=structValue,proto3,oneof"`
}

type Script_ParamValue_TextValue 

type Script_ParamValue_TextValue struct {
	TextValue string `protobuf:"bytes,1,opt,name=textValue,proto3,oneof"`
}

type SearchRequest 

type SearchRequest struct {

	// Index to search against
	IndexName string `protobuf:"bytes,1,opt,name=indexName,proto3" json:"indexName,omitempty"`
	// Which hit to start from (for pagination); default: 0
	StartHit int32 `protobuf:"varint,2,opt,name=startHit,proto3" json:"startHit,omitempty"`
	// How many top hits to retrieve; default: 10. It limits the hits returned, starting from index 0.
	// For pagination: set it to startHit + window_size.
	TopHits int32 `protobuf:"varint,3,opt,name=topHits,proto3" json:"topHits,omitempty"`
	// Maximum number of seconds spent on each collection phase; note that for
	// multi-pass searches (e.g. query-time grouping), this timeout applies to each phase.
	TimeoutSec float64 `protobuf:"fixed64,4,opt,name=timeoutSec,proto3" json:"timeoutSec,omitempty"`
	// Which fields to retrieve
	RetrieveFields []string `protobuf:"bytes,5,rep,name=retrieveFields,proto3" json:"retrieveFields,omitempty"`
	// Query text to parse using the specified QueryParser. If query is provided, this is ignored.
	QueryText string `protobuf:"bytes,6,opt,name=queryText,proto3" json:"queryText,omitempty"`
	// Defines virtual fields (named dynamic expressions) for this query
	VirtualFields []*VirtualField `protobuf:"bytes,7,rep,name=virtualFields,proto3" json:"virtualFields,omitempty"`
	// Full query to execute
	Query *Query `protobuf:"bytes,8,opt,name=query,proto3" json:"query,omitempty"`
	// Sort hits by field (default is by relevance)
	QuerySort *QuerySortField `protobuf:"bytes,9,opt,name=querySort,proto3" json:"querySort,omitempty"`
	// Types that are assignable to Searcher:
	//
	//	*SearchRequest_IndexGen
	//	*SearchRequest_Version
	//	*SearchRequest_Snapshot
	Searcher isSearchRequest_Searcher `protobuf_oneof:"Searcher"`
	// By default we count hits accurately up to 1000. This makes sure that we don't spend most time on
	// computing hit counts.
	TotalHitsThreshold int32 `protobuf:"varint,13,opt,name=totalHitsThreshold,proto3" json:"totalHitsThreshold,omitempty"`
	// Which facets to retrieve
	Facets []*Facet `protobuf:"bytes,14,rep,name=facets,proto3" json:"facets,omitempty"`
	// Any custom tasks that should be performed on top documents after ranking
	FetchTasks []*FetchTask `protobuf:"bytes,15,rep,name=fetchTasks,proto3" json:"fetchTasks,omitempty"`
	// Should partial result be a failure condition. Applies when a search request times out. If false, the top
	// documents ranking at the point of timeout are used and the request continues. Also, hitTimeout is set to
	// true in the response.
	DisallowPartialResults bool `protobuf:"varint,16,opt,name=disallowPartialResults,proto3" json:"disallowPartialResults,omitempty"`
	// Nested path we want to query by if we want to query child documents
	QueryNestedPath string `protobuf:"bytes,17,opt,name=queryNestedPath,proto3" json:"queryNestedPath,omitempty"`
	// Rescorers which are executed in-order after the first pass
	Rescorers []*Rescorer `protobuf:"bytes,18,rep,name=rescorers,proto3" json:"rescorers,omitempty"`
	// If detailed request execution profiling should be included in the response
	Profile bool `protobuf:"varint,19,opt,name=profile,proto3" json:"profile,omitempty"`
	// Check the search timeout condition after each collection of n documents in a segment.
	// If 0, timeout is only checked on the segment boundary.
	TimeoutCheckEvery int32 `protobuf:"varint,20,opt,name=timeoutCheckEvery,proto3" json:"timeoutCheckEvery,omitempty"`
	// Additional document collectors. Provides support for operations such as aggregation.
	Collectors map[string]*Collector `` /* 162-byte string literal not displayed */
	// Stop document collection in search phase after this many documents, 0 for unlimited
	TerminateAfter int32 `protobuf:"varint,22,opt,name=terminateAfter,proto3" json:"terminateAfter,omitempty"`
	// Set gRPC compression codec to use for response message. If value is unset or invalid, falls back to
	// uncompressed. Valid codecs: identity, gzip, lz4
	ResponseCompression string `protobuf:"bytes,23,opt,name=responseCompression,proto3" json:"responseCompression,omitempty"`
	// Specify how to highlight matched text
	Highlight *Highlight `protobuf:"bytes,24,opt,name=highlight,proto3" json:"highlight,omitempty"`
	// If Lucene explanation should be included in the response
	Explain bool `protobuf:"varint,25,opt,name=explain,proto3" json:"explain,omitempty"`
	// Search nested object fields for each hit
	InnerHits map[string]*InnerHit `` /* 177-byte string literal not displayed */
	// Defines runtime fields for this query
	RuntimeFields []*RuntimeField `protobuf:"bytes,27,rep,name=runtimeFields,proto3" json:"runtimeFields,omitempty"`
	// Stop document collection in search phase after this many recalled documents, after terminateAfter docs
	// will be counted but not scored upto terminateAfterMaxRecallCount
	TerminateAfterMaxRecallCount int32 `protobuf:"varint,28,opt,name=terminateAfterMaxRecallCount,proto3" json:"terminateAfterMaxRecallCount,omitempty"`
	// Any custom logging that should log hits after ranking
	LoggingHits *LoggingHits `protobuf:"bytes,29,opt,name=loggingHits,proto3" json:"loggingHits,omitempty"`
	// Keeps tracks of last hit for search after
	SearchAfter *LastHitInfo `protobuf:"bytes,30,opt,name=searchAfter,proto3" json:"searchAfter,omitempty"`
	// Request kNN vector search queries, results will be combined with the standard query (if provided) using
	// the boolean query SHOULD logic
	Knn []*KnnQuery `protobuf:"bytes,31,rep,name=knn,proto3" json:"knn,omitempty"`
	// contains filtered or unexported fields
}

Search query request

func (*SearchRequest) Descriptor deprecated 

func (*SearchRequest) Descriptor() ([]byte, []int)

Deprecated: Use SearchRequest.ProtoReflect.Descriptor instead.

func (*SearchRequest) GetCollectors 

func (x *SearchRequest) GetCollectors() map[string]*Collector

func (*SearchRequest) GetDisallowPartialResults 

func (x *SearchRequest) GetDisallowPartialResults() bool

func (*SearchRequest) GetExplain added in v0.23.0 

func (x *SearchRequest) GetExplain() bool

func (*SearchRequest) GetFacets 

func (x *SearchRequest) GetFacets() []*Facet

func (*SearchRequest) GetFetchTasks 

func (x *SearchRequest) GetFetchTasks() []*FetchTask

func (*SearchRequest) GetHighlight added in v0.14.0 

func (x *SearchRequest) GetHighlight() *Highlight

func (*SearchRequest) GetIndexGen 

func (x *SearchRequest) GetIndexGen() int64

func (*SearchRequest) GetIndexName 

func (x *SearchRequest) GetIndexName() string

func (*SearchRequest) GetInnerHits added in v0.25.0 

func (x *SearchRequest) GetInnerHits() map[string]*InnerHit

func (*SearchRequest) GetKnn 

func (x *SearchRequest) GetKnn() []*KnnQuery

func (*SearchRequest) GetLoggingHits added in v0.40.0 

func (x *SearchRequest) GetLoggingHits() *LoggingHits

func (*SearchRequest) GetProfile 

func (x *SearchRequest) GetProfile() bool

func (*SearchRequest) GetQuery 

func (x *SearchRequest) GetQuery() *Query

func (*SearchRequest) GetQueryNestedPath 

func (x *SearchRequest) GetQueryNestedPath() string

func (*SearchRequest) GetQuerySort 

func (x *SearchRequest) GetQuerySort() *QuerySortField

func (*SearchRequest) GetQueryText 

func (x *SearchRequest) GetQueryText() string

func (*SearchRequest) GetRescorers 

func (x *SearchRequest) GetRescorers() []*Rescorer

func (*SearchRequest) GetResponseCompression added in v0.10.3 

func (x *SearchRequest) GetResponseCompression() string

func (*SearchRequest) GetRetrieveFields 

func (x *SearchRequest) GetRetrieveFields() []string

func (*SearchRequest) GetRuntimeFields added in v0.37.0 

func (x *SearchRequest) GetRuntimeFields() []*RuntimeField

func (*SearchRequest) GetSearchAfter added in v0.40.0 

func (x *SearchRequest) GetSearchAfter() *LastHitInfo

func (*SearchRequest) GetSearcher 

func (m *SearchRequest) GetSearcher() isSearchRequest_Searcher

func (*SearchRequest) GetSnapshot 

func (x *SearchRequest) GetSnapshot() string

func (*SearchRequest) GetStartHit 

func (x *SearchRequest) GetStartHit() int32

func (*SearchRequest) GetTerminateAfter 

func (x *SearchRequest) GetTerminateAfter() int32

func (*SearchRequest) GetTerminateAfterMaxRecallCount added in v0.40.0 

func (x *SearchRequest) GetTerminateAfterMaxRecallCount() int32

func (*SearchRequest) GetTimeoutCheckEvery 

func (x *SearchRequest) GetTimeoutCheckEvery() int32

func (*SearchRequest) GetTimeoutSec 

func (x *SearchRequest) GetTimeoutSec() float64

func (*SearchRequest) GetTopHits 

func (x *SearchRequest) GetTopHits() int32

func (*SearchRequest) GetTotalHitsThreshold 

func (x *SearchRequest) GetTotalHitsThreshold() int32

func (*SearchRequest) GetVersion 

func (x *SearchRequest) GetVersion() int64

func (*SearchRequest) GetVirtualFields 

func (x *SearchRequest) GetVirtualFields() []*VirtualField

func (*SearchRequest) ProtoMessage 

func (*SearchRequest) ProtoMessage()

func (*SearchRequest) ProtoReflect 

func (x *SearchRequest) ProtoReflect() protoreflect.Message

func (*SearchRequest) Reset 

func (x *SearchRequest) Reset()

func (*SearchRequest) String 

func (x *SearchRequest) String() string

type SearchRequest_IndexGen 

type SearchRequest_IndexGen struct {
	// Search a generation previously returned by an indexing operation such as #addDocument.
	// Use this to search a non-committed (near-real-time) view of the index.
	IndexGen int64 `protobuf:"varint,10,opt,name=indexGen,proto3,oneof"`
}

type SearchRequest_Snapshot 

type SearchRequest_Snapshot struct {
	// Search a snapshot previously created with #createSnapshot
	Snapshot string `protobuf:"bytes,12,opt,name=snapshot,proto3,oneof"`
}

type SearchRequest_Version 

type SearchRequest_Version struct {
	// Search a specific searcher version. This is typically used by follow-on searches
	// (e.g., user clicks next page, drills down, or changes sort, etc.) to get the same searcher used by
	// the original search.
	Version int64 `protobuf:"varint,11,opt,name=version,proto3,oneof"`
}

type SearchResponse 

type SearchResponse struct {

	// Query diagnostics
	Diagnostics *SearchResponse_Diagnostics `protobuf:"bytes,1,opt,name=diagnostics,proto3" json:"diagnostics,omitempty"`
	// Set to true if search times out and a degraded response is returned
	HitTimeout bool `protobuf:"varint,2,opt,name=hitTimeout,proto3" json:"hitTimeout,omitempty"`
	// Total hits for the query
	TotalHits *TotalHits `protobuf:"bytes,3,opt,name=totalHits,proto3" json:"totalHits,omitempty"`
	// Ranked top hits
	Hits []*SearchResponse_Hit `protobuf:"bytes,4,rep,name=hits,proto3" json:"hits,omitempty"`
	// State for use in subsequent searches (search after)
	SearchState *SearchResponse_SearchState `protobuf:"bytes,5,opt,name=searchState,proto3" json:"searchState,omitempty"`
	// Counts or aggregates for a single dimension
	FacetResult []*FacetResult `protobuf:"bytes,6,rep,name=facetResult,proto3" json:"facetResult,omitempty"`
	// Detailed stats returned when profile=true in request
	ProfileResult *ProfileResult `protobuf:"bytes,7,opt,name=profileResult,proto3" json:"profileResult,omitempty"`
	// Results from any additional document collectors
	CollectorResults map[string]*CollectorResult `` /* 173-byte string literal not displayed */
	// If this query hit the terminateAfter threshold specified in the request
	TerminatedEarly bool `protobuf:"varint,9,opt,name=terminatedEarly,proto3" json:"terminatedEarly,omitempty"`
	// contains filtered or unexported fields
}

Response to a search request

func (*SearchResponse) Descriptor deprecated 

func (*SearchResponse) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse.ProtoReflect.Descriptor instead.

func (*SearchResponse) GetCollectorResults 

func (x *SearchResponse) GetCollectorResults() map[string]*CollectorResult

func (*SearchResponse) GetDiagnostics 

func (x *SearchResponse) GetDiagnostics() *SearchResponse_Diagnostics

func (*SearchResponse) GetFacetResult 

func (x *SearchResponse) GetFacetResult() []*FacetResult

func (*SearchResponse) GetHitTimeout 

func (x *SearchResponse) GetHitTimeout() bool

func (*SearchResponse) GetHits 

func (x *SearchResponse) GetHits() []*SearchResponse_Hit

func (*SearchResponse) GetProfileResult 

func (x *SearchResponse) GetProfileResult() *ProfileResult

func (*SearchResponse) GetSearchState 

func (x *SearchResponse) GetSearchState() *SearchResponse_SearchState

func (*SearchResponse) GetTerminatedEarly 

func (x *SearchResponse) GetTerminatedEarly() bool

func (*SearchResponse) GetTotalHits 

func (x *SearchResponse) GetTotalHits() *TotalHits

func (*SearchResponse) ProtoMessage 

func (*SearchResponse) ProtoMessage()

func (*SearchResponse) ProtoReflect 

func (x *SearchResponse) ProtoReflect() protoreflect.Message

func (*SearchResponse) Reset 

func (x *SearchResponse) Reset()

func (*SearchResponse) String 

func (x *SearchResponse) String() string

type SearchResponse_Diagnostics 

type SearchResponse_Diagnostics struct {

	// Query debug has been moved to ProfileResult
	//
	// Deprecated: Do not use.
	ParsedQuery string `protobuf:"bytes,1,opt,name=parsedQuery,proto3" json:"parsedQuery,omitempty"`
	// Deprecated: Do not use.
	RewrittenQuery string `protobuf:"bytes,2,opt,name=rewrittenQuery,proto3" json:"rewrittenQuery,omitempty"`
	// Deprecated: Do not use.
	DrillDownQuery string `protobuf:"bytes,3,opt,name=drillDownQuery,proto3" json:"drillDownQuery,omitempty"`
	// Time for initial recall and ranking
	FirstPassSearchTimeMs float64 `protobuf:"fixed64,4,opt,name=firstPassSearchTimeMs,proto3" json:"firstPassSearchTimeMs,omitempty"`
	// Time for highlighting
	HighlightTimeMs float64 `protobuf:"fixed64,5,opt,name=highlightTimeMs,proto3" json:"highlightTimeMs,omitempty"`
	// Time to fetch fields and perform other fetch tasks
	GetFieldsTimeMs float64 `protobuf:"fixed64,6,opt,name=getFieldsTimeMs,proto3" json:"getFieldsTimeMs,omitempty"`
	// Time to open a new snapshot searcher
	NewSnapshotSearcherOpenMs float64 `protobuf:"fixed64,7,opt,name=newSnapshotSearcherOpenMs,proto3" json:"newSnapshotSearcherOpenMs,omitempty"`
	// Time waiting for nrt replication
	NrtWaitTimeMs float64 `protobuf:"fixed64,8,opt,name=nrtWaitTimeMs,proto3" json:"nrtWaitTimeMs,omitempty"`
	// Time to execute facets
	FacetTimeMs map[string]float64 `` /* 165-byte string literal not displayed */
	// Time to execute rescorers
	RescoreTimeMs float64 `protobuf:"fixed64,10,opt,name=rescoreTimeMs,proto3" json:"rescoreTimeMs,omitempty"`
	// Time to execute each rescorer
	RescorersTimeMs map[string]float64 `` /* 174-byte string literal not displayed */
	// Inner hits diagnostics
	InnerHitsDiagnostics map[string]*SearchResponse_Diagnostics `` /* 182-byte string literal not displayed */
	// Diagnostic info related to kNN vector search queries
	VectorDiagnostics []*SearchResponse_Diagnostics_VectorDiagnostics `protobuf:"bytes,13,rep,name=vectorDiagnostics,proto3" json:"vectorDiagnostics,omitempty"`
	// Amount of gRPC request deadline remaining at the start of search processing
	InitialDeadlineMs float64 `protobuf:"fixed64,14,opt,name=initialDeadlineMs,proto3" json:"initialDeadlineMs,omitempty"`
	// Time for logging hits
	LoggingHitsTimeMs float64 `protobuf:"fixed64,15,opt,name=loggingHitsTimeMs,proto3" json:"loggingHitsTimeMs,omitempty"`
	// contains filtered or unexported fields
}

func (*SearchResponse_Diagnostics) Descriptor deprecated 

func (*SearchResponse_Diagnostics) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_Diagnostics.ProtoReflect.Descriptor instead.

func (*SearchResponse_Diagnostics) GetDrillDownQuery deprecated 

func (x *SearchResponse_Diagnostics) GetDrillDownQuery() string

Deprecated: Do not use.

func (*SearchResponse_Diagnostics) GetFacetTimeMs 

func (x *SearchResponse_Diagnostics) GetFacetTimeMs() map[string]float64

func (*SearchResponse_Diagnostics) GetFirstPassSearchTimeMs 

func (x *SearchResponse_Diagnostics) GetFirstPassSearchTimeMs() float64

func (*SearchResponse_Diagnostics) GetGetFieldsTimeMs 

func (x *SearchResponse_Diagnostics) GetGetFieldsTimeMs() float64

func (*SearchResponse_Diagnostics) GetHighlightTimeMs 

func (x *SearchResponse_Diagnostics) GetHighlightTimeMs() float64

func (*SearchResponse_Diagnostics) GetInitialDeadlineMs 

func (x *SearchResponse_Diagnostics) GetInitialDeadlineMs() float64

func (*SearchResponse_Diagnostics) GetInnerHitsDiagnostics added in v0.25.0 

func (x *SearchResponse_Diagnostics) GetInnerHitsDiagnostics() map[string]*SearchResponse_Diagnostics

func (*SearchResponse_Diagnostics) GetLoggingHitsTimeMs added in v0.41.0 

func (x *SearchResponse_Diagnostics) GetLoggingHitsTimeMs() float64

func (*SearchResponse_Diagnostics) GetNewSnapshotSearcherOpenMs 

func (x *SearchResponse_Diagnostics) GetNewSnapshotSearcherOpenMs() float64

func (*SearchResponse_Diagnostics) GetNrtWaitTimeMs 

func (x *SearchResponse_Diagnostics) GetNrtWaitTimeMs() float64

func (*SearchResponse_Diagnostics) GetParsedQuery deprecated 

func (x *SearchResponse_Diagnostics) GetParsedQuery() string

Deprecated: Do not use.

func (*SearchResponse_Diagnostics) GetRescoreTimeMs 

func (x *SearchResponse_Diagnostics) GetRescoreTimeMs() float64

func (*SearchResponse_Diagnostics) GetRescorersTimeMs 

func (x *SearchResponse_Diagnostics) GetRescorersTimeMs() map[string]float64

func (*SearchResponse_Diagnostics) GetRewrittenQuery deprecated 

func (x *SearchResponse_Diagnostics) GetRewrittenQuery() string

Deprecated: Do not use.

func (*SearchResponse_Diagnostics) GetVectorDiagnostics 

func (x *SearchResponse_Diagnostics) GetVectorDiagnostics() []*SearchResponse_Diagnostics_VectorDiagnostics

func (*SearchResponse_Diagnostics) ProtoMessage 

func (*SearchResponse_Diagnostics) ProtoMessage()

func (*SearchResponse_Diagnostics) ProtoReflect 

func (x *SearchResponse_Diagnostics) ProtoReflect() protoreflect.Message

func (*SearchResponse_Diagnostics) Reset 

func (x *SearchResponse_Diagnostics) Reset()

func (*SearchResponse_Diagnostics) String 

func (x *SearchResponse_Diagnostics) String() string

type SearchResponse_Diagnostics_VectorDiagnostics 

type SearchResponse_Diagnostics_VectorDiagnostics struct {

	// Time to do kNN search
	SearchTimeMs float64 `protobuf:"fixed64,1,opt,name=searchTimeMs,proto3" json:"searchTimeMs,omitempty"`
	// Total hits from kNN execution
	TotalHits *TotalHits `protobuf:"bytes,2,opt,name=totalHits,proto3" json:"totalHits,omitempty"`
	// contains filtered or unexported fields
}

Diagnostic info related kNN vector search queries

func (*SearchResponse_Diagnostics_VectorDiagnostics) Descriptor deprecated 

func (*SearchResponse_Diagnostics_VectorDiagnostics) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_Diagnostics_VectorDiagnostics.ProtoReflect.Descriptor instead.

func (*SearchResponse_Diagnostics_VectorDiagnostics) GetSearchTimeMs 

func (x *SearchResponse_Diagnostics_VectorDiagnostics) GetSearchTimeMs() float64

func (*SearchResponse_Diagnostics_VectorDiagnostics) GetTotalHits 

func (x *SearchResponse_Diagnostics_VectorDiagnostics) GetTotalHits() *TotalHits

func (*SearchResponse_Diagnostics_VectorDiagnostics) ProtoMessage 

func (*SearchResponse_Diagnostics_VectorDiagnostics) ProtoMessage()

func (*SearchResponse_Diagnostics_VectorDiagnostics) ProtoReflect 

func (x *SearchResponse_Diagnostics_VectorDiagnostics) ProtoReflect() protoreflect.Message

func (*SearchResponse_Diagnostics_VectorDiagnostics) Reset 

func (x *SearchResponse_Diagnostics_VectorDiagnostics) Reset()

func (*SearchResponse_Diagnostics_VectorDiagnostics) String 

func (x *SearchResponse_Diagnostics_VectorDiagnostics) String() string

type SearchResponse_Hit 

type SearchResponse_Hit struct {

	// Lucene document id
	LuceneDocId int32 `protobuf:"varint,1,opt,name=luceneDocId,proto3" json:"luceneDocId,omitempty"`
	// Document score
	Score float64 `protobuf:"fixed64,2,opt,name=score,proto3" json:"score,omitempty"`
	// Retrieved field data
	Fields map[string]*SearchResponse_Hit_CompositeFieldValue `` /* 153-byte string literal not displayed */
	// When using query sorting, sorted field names to values
	SortedFields map[string]*SearchResponse_Hit_CompositeFieldValue `` /* 165-byte string literal not displayed */
	// Field name to highlighted text fragments
	Highlights map[string]*SearchResponse_Hit_Highlights `` /* 161-byte string literal not displayed */
	// Lucene explanation of the hit
	Explain string `protobuf:"bytes,6,opt,name=explain,proto3" json:"explain,omitempty"`
	// InnerHits for each hit
	InnerHits map[string]*HitsResult `` /* 159-byte string literal not displayed */
	// contains filtered or unexported fields
}

Message for query document hit

func (*SearchResponse_Hit) Descriptor deprecated 

func (*SearchResponse_Hit) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_Hit.ProtoReflect.Descriptor instead.

func (*SearchResponse_Hit) GetExplain added in v0.23.0 

func (x *SearchResponse_Hit) GetExplain() string

func (*SearchResponse_Hit) GetFields 

func (x *SearchResponse_Hit) GetFields() map[string]*SearchResponse_Hit_CompositeFieldValue

func (*SearchResponse_Hit) GetHighlights added in v0.14.0 

func (x *SearchResponse_Hit) GetHighlights() map[string]*SearchResponse_Hit_Highlights

func (*SearchResponse_Hit) GetInnerHits added in v0.25.0 

func (x *SearchResponse_Hit) GetInnerHits() map[string]*HitsResult

func (*SearchResponse_Hit) GetLuceneDocId 

func (x *SearchResponse_Hit) GetLuceneDocId() int32

func (*SearchResponse_Hit) GetScore 

func (x *SearchResponse_Hit) GetScore() float64

func (*SearchResponse_Hit) GetSortedFields 

func (x *SearchResponse_Hit) GetSortedFields() map[string]*SearchResponse_Hit_CompositeFieldValue

func (*SearchResponse_Hit) ProtoMessage 

func (*SearchResponse_Hit) ProtoMessage()

func (*SearchResponse_Hit) ProtoReflect 

func (x *SearchResponse_Hit) ProtoReflect() protoreflect.Message

func (*SearchResponse_Hit) Reset 

func (x *SearchResponse_Hit) Reset()

func (*SearchResponse_Hit) String 

func (x *SearchResponse_Hit) String() string

type SearchResponse_Hit_CompositeFieldValue 

type SearchResponse_Hit_CompositeFieldValue struct {

	// Field values
	FieldValue []*SearchResponse_Hit_FieldValue `protobuf:"bytes,3,rep,name=fieldValue,proto3" json:"fieldValue,omitempty"`
	// contains filtered or unexported fields
}

Field with multiple values

func (*SearchResponse_Hit_CompositeFieldValue) Descriptor deprecated 

func (*SearchResponse_Hit_CompositeFieldValue) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_Hit_CompositeFieldValue.ProtoReflect.Descriptor instead.

func (*SearchResponse_Hit_CompositeFieldValue) GetFieldValue 

func (x *SearchResponse_Hit_CompositeFieldValue) GetFieldValue() []*SearchResponse_Hit_FieldValue

func (*SearchResponse_Hit_CompositeFieldValue) ProtoMessage 

func (*SearchResponse_Hit_CompositeFieldValue) ProtoMessage()

func (*SearchResponse_Hit_CompositeFieldValue) ProtoReflect 

func (x *SearchResponse_Hit_CompositeFieldValue) ProtoReflect() protoreflect.Message

func (*SearchResponse_Hit_CompositeFieldValue) Reset 

func (x *SearchResponse_Hit_CompositeFieldValue) Reset()

func (*SearchResponse_Hit_CompositeFieldValue) String 

func (x *SearchResponse_Hit_CompositeFieldValue) String() string

type SearchResponse_Hit_FieldValue 

type SearchResponse_Hit_FieldValue struct {

	// Types that are assignable to FieldValues:
	//
	//	*SearchResponse_Hit_FieldValue_TextValue
	//	*SearchResponse_Hit_FieldValue_BooleanValue
	//	*SearchResponse_Hit_FieldValue_IntValue
	//	*SearchResponse_Hit_FieldValue_LongValue
	//	*SearchResponse_Hit_FieldValue_FloatValue
	//	*SearchResponse_Hit_FieldValue_DoubleValue
	//	*SearchResponse_Hit_FieldValue_LatLngValue
	//	*SearchResponse_Hit_FieldValue_StructValue
	//	*SearchResponse_Hit_FieldValue_VectorValue
	//	*SearchResponse_Hit_FieldValue_ListValue
	FieldValues isSearchResponse_Hit_FieldValue_FieldValues `protobuf_oneof:"FieldValues"`
	// contains filtered or unexported fields
}

Field value for a hit

func (*SearchResponse_Hit_FieldValue) Descriptor deprecated 

func (*SearchResponse_Hit_FieldValue) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_Hit_FieldValue.ProtoReflect.Descriptor instead.

func (*SearchResponse_Hit_FieldValue) GetBooleanValue 

func (x *SearchResponse_Hit_FieldValue) GetBooleanValue() bool

func (*SearchResponse_Hit_FieldValue) GetDoubleValue 

func (x *SearchResponse_Hit_FieldValue) GetDoubleValue() float64

func (*SearchResponse_Hit_FieldValue) GetFieldValues 

func (m *SearchResponse_Hit_FieldValue) GetFieldValues() isSearchResponse_Hit_FieldValue_FieldValues

func (*SearchResponse_Hit_FieldValue) GetFloatValue 

func (x *SearchResponse_Hit_FieldValue) GetFloatValue() float32

func (*SearchResponse_Hit_FieldValue) GetIntValue 

func (x *SearchResponse_Hit_FieldValue) GetIntValue() int32

func (*SearchResponse_Hit_FieldValue) GetLatLngValue 

func (x *SearchResponse_Hit_FieldValue) GetLatLngValue() *latlng.LatLng

func (*SearchResponse_Hit_FieldValue) GetListValue added in v0.37.0 

func (x *SearchResponse_Hit_FieldValue) GetListValue() *structpb.ListValue

func (*SearchResponse_Hit_FieldValue) GetLongValue 

func (x *SearchResponse_Hit_FieldValue) GetLongValue() int64

func (*SearchResponse_Hit_FieldValue) GetStructValue 

func (x *SearchResponse_Hit_FieldValue) GetStructValue() *structpb.Struct

func (*SearchResponse_Hit_FieldValue) GetTextValue 

func (x *SearchResponse_Hit_FieldValue) GetTextValue() string

func (*SearchResponse_Hit_FieldValue) GetVectorValue added in v0.10.5 

func (x *SearchResponse_Hit_FieldValue) GetVectorValue() *SearchResponse_Hit_FieldValue_Vector

func (*SearchResponse_Hit_FieldValue) ProtoMessage 

func (*SearchResponse_Hit_FieldValue) ProtoMessage()

func (*SearchResponse_Hit_FieldValue) ProtoReflect 

func (x *SearchResponse_Hit_FieldValue) ProtoReflect() protoreflect.Message

func (*SearchResponse_Hit_FieldValue) Reset 

func (x *SearchResponse_Hit_FieldValue) Reset()

func (*SearchResponse_Hit_FieldValue) String 

func (x *SearchResponse_Hit_FieldValue) String() string

type SearchResponse_Hit_FieldValue_BooleanValue 

type SearchResponse_Hit_FieldValue_BooleanValue struct {
	// Value for BOOLEAN FieldType
	BooleanValue bool `protobuf:"varint,2,opt,name=booleanValue,proto3,oneof"`
}

type SearchResponse_Hit_FieldValue_DoubleValue 

type SearchResponse_Hit_FieldValue_DoubleValue struct {
	// Value for DOUBLE FieldType
	DoubleValue float64 `protobuf:"fixed64,6,opt,name=doubleValue,proto3,oneof"`
}

type SearchResponse_Hit_FieldValue_FloatValue 

type SearchResponse_Hit_FieldValue_FloatValue struct {
	// Value for FLOAT FieldType
	FloatValue float32 `protobuf:"fixed32,5,opt,name=floatValue,proto3,oneof"`
}

type SearchResponse_Hit_FieldValue_IntValue 

type SearchResponse_Hit_FieldValue_IntValue struct {
	// Value for INT FieldType
	IntValue int32 `protobuf:"varint,3,opt,name=intValue,proto3,oneof"`
}

type SearchResponse_Hit_FieldValue_LatLngValue 

type SearchResponse_Hit_FieldValue_LatLngValue struct {
	// Value for LAT_LON FieldType
	LatLngValue *latlng.LatLng `protobuf:"bytes,7,opt,name=latLngValue,proto3,oneof"`
}

type SearchResponse_Hit_FieldValue_ListValue added in v0.37.0 

type SearchResponse_Hit_FieldValue_ListValue struct {
	// List of values
	ListValue *structpb.ListValue `protobuf:"bytes,10,opt,name=listValue,proto3,oneof"`
}

type SearchResponse_Hit_FieldValue_LongValue 

type SearchResponse_Hit_FieldValue_LongValue struct {
	// Value for LONG and DATE_TIME (as milliseconds since epoch in UTC zone) FieldType
	LongValue int64 `protobuf:"varint,4,opt,name=longValue,proto3,oneof"`
}

type SearchResponse_Hit_FieldValue_StructValue 

type SearchResponse_Hit_FieldValue_StructValue struct {
	// Value for structured data
	StructValue *structpb.Struct `protobuf:"bytes,8,opt,name=structValue,proto3,oneof"`
}

type SearchResponse_Hit_FieldValue_TextValue 

type SearchResponse_Hit_FieldValue_TextValue struct {
	// Value for ATOM and TEXT FieldType
	TextValue string `protobuf:"bytes,1,opt,name=textValue,proto3,oneof"`
}

type SearchResponse_Hit_FieldValue_Vector added in v0.10.5 

type SearchResponse_Hit_FieldValue_Vector struct {

	// Float vector value
	Value []float32 `protobuf:"fixed32,1,rep,packed,name=value,proto3" json:"value,omitempty"`
	// Byte vector value
	BytesValue []byte `protobuf:"bytes,2,opt,name=bytes_value,json=bytesValue,proto3" json:"bytes_value,omitempty"`
	// contains filtered or unexported fields
}

func (*SearchResponse_Hit_FieldValue_Vector) Descriptor deprecated added in v0.10.5 

func (*SearchResponse_Hit_FieldValue_Vector) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_Hit_FieldValue_Vector.ProtoReflect.Descriptor instead.

func (*SearchResponse_Hit_FieldValue_Vector) GetBytesValue 

func (x *SearchResponse_Hit_FieldValue_Vector) GetBytesValue() []byte

func (*SearchResponse_Hit_FieldValue_Vector) GetValue added in v0.10.5 

func (x *SearchResponse_Hit_FieldValue_Vector) GetValue() []float32

func (*SearchResponse_Hit_FieldValue_Vector) ProtoMessage added in v0.10.5 

func (*SearchResponse_Hit_FieldValue_Vector) ProtoMessage()

func (*SearchResponse_Hit_FieldValue_Vector) ProtoReflect added in v0.10.5 

func (x *SearchResponse_Hit_FieldValue_Vector) ProtoReflect() protoreflect.Message

func (*SearchResponse_Hit_FieldValue_Vector) Reset added in v0.10.5 

func (x *SearchResponse_Hit_FieldValue_Vector) Reset()

func (*SearchResponse_Hit_FieldValue_Vector) String added in v0.10.5 

func (x *SearchResponse_Hit_FieldValue_Vector) String() string

type SearchResponse_Hit_FieldValue_VectorValue added in v0.10.5 

type SearchResponse_Hit_FieldValue_VectorValue struct {
	// Value for VECTOR FieldType
	VectorValue *SearchResponse_Hit_FieldValue_Vector `protobuf:"bytes,9,opt,name=vectorValue,proto3,oneof"`
}

type SearchResponse_Hit_Highlights added in v0.14.0 

type SearchResponse_Hit_Highlights struct {

	// Highlighted text fragments
	Fragments []string `protobuf:"bytes,1,rep,name=fragments,proto3" json:"fragments,omitempty"`
	// contains filtered or unexported fields
}

Highlighted text result

func (*SearchResponse_Hit_Highlights) Descriptor deprecated added in v0.14.0 

func (*SearchResponse_Hit_Highlights) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_Hit_Highlights.ProtoReflect.Descriptor instead.

func (*SearchResponse_Hit_Highlights) GetFragments added in v0.14.0 

func (x *SearchResponse_Hit_Highlights) GetFragments() []string

func (*SearchResponse_Hit_Highlights) ProtoMessage added in v0.14.0 

func (*SearchResponse_Hit_Highlights) ProtoMessage()

func (*SearchResponse_Hit_Highlights) ProtoReflect added in v0.14.0 

func (x *SearchResponse_Hit_Highlights) ProtoReflect() protoreflect.Message

func (*SearchResponse_Hit_Highlights) Reset added in v0.14.0 

func (x *SearchResponse_Hit_Highlights) Reset()

func (*SearchResponse_Hit_Highlights) String added in v0.14.0 

func (x *SearchResponse_Hit_Highlights) String() string

type SearchResponse_SearchState 

type SearchResponse_SearchState struct {

	// Query time
	Timestamp int64 `protobuf:"varint,1,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// Index searcher version
	SearcherVersion int64 `protobuf:"varint,2,opt,name=searcherVersion,proto3" json:"searcherVersion,omitempty"`
	// replaced by lastHitInfo
	//
	// Deprecated: Do not use.
	LastDocId int32 `protobuf:"varint,3,opt,name=lastDocId,proto3" json:"lastDocId,omitempty"`
	// replaced by lastHitInfo
	//
	// Deprecated: Do not use.
	LastFieldValues []string `protobuf:"bytes,4,rep,name=lastFieldValues,proto3" json:"lastFieldValues,omitempty"`
	// replaced by lastHitInfo
	//
	// Deprecated: Do not use.
	LastScore float32 `protobuf:"fixed32,5,opt,name=lastScore,proto3" json:"lastScore,omitempty"`
	// Last hit info for search after
	LastHitInfo *LastHitInfo `protobuf:"bytes,6,opt,name=lastHitInfo,proto3" json:"lastHitInfo,omitempty"`
	// contains filtered or unexported fields
}

State for use in subsequent searches (search after)

func (*SearchResponse_SearchState) Descriptor deprecated 

func (*SearchResponse_SearchState) Descriptor() ([]byte, []int)

Deprecated: Use SearchResponse_SearchState.ProtoReflect.Descriptor instead.

func (*SearchResponse_SearchState) GetLastDocId deprecated 

func (x *SearchResponse_SearchState) GetLastDocId() int32

Deprecated: Do not use.

func (*SearchResponse_SearchState) GetLastFieldValues deprecated 

func (x *SearchResponse_SearchState) GetLastFieldValues() []string

Deprecated: Do not use.

func (*SearchResponse_SearchState) GetLastHitInfo added in v0.40.0 

func (x *SearchResponse_SearchState) GetLastHitInfo() *LastHitInfo

func (*SearchResponse_SearchState) GetLastScore deprecated 

func (x *SearchResponse_SearchState) GetLastScore() float32

Deprecated: Do not use.

func (*SearchResponse_SearchState) GetSearcherVersion 

func (x *SearchResponse_SearchState) GetSearcherVersion() int64

func (*SearchResponse_SearchState) GetTimestamp 

func (x *SearchResponse_SearchState) GetTimestamp() int64

func (*SearchResponse_SearchState) ProtoMessage 

func (*SearchResponse_SearchState) ProtoMessage()

func (*SearchResponse_SearchState) ProtoReflect 

func (x *SearchResponse_SearchState) ProtoReflect() protoreflect.Message

func (*SearchResponse_SearchState) Reset 

func (x *SearchResponse_SearchState) Reset()

func (*SearchResponse_SearchState) String 

func (x *SearchResponse_SearchState) String() string

type Searcher 

type Searcher struct {

	// Version recorded in the commit that the reader opened. This version is advanced every time a change
	// is made with IndexWriter.
	Version int64 `protobuf:"varint,1,opt,name=version,proto3" json:"version,omitempty"`
	// Total number of docs in this index
	NumDocs int32 `protobuf:"varint,2,opt,name=numDocs,proto3" json:"numDocs,omitempty"`
	// String representation of segments
	Segments string `protobuf:"bytes,3,opt,name=segments,proto3" json:"segments,omitempty"`
	// How much time has passed since this searcher was the current (live) searcher
	StaleAgeSeconds float64 `protobuf:"fixed64,4,opt,name=staleAgeSeconds,proto3" json:"staleAgeSeconds,omitempty"`
	// Number of segments, filled only if Searcher has StandardDirectoryReader
	NumSegments int32 `protobuf:"varint,5,opt,name=numSegments,proto3" json:"numSegments,omitempty"`
	// contains filtered or unexported fields
}

Index searcher stats

func (*Searcher) Descriptor deprecated 

func (*Searcher) Descriptor() ([]byte, []int)

Deprecated: Use Searcher.ProtoReflect.Descriptor instead.

func (*Searcher) GetNumDocs 

func (x *Searcher) GetNumDocs() int32

func (*Searcher) GetNumSegments 

func (x *Searcher) GetNumSegments() int32

func (*Searcher) GetSegments 

func (x *Searcher) GetSegments() string

func (*Searcher) GetStaleAgeSeconds 

func (x *Searcher) GetStaleAgeSeconds() float64

func (*Searcher) GetVersion 

func (x *Searcher) GetVersion() int64

func (*Searcher) ProtoMessage 

func (*Searcher) ProtoMessage()

func (*Searcher) ProtoReflect 

func (x *Searcher) ProtoReflect() protoreflect.Message

func (*Searcher) Reset 

func (x *Searcher) Reset()

func (*Searcher) String 

func (x *Searcher) String() string

type SearcherVersion 

type SearcherVersion struct {

	// Version recorded in the commit that the reader opened. This version is advanced every time a change
	// is made with IndexWriter.
	Version int64 `protobuf:"varint,1,opt,name=version,proto3" json:"version,omitempty"`
	// True if refresh happened
	DidRefresh bool `protobuf:"varint,2,opt,name=didRefresh,proto3" json:"didRefresh,omitempty"`
	// contains filtered or unexported fields
}

Index searcher version

func (*SearcherVersion) Descriptor deprecated 

func (*SearcherVersion) Descriptor() ([]byte, []int)

Deprecated: Use SearcherVersion.ProtoReflect.Descriptor instead.

func (*SearcherVersion) GetDidRefresh 

func (x *SearcherVersion) GetDidRefresh() bool

func (*SearcherVersion) GetVersion 

func (x *SearcherVersion) GetVersion() int64

func (*SearcherVersion) ProtoMessage 

func (*SearcherVersion) ProtoMessage()

func (*SearcherVersion) ProtoReflect 

func (x *SearcherVersion) ProtoReflect() protoreflect.Message

func (*SearcherVersion) Reset 

func (x *SearcherVersion) Reset()

func (*SearcherVersion) String 

func (x *SearcherVersion) String() string

type Selector 

type Selector int32

For multi valued fields, how to select which value is used for sorting 

const (
	// Minimum value
	Selector_MIN Selector = 0
	// Maximum value
	Selector_MAX Selector = 1
	// Middle value of the set; if there are an even number of values, the lower of the middle two is chosen
	Selector_MIDDLE_MIN Selector = 2
	// Middle value of the set; if there are an even number of values, the upper of the middle two is chosen
	Selector_MIDDLE_MAX Selector = 3
)

func (Selector) Descriptor 

func (Selector) Descriptor() protoreflect.EnumDescriptor

func (Selector) Enum 

func (x Selector) Enum() *Selector

func (Selector) EnumDescriptor deprecated 

func (Selector) EnumDescriptor() ([]byte, []int)

Deprecated: Use Selector.Descriptor instead.

func (Selector) Number 

func (x Selector) Number() protoreflect.EnumNumber

func (Selector) String 

func (x Selector) String() string

func (Selector) Type 

func (Selector) Type() protoreflect.EnumType

type SettingsRequest 

type SettingsRequest struct {

	// Name of index whose settings are to be updated
	IndexName string `protobuf:"bytes,1,opt,name=indexName,proto3" json:"indexName,omitempty"`
	// No longer used
	//
	// Deprecated: Do not use.
	MergeMaxMBPerSec float64 `protobuf:"fixed64,2,opt,name=mergeMaxMBPerSec,proto3" json:"mergeMaxMBPerSec,omitempty"`
	// Largest merged segment size to cache in RAMDirectory, default: 5.0MB
	NrtCachingDirectoryMaxMergeSizeMB float64 `protobuf:"fixed64,3,opt,name=nrtCachingDirectoryMaxMergeSizeMB,proto3" json:"nrtCachingDirectoryMaxMergeSizeMB,omitempty"`
	// Largest overall size for all files cached in NRTCachingDirectory; set to -1 to disable NRTCachingDirectory,
	// default: 60.0MB
	NrtCachingDirectoryMaxSizeMB float64 `protobuf:"fixed64,4,opt,name=nrtCachingDirectoryMaxSizeMB,proto3" json:"nrtCachingDirectoryMaxSizeMB,omitempty"`
	// How many merge threads to allow at once
	ConcurrentMergeSchedulerMaxThreadCount int32 `` /* 130-byte string literal not displayed */
	// Maximum backlog of pending merges before indexing threads are stalled
	ConcurrentMergeSchedulerMaxMergeCount int32 `` /* 128-byte string literal not displayed */
	// Index time sorting; can only be written once, default: no sorting
	IndexSort *SortFields `protobuf:"bytes,7,opt,name=indexSort,proto3" json:"indexSort,omitempty"`
	// Deprecated, moved to lucene config. Turn on IndexWriter's infoStream (to stdout)
	//
	// Deprecated: Do not use.
	IndexVerbose bool `protobuf:"varint,8,opt,name=indexVerbose,proto3" json:"indexVerbose,omitempty"`
	// Turn on/off the merge scheduler's auto throttling
	IndexMergeSchedulerAutoThrottle bool `protobuf:"varint,9,opt,name=indexMergeSchedulerAutoThrottle,proto3" json:"indexMergeSchedulerAutoThrottle,omitempty"`
	// No longer used
	//
	// Deprecated: Do not use.
	NormsFormat string `protobuf:"bytes,10,opt,name=normsFormat,proto3" json:"normsFormat,omitempty"`
	// Base Directory implementation to use either one of the core implementations
	// (FSDirectory, MMapDirectory, NIOFSDirectory, or a fully qualified path to a Directory
	// implementation that has a public constructor taking a single File argument default: FSDirectory.
	// This implementation will be wrapped by NRTCachingDirectory, if enabled and not using MMappedDirectory.
	Directory string `protobuf:"bytes,11,opt,name=directory,proto3" json:"directory,omitempty"`
	// contains filtered or unexported fields
}

Input to settings

func (*SettingsRequest) Descriptor deprecated 

func (*SettingsRequest) Descriptor() ([]byte, []int)

Deprecated: Use SettingsRequest.ProtoReflect.Descriptor instead.

func (*SettingsRequest) GetConcurrentMergeSchedulerMaxMergeCount 

func (x *SettingsRequest) GetConcurrentMergeSchedulerMaxMergeCount() int32

func (*SettingsRequest) GetConcurrentMergeSchedulerMaxThreadCount 

func (x *SettingsRequest) GetConcurrentMergeSchedulerMaxThreadCount() int32

func (*SettingsRequest) GetDirectory 

func (x *SettingsRequest) GetDirectory() string

func (*SettingsRequest) GetIndexMergeSchedulerAutoThrottle 

func (x *SettingsRequest) GetIndexMergeSchedulerAutoThrottle() bool

func (*SettingsRequest) GetIndexName 

func (x *SettingsRequest) GetIndexName() string

func (*SettingsRequest) GetIndexSort 

func (x *SettingsRequest) GetIndexSort() *SortFields

func (*SettingsRequest) GetIndexVerbose deprecated 

func (x *SettingsRequest) GetIndexVerbose() bool

Deprecated: Do not use.

func (*SettingsRequest) GetMergeMaxMBPerSec deprecated 

func (x *SettingsRequest) GetMergeMaxMBPerSec() float64

Deprecated: Do not use.

func (*SettingsRequest) GetNormsFormat deprecated 

func (x *SettingsRequest) GetNormsFormat() string

Deprecated: Do not use.

func (*SettingsRequest) GetNrtCachingDirectoryMaxMergeSizeMB 

func (x *SettingsRequest) GetNrtCachingDirectoryMaxMergeSizeMB() float64

func (*SettingsRequest) GetNrtCachingDirectoryMaxSizeMB 

func (x *SettingsRequest) GetNrtCachingDirectoryMaxSizeMB() float64

func (*SettingsRequest) ProtoMessage 

func (*SettingsRequest) ProtoMessage()

func (*SettingsRequest) ProtoReflect 

func (x *SettingsRequest) ProtoReflect() protoreflect.Message

func (*SettingsRequest) Reset 

func (x *SettingsRequest) Reset()

func (*SettingsRequest) String 

func (x *SettingsRequest) String() string

type SettingsResponse 

type SettingsResponse struct {

	// Json string of updated IndexSettings
	Response string `protobuf:"bytes,1,opt,name=response,proto3" json:"response,omitempty"`
	// contains filtered or unexported fields
}

Settings Response returned from Server

func (*SettingsResponse) Descriptor deprecated 

func (*SettingsResponse) Descriptor() ([]byte, []int)

Deprecated: Use SettingsResponse.ProtoReflect.Descriptor instead.

func (*SettingsResponse) GetResponse 

func (x *SettingsResponse) GetResponse() string

func (*SettingsResponse) ProtoMessage 

func (*SettingsResponse) ProtoMessage()

func (*SettingsResponse) ProtoReflect 

func (x *SettingsResponse) ProtoReflect() protoreflect.Message

func (*SettingsResponse) Reset 

func (x *SettingsResponse) Reset()

func (*SettingsResponse) String 

func (x *SettingsResponse) String() string

type SettingsV2Request added in v0.11.0 

type SettingsV2Request struct {

	// Index name
	IndexName string `protobuf:"bytes,1,opt,name=indexName,proto3" json:"indexName,omitempty"`
	// Settings to merge into existing settings, or unset to get current settings
	Settings *IndexSettings `protobuf:"bytes,2,opt,name=settings,proto3" json:"settings,omitempty"`
	// contains filtered or unexported fields
}

Input to settingsV2

func (*SettingsV2Request) Descriptor deprecated added in v0.11.0 

func (*SettingsV2Request) Descriptor() ([]byte, []int)

Deprecated: Use SettingsV2Request.ProtoReflect.Descriptor instead.

func (*SettingsV2Request) GetIndexName added in v0.11.0 

func (x *SettingsV2Request) GetIndexName() string

func (*SettingsV2Request) GetSettings added in v0.11.0 

func (x *SettingsV2Request) GetSettings() *IndexSettings

func (*SettingsV2Request) ProtoMessage added in v0.11.0 

func (*SettingsV2Request) ProtoMessage()

func (*SettingsV2Request) ProtoReflect added in v0.11.0 

func (x *SettingsV2Request) ProtoReflect() protoreflect.Message

func (*SettingsV2Request) Reset added in v0.11.0 

func (x *SettingsV2Request) Reset()

func (*SettingsV2Request) String added in v0.11.0 

func (x *SettingsV2Request) String() string

type SettingsV2Response added in v0.11.0 

type SettingsV2Response struct {

	// Current index settings, including default values
	Settings *IndexSettings `protobuf:"bytes,1,opt,name=settings,proto3" json:"settings,omitempty"`
	// contains filtered or unexported fields
}

Response from Server for settingsV2

func (*SettingsV2Response) Descriptor deprecated added in v0.11.0 

func (*SettingsV2Response) Descriptor() ([]byte, []int)

Deprecated: Use SettingsV2Response.ProtoReflect.Descriptor instead.

func (*SettingsV2Response) GetSettings added in v0.11.0 

func (x *SettingsV2Response) GetSettings() *IndexSettings

func (*SettingsV2Response) ProtoMessage added in v0.11.0 

func (*SettingsV2Response) ProtoMessage()

func (*SettingsV2Response) ProtoReflect added in v0.11.0 

func (x *SettingsV2Response) ProtoReflect() protoreflect.Message

func (*SettingsV2Response) Reset added in v0.11.0 

func (x *SettingsV2Response) Reset()

func (*SettingsV2Response) String added in v0.11.0 

func (x *SettingsV2Response) String() string

type SnapshotId 

type SnapshotId struct {

	// Index generation
	IndexGen int64 `protobuf:"varint,1,opt,name=indexGen,proto3" json:"indexGen,omitempty"`
	// Taxonomy index generation
	TaxonomyGen int64 `protobuf:"varint,2,opt,name=taxonomyGen,proto3" json:"taxonomyGen,omitempty"`
	// State generation
	StateGen int64 `protobuf:"varint,3,opt,name=stateGen,proto3" json:"stateGen,omitempty"`
	// contains filtered or unexported fields
}

Snapshot id

func (*SnapshotId) Descriptor deprecated 

func (*SnapshotId) Descriptor() ([]byte, []int)

Deprecated: Use SnapshotId.ProtoReflect.Descriptor instead.

func (*SnapshotId) GetIndexGen 

func (x *SnapshotId) GetIndexGen() int64

func (*SnapshotId) GetStateGen 

func (x *SnapshotId) GetStateGen() int64

func (*SnapshotId) GetTaxonomyGen 

func (x *SnapshotId) GetTaxonomyGen() int64

func (*SnapshotId) ProtoMessage 

func (*SnapshotId) ProtoMessage()

func (*SnapshotId) ProtoReflect 

func (x *SnapshotId) ProtoReflect() protoreflect.Message

func (*SnapshotId) Reset 

func (x *SnapshotId) Reset()

func (*SnapshotId) String 

func (x *SnapshotId) String() string

type SortFields 

type SortFields struct {

	// Fields to sort on
	SortedFields []*SortType `protobuf:"bytes,1,rep,name=sortedFields,proto3" json:"sortedFields,omitempty"`
	// contains filtered or unexported fields
}

Fields to sort on either during index time or search time

func (*SortFields) Descriptor deprecated 

func (*SortFields) Descriptor() ([]byte, []int)

Deprecated: Use SortFields.ProtoReflect.Descriptor instead.

func (*SortFields) GetSortedFields 

func (x *SortFields) GetSortedFields() []*SortType

func (*SortFields) ProtoMessage 

func (*SortFields) ProtoMessage()

func (*SortFields) ProtoReflect 

func (x *SortFields) ProtoReflect() protoreflect.Message

func (*SortFields) Reset 

func (x *SortFields) Reset()

func (*SortFields) String 

func (x *SortFields) String() string

type SortType 

type SortType struct {

	// Name of field to sort on
	FieldName string `protobuf:"bytes,1,opt,name=fieldName,proto3" json:"fieldName,omitempty"`
	// For multi valued fields, how to select which value is used for sorting
	Selector Selector `protobuf:"varint,2,opt,name=selector,proto3,enum=luceneserver.Selector" json:"selector,omitempty"`
	// For distance sort, the point that we measure distance from
	Origin *Point `protobuf:"bytes,3,opt,name=origin,proto3" json:"origin,omitempty"`
	// Whether missing values should sort last instead of first.
	// Note that this runs \"before\" reverse, so if you sort missing first and reverse=true then missing values will
	// be at the end.
	MissingLast bool `protobuf:"varint,4,opt,name=missingLast,proto3" json:"missingLast,omitempty"`
	// Sort in reverse of the field's natural order
	Reverse bool `protobuf:"varint,5,opt,name=reverse,proto3" json:"reverse,omitempty"`
	// The unit used for the distance sort. Supported options are m, km and mi, default is m
	Unit string `protobuf:"bytes,6,opt,name=unit,proto3" json:"unit,omitempty"`
	// contains filtered or unexported fields
}

The field to sort on. Pass 'docid' for index order and 'score' for relevance sort.

func (*SortType) Descriptor deprecated 

func (*SortType) Descriptor() ([]byte, []int)

Deprecated: Use SortType.ProtoReflect.Descriptor instead.

func (*SortType) GetFieldName 

func (x *SortType) GetFieldName() string

func (*SortType) GetMissingLast 

func (x *SortType) GetMissingLast() bool

func (*SortType) GetOrigin 

func (x *SortType) GetOrigin() *Point

func (*SortType) GetReverse 

func (x *SortType) GetReverse() bool

func (*SortType) GetSelector 

func (x *SortType) GetSelector() Selector

func (*SortType) GetUnit added in v0.27.0 

func (x *SortType) GetUnit() string

func (*SortType) ProtoMessage 

func (*SortType) ProtoMessage()

func (*SortType) ProtoReflect 

func (x *SortType) ProtoReflect() protoreflect.Message

func (*SortType) Reset 

func (x *SortType) Reset()

func (*SortType) String 

func (x *SortType) String() string

type SpanMultiTermQuery added in v0.39.0 

type SpanMultiTermQuery struct {

	// The query to be wrapped
	//
	// Types that are assignable to WrappedQuery:
	//
	//	*SpanMultiTermQuery_WildcardQuery
	//	*SpanMultiTermQuery_FuzzyQuery
	//	*SpanMultiTermQuery_PrefixQuery
	//	*SpanMultiTermQuery_RegexpQuery
	//	*SpanMultiTermQuery_TermRangeQuery
	WrappedQuery isSpanMultiTermQuery_WrappedQuery `protobuf_oneof:"wrappedQuery"`
	// contains filtered or unexported fields
}

Message for a SpanMultiTermQuery

func (*SpanMultiTermQuery) Descriptor deprecated added in v0.39.0 

func (*SpanMultiTermQuery) Descriptor() ([]byte, []int)

Deprecated: Use SpanMultiTermQuery.ProtoReflect.Descriptor instead.

func (*SpanMultiTermQuery) GetFuzzyQuery added in v0.39.0 

func (x *SpanMultiTermQuery) GetFuzzyQuery() *FuzzyQuery

func (*SpanMultiTermQuery) GetPrefixQuery added in v0.39.0 

func (x *SpanMultiTermQuery) GetPrefixQuery() *PrefixQuery

func (*SpanMultiTermQuery) GetRegexpQuery added in v0.39.0 

func (x *SpanMultiTermQuery) GetRegexpQuery() *RegexpQuery

func (*SpanMultiTermQuery) GetTermRangeQuery added in v0.39.0 

func (x *SpanMultiTermQuery) GetTermRangeQuery() *TermRangeQuery

func (*SpanMultiTermQuery) GetWildcardQuery added in v0.39.0 

func (x *SpanMultiTermQuery) GetWildcardQuery() *WildcardQuery

func (*SpanMultiTermQuery) GetWrappedQuery added in v0.39.0 

func (m *SpanMultiTermQuery) GetWrappedQuery() isSpanMultiTermQuery_WrappedQuery

func (*SpanMultiTermQuery) ProtoMessage added in v0.39.0 

func (*SpanMultiTermQuery) ProtoMessage()

func (*SpanMultiTermQuery) ProtoReflect added in v0.39.0 

func (x *SpanMultiTermQuery) ProtoReflect() protoreflect.Message

func (*SpanMultiTermQuery) Reset added in v0.39.0 

func (x *SpanMultiTermQuery) Reset()

func (*SpanMultiTermQuery) String added in v0.39.0 

func (x *SpanMultiTermQuery) String() string

type SpanMultiTermQuery_FuzzyQuery added in v0.39.0 

type SpanMultiTermQuery_FuzzyQuery struct {
	FuzzyQuery *FuzzyQuery `protobuf:"bytes,2,opt,name=fuzzyQuery,proto3,oneof"`
}

type SpanMultiTermQuery_PrefixQuery added in v0.39.0 

type SpanMultiTermQuery_PrefixQuery struct {
	PrefixQuery *PrefixQuery `protobuf:"bytes,3,opt,name=prefixQuery,proto3,oneof"`
}

type SpanMultiTermQuery_RegexpQuery added in v0.39.0 

type SpanMultiTermQuery_RegexpQuery struct {
	RegexpQuery *RegexpQuery `protobuf:"bytes,4,opt,name=regexpQuery,proto3,oneof"`
}

type SpanMultiTermQuery_TermRangeQuery added in v0.39.0 

type SpanMultiTermQuery_TermRangeQuery struct {
	TermRangeQuery *TermRangeQuery `protobuf:"bytes,5,opt,name=termRangeQuery,proto3,oneof"`
}

type SpanMultiTermQuery_WildcardQuery added in v0.39.0 

type SpanMultiTermQuery_WildcardQuery struct {
	WildcardQuery *WildcardQuery `protobuf:"bytes,1,opt,name=wildcardQuery,proto3,oneof"`
}

type SpanNearQuery added in v0.39.0 

type SpanNearQuery struct {

	// Clauses for a span near query
	Clauses []*SpanQuery `protobuf:"bytes,1,rep,name=clauses,proto3" json:"clauses,omitempty"`
	// Maximum number of positions between matching terms
	Slop int32 `protobuf:"varint,2,opt,name=slop,proto3" json:"slop,omitempty"`
	// True if the matching terms must be in the same order as the query
	InOrder bool `protobuf:"varint,3,opt,name=inOrder,proto3" json:"inOrder,omitempty"`
	// contains filtered or unexported fields
}

A query that matches documents containing terms within a specified range

func (*SpanNearQuery) Descriptor deprecated added in v0.39.0 

func (*SpanNearQuery) Descriptor() ([]byte, []int)

Deprecated: Use SpanNearQuery.ProtoReflect.Descriptor instead.

func (*SpanNearQuery) GetClauses added in v0.39.0 

func (x *SpanNearQuery) GetClauses() []*SpanQuery

func (*SpanNearQuery) GetInOrder added in v0.39.0 

func (x *SpanNearQuery) GetInOrder() bool

func (*SpanNearQuery) GetSlop added in v0.39.0 

func (x *SpanNearQuery) GetSlop() int32

func (*SpanNearQuery) ProtoMessage added in v0.39.0 

func (*SpanNearQuery) ProtoMessage()

func (*SpanNearQuery) ProtoReflect added in v0.39.0 

func (x *SpanNearQuery) ProtoReflect() protoreflect.Message

func (*SpanNearQuery) Reset added in v0.39.0 

func (x *SpanNearQuery) Reset()

func (*SpanNearQuery) String added in v0.39.0 

func (x *SpanNearQuery) String() string

type SpanQuery added in v0.39.0 

type SpanQuery struct {

	// Types that are assignable to Query:
	//
	//	*SpanQuery_SpanTermQuery
	//	*SpanQuery_SpanNearQuery
	//	*SpanQuery_SpanMultiTermQuery
	Query isSpanQuery_Query `protobuf_oneof:"query"`
	// contains filtered or unexported fields
}

Wrapper message for different types of SpanQuery

func (*SpanQuery) Descriptor deprecated added in v0.39.0 

func (*SpanQuery) Descriptor() ([]byte, []int)

Deprecated: Use SpanQuery.ProtoReflect.Descriptor instead.

func (*SpanQuery) GetQuery added in v0.39.0 

func (m *SpanQuery) GetQuery() isSpanQuery_Query

func (*SpanQuery) GetSpanMultiTermQuery added in v0.39.0 

func (x *SpanQuery) GetSpanMultiTermQuery() *SpanMultiTermQuery

func (*SpanQuery) GetSpanNearQuery added in v0.39.0 

func (x *SpanQuery) GetSpanNearQuery() *SpanNearQuery

func (*SpanQuery) GetSpanTermQuery added in v0.39.0 

func (x *SpanQuery) GetSpanTermQuery() *TermQuery

func (*SpanQuery) ProtoMessage added in v0.39.0 

func (*SpanQuery) ProtoMessage()

func (*SpanQuery) ProtoReflect added in v0.39.0 

func (x *SpanQuery) ProtoReflect() protoreflect.Message

func (*SpanQuery) Reset added in v0.39.0 

func (x *SpanQuery) Reset()

func (*SpanQuery) String added in v0.39.0 

func (x *SpanQuery) String() string

type SpanQuery_SpanMultiTermQuery added in v0.39.0 

type SpanQuery_SpanMultiTermQuery struct {
	SpanMultiTermQuery *SpanMultiTermQuery `protobuf:"bytes,3,opt,name=spanMultiTermQuery,proto3,oneof"`
}

type SpanQuery_SpanNearQuery added in v0.39.0 

type SpanQuery_SpanNearQuery struct {
	SpanNearQuery *SpanNearQuery `protobuf:"bytes,2,opt,name=spanNearQuery,proto3,oneof"`
}

type SpanQuery_SpanTermQuery added in v0.39.0 

type SpanQuery_SpanTermQuery struct {
	SpanTermQuery *TermQuery `protobuf:"bytes,1,opt,name=spanTermQuery,proto3,oneof"`
}

type StartIndexRequest 

type StartIndexRequest struct {

	// Index name
	IndexName string `protobuf:"bytes,1,opt,name=indexName,proto3" json:"indexName,omitempty"`
	// Mode to start this index: Standalone, NRT primary or replica
	Mode Mode `protobuf:"varint,2,opt,name=mode,proto3,enum=luceneserver.Mode" json:"mode,omitempty"`
	// Generation of this primary (should increase each time a new primary starts for this index).
	// Pass -1 use generation based on epoch time.
	PrimaryGen int64 `protobuf:"varint,3,opt,name=primaryGen,proto3" json:"primaryGen,omitempty"` //primary,
	// Replica config: the IP address or host name of the remote primary
	PrimaryAddress string `protobuf:"bytes,4,opt,name=primaryAddress,proto3" json:"primaryAddress,omitempty"`
	// Replica config: the TCP port of the remote primary
	Port int32 `protobuf:"varint,5,opt,name=port,proto3" json:"port,omitempty"`
	// Restore index from backup
	Restore *RestoreIndex `protobuf:"bytes,6,opt,name=restore,proto3" json:"restore,omitempty"`
	// Replica config: location of discovery file containing primary host/port. Used if primaryAddress is empty.
	// If port is specified in this request, it overrides the port value in the file.
	PrimaryDiscoveryFile string `protobuf:"bytes,7,opt,name=primaryDiscoveryFile,proto3" json:"primaryDiscoveryFile,omitempty"`
	// contains filtered or unexported fields
}

Input to startIndex

func (*StartIndexRequest) Descriptor deprecated 

func (*StartIndexRequest) Descriptor() ([]byte, []int)

Deprecated: Use StartIndexRequest.ProtoReflect.Descriptor instead.

func (*StartIndexRequest) GetIndexName 

func (x *StartIndexRequest) GetIndexName() string

func (*StartIndexRequest) GetMode 

func (x *StartIndexRequest) GetMode() Mode

func (*StartIndexRequest) GetPort 

func (x *StartIndexRequest) GetPort() int32

func (*StartIndexRequest) GetPrimaryAddress 

func (x *StartIndexRequest) GetPrimaryAddress() string

func (*StartIndexRequest) GetPrimaryDiscoveryFile added in v0.12.0 

func (x *StartIndexRequest) GetPrimaryDiscoveryFile() string

func (*StartIndexRequest) GetPrimaryGen 

func (x *StartIndexRequest) GetPrimaryGen() int64

func (*StartIndexRequest) GetRestore 

func (x *StartIndexRequest) GetRestore() *RestoreIndex

func (*StartIndexRequest) ProtoMessage 

func (*StartIndexRequest) ProtoMessage()

func (*StartIndexRequest) ProtoReflect 

func (x *StartIndexRequest) ProtoReflect() protoreflect.Message

func (*StartIndexRequest) Reset 

func (x *StartIndexRequest) Reset()

func (*StartIndexRequest) String 

func (x *StartIndexRequest) String() string

type StartIndexResponse 

type StartIndexResponse struct {

	// One greater than the largest possible document number
	MaxDoc int32 `protobuf:"varint,1,opt,name=maxDoc,proto3" json:"maxDoc,omitempty"`
	// Number of documents in this index
	NumDocs int32 `protobuf:"varint,2,opt,name=numDocs,proto3" json:"numDocs,omitempty"`
	// String representation of the IndexReader implementation
	Segments string `protobuf:"bytes,3,opt,name=segments,proto3" json:"segments,omitempty"`
	// Time taken to start the index
	StartTimeMS float64 `protobuf:"fixed64,4,opt,name=startTimeMS,proto3" json:"startTimeMS,omitempty"`
	// contains filtered or unexported fields
}

Response from Server for startIndex

func (*StartIndexResponse) Descriptor deprecated 

func (*StartIndexResponse) Descriptor() ([]byte, []int)

Deprecated: Use StartIndexResponse.ProtoReflect.Descriptor instead.

func (*StartIndexResponse) GetMaxDoc 

func (x *StartIndexResponse) GetMaxDoc() int32

func (*StartIndexResponse) GetNumDocs 

func (x *StartIndexResponse) GetNumDocs() int32

func (*StartIndexResponse) GetSegments 

func (x *StartIndexResponse) GetSegments() string

func (*StartIndexResponse) GetStartTimeMS 

func (x *StartIndexResponse) GetStartTimeMS() float64

func (*StartIndexResponse) ProtoMessage 

func (*StartIndexResponse) ProtoMessage()

func (*StartIndexResponse) ProtoReflect 

func (x *StartIndexResponse) ProtoReflect() protoreflect.Message

func (*StartIndexResponse) Reset 

func (x *StartIndexResponse) Reset()

func (*StartIndexResponse) String 

func (x *StartIndexResponse) String() string

type StartIndexV2Request added in v0.18.0 

type StartIndexV2Request struct {

	// Index name
	IndexName string `protobuf:"bytes,1,opt,name=indexName,proto3" json:"indexName,omitempty"`
	// contains filtered or unexported fields
}

Start the index using IndexStartConfig configuration

func (*StartIndexV2Request) Descriptor deprecated added in v0.18.0 

func (*StartIndexV2Request) Descriptor() ([]byte, []int)

Deprecated: Use StartIndexV2Request.ProtoReflect.Descriptor instead.

func (*StartIndexV2Request) GetIndexName added in v0.18.0 

func (x *StartIndexV2Request) GetIndexName() string

func (*StartIndexV2Request) ProtoMessage added in v0.18.0 

func (*StartIndexV2Request) ProtoMessage()

func (*StartIndexV2Request) ProtoReflect added in v0.18.0 

func (x *StartIndexV2Request) ProtoReflect() protoreflect.Message

func (*StartIndexV2Request) Reset added in v0.18.0 

func (x *StartIndexV2Request) Reset()

func (*StartIndexV2Request) String added in v0.18.0 

func (x *StartIndexV2Request) String() string

type StateRequest 

type StateRequest struct {

	// Index name to retrieve state
	IndexName string `protobuf:"bytes,1,opt,name=indexName,proto3" json:"indexName,omitempty"`
	// contains filtered or unexported fields
}

Input to state

func (*StateRequest) Descriptor deprecated 

func (*StateRequest) Descriptor() ([]byte, []int)

Deprecated: Use StateRequest.ProtoReflect.Descriptor instead.

func (*StateRequest) GetIndexName 

func (x *StateRequest) GetIndexName() string

func (*StateRequest) ProtoMessage 

func (*StateRequest) ProtoMessage()

func (*StateRequest) ProtoReflect 

func (x *StateRequest) ProtoReflect() protoreflect.Message

func (*StateRequest) Reset 

func (x *StateRequest) Reset()

func (*StateRequest) String 

func (x *StateRequest) String() string

type StateResponse 

type StateResponse struct {

	// Json string of the current index state
	Response string `protobuf:"bytes,1,opt,name=response,proto3" json:"response,omitempty"`
	// contains filtered or unexported fields
}

Response from Server for state

func (*StateResponse) Descriptor deprecated 

func (*StateResponse) Descriptor() ([]byte, []int)

Deprecated: Use StateResponse.ProtoReflect.Descriptor instead.

func (*StateResponse) GetResponse 

func (x *StateResponse) GetResponse() string

func (*StateResponse) ProtoMessage 

func (*StateResponse) ProtoMessage()

func (*StateResponse) ProtoReflect 

func (x *StateResponse) ProtoReflect() protoreflect.Message

func (*StateResponse) Reset 

func (x *StateResponse) Reset()

func (*StateResponse) String 

func (x *StateResponse) String() string

type StatsRequest 

type StatsRequest struct {

	// Index name to retrieve stats
	IndexName string `protobuf:"bytes,1,opt,name=indexName,proto3" json:"indexName,omitempty"`
	// contains filtered or unexported fields
}

Input to stats

func (*StatsRequest) Descriptor deprecated 

func (*StatsRequest) Descriptor() ([]byte, []int)

Deprecated: Use StatsRequest.ProtoReflect.Descriptor instead.

func (*StatsRequest) GetIndexName 

func (x *StatsRequest) GetIndexName() string

func (*StatsRequest) ProtoMessage 

func (*StatsRequest) ProtoMessage()

func (*StatsRequest) ProtoReflect 

func (x *StatsRequest) ProtoReflect() protoreflect.Message

func (*StatsRequest) Reset 

func (x *StatsRequest) Reset()

func (*StatsRequest) String 

func (x *StatsRequest) String() string

type StatsResponse 

type StatsResponse struct {

	// Shard ordinal
	Ord int32 `protobuf:"varint,1,opt,name=ord,proto3" json:"ord,omitempty"`
	// The total number of docs in this index, including docs not yet flushed (still in the RAM buffer),
	// not counting deletions.
	MaxDoc int32 `protobuf:"varint,2,opt,name=maxDoc,proto3" json:"maxDoc,omitempty"`
	// The total number of docs in this index, including docs not yet flushed (still in the RAM buffer), and
	// including deletions. NOTE: buffered deletions are not counted.  If you really need these to be
	// counted you should call {@link IndexWriter#commit()} first.
	NumDocs int32 `protobuf:"varint,3,opt,name=numDocs,proto3" json:"numDocs,omitempty"`
	// The total size of this indexDir
	DirSize int64 `protobuf:"varint,4,opt,name=dirSize,proto3" json:"dirSize,omitempty"`
	// The state of the index
	State string `protobuf:"bytes,5,opt,name=state,proto3" json:"state,omitempty"`
	// Taxonomy(facets) stats
	Taxonomy *Taxonomy `protobuf:"bytes,6,opt,name=taxonomy,proto3" json:"taxonomy,omitempty"`
	// Searcher stats
	Searchers []*Searcher `protobuf:"bytes,7,rep,name=searchers,proto3" json:"searchers,omitempty"`
	// Current Searcher stats
	CurrentSearcher *Searcher `protobuf:"bytes,8,opt,name=currentSearcher,proto3" json:"currentSearcher,omitempty"`
	// contains filtered or unexported fields
}

Response from Server for stats

func (*StatsResponse) Descriptor deprecated 

func (*StatsResponse) Descriptor() ([]byte, []int)

Deprecated: Use StatsResponse.ProtoReflect.Descriptor instead.

func (*StatsResponse) GetCurrentSearcher 

func (x *StatsResponse) GetCurrentSearcher() *Searcher

func (*StatsResponse) GetDirSize 

func (x *StatsResponse) GetDirSize() int64

func (*StatsResponse) GetMaxDoc 

func (x *StatsResponse) GetMaxDoc() int32

func (*StatsResponse) GetNumDocs 

func (x *StatsResponse) GetNumDocs() int32

func (*StatsResponse) GetOrd 

func (x *StatsResponse) GetOrd() int32

func (*StatsResponse) GetSearchers 

func (x *StatsResponse) GetSearchers() []*Searcher

func (*StatsResponse) GetState 

func (x *StatsResponse) GetState() string

func (*StatsResponse) GetTaxonomy 

func (x *StatsResponse) GetTaxonomy() *Taxonomy

func (*StatsResponse) ProtoMessage 

func (*StatsResponse) ProtoMessage()

func (*StatsResponse) ProtoReflect 

func (x *StatsResponse) ProtoReflect() protoreflect.Message

func (*StatsResponse) Reset 

func (x *StatsResponse) Reset()

func (*StatsResponse) String 

func (x *StatsResponse) String() string

type StopIndexRequest 

type StopIndexRequest struct {

	// Index name to stop
	IndexName string `protobuf:"bytes,1,opt,name=indexName,proto3" json:"indexName,omitempty"`
	// contains filtered or unexported fields
}

Input to stopIndex

func (*StopIndexRequest) Descriptor deprecated 

func (*StopIndexRequest) Descriptor() ([]byte, []int)

Deprecated: Use StopIndexRequest.ProtoReflect.Descriptor instead.

func (*StopIndexRequest) GetIndexName 

func (x *StopIndexRequest) GetIndexName() string

func (*StopIndexRequest) ProtoMessage 

func (*StopIndexRequest) ProtoMessage()

func (*StopIndexRequest) ProtoReflect 

func (x *StopIndexRequest) ProtoReflect() protoreflect.Message

func (*StopIndexRequest) Reset 

func (x *StopIndexRequest) Reset()

func (*StopIndexRequest) String 

func (x *StopIndexRequest) String() string

type Taxonomy 

type Taxonomy struct {

	// Number of docs in this taxonomy reader
	NumOrds int32 `protobuf:"varint,1,opt,name=numOrds,proto3" json:"numOrds,omitempty"`
	// String representation of segments
	Segments string `protobuf:"bytes,2,opt,name=segments,proto3" json:"segments,omitempty"`
	// contains filtered or unexported fields
}

Taxonomy stats

func (*Taxonomy) Descriptor deprecated 

func (*Taxonomy) Descriptor() ([]byte, []int)

Deprecated: Use Taxonomy.ProtoReflect.Descriptor instead.

func (*Taxonomy) GetNumOrds 

func (x *Taxonomy) GetNumOrds() int32

func (*Taxonomy) GetSegments 

func (x *Taxonomy) GetSegments() string

func (*Taxonomy) ProtoMessage 

func (*Taxonomy) ProtoMessage()

func (*Taxonomy) ProtoReflect 

func (x *Taxonomy) ProtoReflect() protoreflect.Message

func (*Taxonomy) Reset 

func (x *Taxonomy) Reset()

func (*Taxonomy) String 

func (x *Taxonomy) String() string

type TermInSetQuery 

type TermInSetQuery struct {

	// Field in the document to query
	Field string `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
	// Types that are assignable to TermTypes:
	//
	//	*TermInSetQuery_TextTerms_
	//	*TermInSetQuery_IntTerms_
	//	*TermInSetQuery_LongTerms_
	//	*TermInSetQuery_FloatTerms_
	//	*TermInSetQuery_DoubleTerms_
	TermTypes isTermInSetQuery_TermTypes `protobuf_oneof:"TermTypes"`
	// contains filtered or unexported fields
}

Specialization for a disjunction over many terms that behaves like a ConstantScoreQuery over a BooleanQuery containing only BooleanClause.Occur.SHOULD clauses. Only ONE of the types of terms needs to be provided - the one that matches the type of the field.

func (*TermInSetQuery) Descriptor deprecated 

func (*TermInSetQuery) Descriptor() ([]byte, []int)

Deprecated: Use TermInSetQuery.ProtoReflect.Descriptor instead.

func (*TermInSetQuery) GetDoubleTerms 

func (x *TermInSetQuery) GetDoubleTerms() *TermInSetQuery_DoubleTerms

func (*TermInSetQuery) GetField 

func (x *TermInSetQuery) GetField() string

func (*TermInSetQuery) GetFloatTerms 

func (x *TermInSetQuery) GetFloatTerms() *TermInSetQuery_FloatTerms

func (*TermInSetQuery) GetIntTerms 

func (x *TermInSetQuery) GetIntTerms() *TermInSetQuery_IntTerms

func (*TermInSetQuery) GetLongTerms 

func (x *TermInSetQuery) GetLongTerms() *TermInSetQuery_LongTerms

func (*TermInSetQuery) GetTermTypes 

func (m *TermInSetQuery) GetTermTypes() isTermInSetQuery_TermTypes

func (*TermInSetQuery) GetTextTerms 

func (x *TermInSetQuery) GetTextTerms() *TermInSetQuery_TextTerms

func (*TermInSetQuery) ProtoMessage 

func (*TermInSetQuery) ProtoMessage()

func (*TermInSetQuery) ProtoReflect 

func (x *TermInSetQuery) ProtoReflect() protoreflect.Message

func (*TermInSetQuery) Reset 

func (x *TermInSetQuery) Reset()

func (*TermInSetQuery) String 

func (x *TermInSetQuery) String() string

type TermInSetQuery_DoubleTerms 

type TermInSetQuery_DoubleTerms struct {

	// DOUBLE field terms
	Terms []float64 `protobuf:"fixed64,1,rep,packed,name=terms,proto3" json:"terms,omitempty"`
	// contains filtered or unexported fields
}

func (*TermInSetQuery_DoubleTerms) Descriptor deprecated 

func (*TermInSetQuery_DoubleTerms) Descriptor() ([]byte, []int)

Deprecated: Use TermInSetQuery_DoubleTerms.ProtoReflect.Descriptor instead.

func (*TermInSetQuery_DoubleTerms) GetTerms 

func (x *TermInSetQuery_DoubleTerms) GetTerms() []float64

func (*TermInSetQuery_DoubleTerms) ProtoMessage 

func (*TermInSetQuery_DoubleTerms) ProtoMessage()

func (*TermInSetQuery_DoubleTerms) ProtoReflect 

func (x *TermInSetQuery_DoubleTerms) ProtoReflect() protoreflect.Message

func (*TermInSetQuery_DoubleTerms) Reset 

func (x *TermInSetQuery_DoubleTerms) Reset()

func (*TermInSetQuery_DoubleTerms) String 

func (x *TermInSetQuery_DoubleTerms) String() string

type TermInSetQuery_DoubleTerms_ 

type TermInSetQuery_DoubleTerms_ struct {
	// DOUBLE terms to search for.
	DoubleTerms *TermInSetQuery_DoubleTerms `protobuf:"bytes,6,opt,name=doubleTerms,proto3,oneof"`
}

type TermInSetQuery_FloatTerms 

type TermInSetQuery_FloatTerms struct {

	// FLOAT field terms
	Terms []float32 `protobuf:"fixed32,1,rep,packed,name=terms,proto3" json:"terms,omitempty"`
	// contains filtered or unexported fields
}

func (*TermInSetQuery_FloatTerms) Descriptor deprecated 

func (*TermInSetQuery_FloatTerms) Descriptor() ([]byte, []int)

Deprecated: Use TermInSetQuery_FloatTerms.ProtoReflect.Descriptor instead.

func (*TermInSetQuery_FloatTerms) GetTerms 

func (x *TermInSetQuery_FloatTerms) GetTerms() []float32

func (*TermInSetQuery_FloatTerms) ProtoMessage 

func (*TermInSetQuery_FloatTerms) ProtoMessage()

func (*TermInSetQuery_FloatTerms) ProtoReflect 

func (x *TermInSetQuery_FloatTerms) ProtoReflect() protoreflect.Message

func (*TermInSetQuery_FloatTerms) Reset 

func (x *TermInSetQuery_FloatTerms) Reset()

func (*TermInSetQuery_FloatTerms) String 

func (x *TermInSetQuery_FloatTerms) String() string

type TermInSetQuery_FloatTerms_ 

type TermInSetQuery_FloatTerms_ struct {
	// FLOAT terms to search for.
	FloatTerms *TermInSetQuery_FloatTerms `protobuf:"bytes,5,opt,name=floatTerms,proto3,oneof"`
}

type TermInSetQuery_IntTerms 

type TermInSetQuery_IntTerms struct {

	// INT field terms
	Terms []int32 `protobuf:"varint,1,rep,packed,name=terms,proto3" json:"terms,omitempty"`
	// contains filtered or unexported fields
}

func (*TermInSetQuery_IntTerms) Descriptor deprecated 

func (*TermInSetQuery_IntTerms) Descriptor() ([]byte, []int)

Deprecated: Use TermInSetQuery_IntTerms.ProtoReflect.Descriptor instead.

func (*TermInSetQuery_IntTerms) GetTerms 

func (x *TermInSetQuery_IntTerms) GetTerms() []int32

func (*TermInSetQuery_IntTerms) ProtoMessage 

func (*TermInSetQuery_IntTerms) ProtoMessage()

func (*TermInSetQuery_IntTerms) ProtoReflect 

func (x *TermInSetQuery_IntTerms) ProtoReflect() protoreflect.Message

func (*TermInSetQuery_IntTerms) Reset 

func (x *TermInSetQuery_IntTerms) Reset()

func (*TermInSetQuery_IntTerms) String 

func (x *TermInSetQuery_IntTerms) String() string

type TermInSetQuery_IntTerms_ 

type TermInSetQuery_IntTerms_ struct {
	// INT terms to search for.
	IntTerms *TermInSetQuery_IntTerms `protobuf:"bytes,3,opt,name=intTerms,proto3,oneof"`
}

type TermInSetQuery_LongTerms 

type TermInSetQuery_LongTerms struct {

	// LONG field terms
	Terms []int64 `protobuf:"varint,1,rep,packed,name=terms,proto3" json:"terms,omitempty"`
	// contains filtered or unexported fields
}

func (*TermInSetQuery_LongTerms) Descriptor deprecated 

func (*TermInSetQuery_LongTerms) Descriptor() ([]byte, []int)

Deprecated: Use TermInSetQuery_LongTerms.ProtoReflect.Descriptor instead.

func (*TermInSetQuery_LongTerms) GetTerms 

func (x *TermInSetQuery_LongTerms) GetTerms() []int64

func (*TermInSetQuery_LongTerms) ProtoMessage 

func (*TermInSetQuery_LongTerms) ProtoMessage()

func (*TermInSetQuery_LongTerms) ProtoReflect 

func (x *TermInSetQuery_LongTerms) ProtoReflect() protoreflect.Message

func (*TermInSetQuery_LongTerms) Reset 

func (x *TermInSetQuery_LongTerms) Reset()

func (*TermInSetQuery_LongTerms) String 

func (x *TermInSetQuery_LongTerms) String() string

type TermInSetQuery_LongTerms_ 

type TermInSetQuery_LongTerms_ struct {
	// LONG terms to search for.
	LongTerms *TermInSetQuery_LongTerms `protobuf:"bytes,4,opt,name=longTerms,proto3,oneof"`
}

type TermInSetQuery_TextTerms 

type TermInSetQuery_TextTerms struct {

	// TEXT field terms
	Terms []string `protobuf:"bytes,1,rep,name=terms,proto3" json:"terms,omitempty"`
	// contains filtered or unexported fields
}

func (*TermInSetQuery_TextTerms) Descriptor deprecated 

func (*TermInSetQuery_TextTerms) Descriptor() ([]byte, []int)

Deprecated: Use TermInSetQuery_TextTerms.ProtoReflect.Descriptor instead.

func (*TermInSetQuery_TextTerms) GetTerms 

func (x *TermInSetQuery_TextTerms) GetTerms() []string

func (*TermInSetQuery_TextTerms) ProtoMessage 

func (*TermInSetQuery_TextTerms) ProtoMessage()

func (*TermInSetQuery_TextTerms) ProtoReflect 

func (x *TermInSetQuery_TextTerms) ProtoReflect() protoreflect.Message

func (*TermInSetQuery_TextTerms) Reset 

func (x *TermInSetQuery_TextTerms) Reset()

func (*TermInSetQuery_TextTerms) String 

func (x *TermInSetQuery_TextTerms) String() string

type TermInSetQuery_TextTerms_ 

type TermInSetQuery_TextTerms_ struct {
	// TEXT terms to search for.
	TextTerms *TermInSetQuery_TextTerms `protobuf:"bytes,2,opt,name=textTerms,proto3,oneof"`
}

type TermQuery 

type TermQuery struct {

	// Field in the document to query
	Field string `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
	// Types that are assignable to TermTypes:
	//
	//	*TermQuery_TextValue
	//	*TermQuery_IntValue
	//	*TermQuery_LongValue
	//	*TermQuery_FloatValue
	//	*TermQuery_DoubleValue
	//	*TermQuery_BooleanValue
	TermTypes isTermQuery_TermTypes `protobuf_oneof:"TermTypes"`
	// contains filtered or unexported fields
}

A query that matches documents containing a term

func (*TermQuery) Descriptor deprecated 

func (*TermQuery) Descriptor() ([]byte, []int)

Deprecated: Use TermQuery.ProtoReflect.Descriptor instead.

func (*TermQuery) GetBooleanValue 

func (x *TermQuery) GetBooleanValue() bool

func (*TermQuery) GetDoubleValue 

func (x *TermQuery) GetDoubleValue() float64

func (*TermQuery) GetField 

func (x *TermQuery) GetField() string

func (*TermQuery) GetFloatValue 

func (x *TermQuery) GetFloatValue() float32

func (*TermQuery) GetIntValue 

func (x *TermQuery) GetIntValue() int32

func (*TermQuery) GetLongValue 

func (x *TermQuery) GetLongValue() int64

func (*TermQuery) GetTermTypes 

func (m *TermQuery) GetTermTypes() isTermQuery_TermTypes

func (*TermQuery) GetTextValue 

func (x *TermQuery) GetTextValue() string

func (*TermQuery) ProtoMessage 

func (*TermQuery) ProtoMessage()

func (*TermQuery) ProtoReflect 

func (x *TermQuery) ProtoReflect() protoreflect.Message

func (*TermQuery) Reset 

func (x *TermQuery) Reset()

func (*TermQuery) String 

func (x *TermQuery) String() string

type TermQuery_BooleanValue 

type TermQuery_BooleanValue struct {
	// BOOLEAN FieldType term to search for
	BooleanValue bool `protobuf:"varint,7,opt,name=booleanValue,proto3,oneof"`
}

type TermQuery_DoubleValue 

type TermQuery_DoubleValue struct {
	// DOUBLE FieldType term to search for
	DoubleValue float64 `protobuf:"fixed64,6,opt,name=doubleValue,proto3,oneof"`
}

type TermQuery_FloatValue 

type TermQuery_FloatValue struct {
	// FLOAT FieldType term to search for
	FloatValue float32 `protobuf:"fixed32,5,opt,name=floatValue,proto3,oneof"`
}

type TermQuery_IntValue 

type TermQuery_IntValue struct {
	// INT FieldType term to search for
	IntValue int32 `protobuf:"varint,3,opt,name=intValue,proto3,oneof"`
}

type TermQuery_LongValue 

type TermQuery_LongValue struct {
	// LONG FieldType term to search for
	LongValue int64 `protobuf:"varint,4,opt,name=longValue,proto3,oneof"`
}

type TermQuery_TextValue 

type TermQuery_TextValue struct {
	// TEXT FieldType term to search for
	TextValue string `protobuf:"bytes,2,opt,name=textValue,proto3,oneof"`
}

type TermRangeQuery added in v0.39.0 

type TermRangeQuery struct {

	// The field to search
	Field string `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
	// The lower bound of the range
	LowerTerm string `protobuf:"bytes,2,opt,name=lower_term,json=lowerTerm,proto3" json:"lower_term,omitempty"`
	// The upper bound of the range
	UpperTerm string `protobuf:"bytes,3,opt,name=upper_term,json=upperTerm,proto3" json:"upper_term,omitempty"`
	// Whether to include the lower bound in the range
	IncludeLower bool `protobuf:"varint,4,opt,name=include_lower,json=includeLower,proto3" json:"include_lower,omitempty"`
	// Whether to include the upper bound in the range
	IncludeUpper bool `protobuf:"varint,5,opt,name=include_upper,json=includeUpper,proto3" json:"include_upper,omitempty"`
	// Method used to rewrite the query
	Rewrite RewriteMethod `protobuf:"varint,6,opt,name=rewrite,proto3,enum=luceneserver.RewriteMethod" json:"rewrite,omitempty"`
	// Specifies the size to use for the TOP_TERMS* rewrite methods
	RewriteTopTermsSize int32 `protobuf:"varint,7,opt,name=rewriteTopTermsSize,proto3" json:"rewriteTopTermsSize,omitempty"`
	// contains filtered or unexported fields
}

Define a message for TermRangeQuery

func (*TermRangeQuery) Descriptor deprecated added in v0.39.0 

func (*TermRangeQuery) Descriptor() ([]byte, []int)

Deprecated: Use TermRangeQuery.ProtoReflect.Descriptor instead.

func (*TermRangeQuery) GetField added in v0.39.0 

func (x *TermRangeQuery) GetField() string

func (*TermRangeQuery) GetIncludeLower added in v0.39.0 

func (x *TermRangeQuery) GetIncludeLower() bool

func (*TermRangeQuery) GetIncludeUpper added in v0.39.0 

func (x *TermRangeQuery) GetIncludeUpper() bool

func (*TermRangeQuery) GetLowerTerm added in v0.39.0 

func (x *TermRangeQuery) GetLowerTerm() string

func (*TermRangeQuery) GetRewrite added in v0.39.0 

func (x *TermRangeQuery) GetRewrite() RewriteMethod

func (*TermRangeQuery) GetRewriteTopTermsSize added in v0.39.0 

func (x *TermRangeQuery) GetRewriteTopTermsSize() int32

func (*TermRangeQuery) GetUpperTerm added in v0.39.0 

func (x *TermRangeQuery) GetUpperTerm() string

func (*TermRangeQuery) ProtoMessage added in v0.39.0 

func (*TermRangeQuery) ProtoMessage()

func (*TermRangeQuery) ProtoReflect added in v0.39.0 

func (x *TermRangeQuery) ProtoReflect() protoreflect.Message

func (*TermRangeQuery) Reset added in v0.39.0 

func (x *TermRangeQuery) Reset()

func (*TermRangeQuery) String added in v0.39.0 

func (x *TermRangeQuery) String() string

type TermVectors 

type TermVectors int32

Whether/how term vectors should be indexed 

const (
	// No term vectors are indexed
	TermVectors_NO_TERMVECTORS TermVectors = 0
	// Index terms only
	TermVectors_TERMS TermVectors = 1
	// Index terms and positions
	TermVectors_TERMS_POSITIONS TermVectors = 2
	// Index terms, positions and offsets
	TermVectors_TERMS_POSITIONS_OFFSETS TermVectors = 3
	// Index terms, positions, offsets and payloads
	TermVectors_TERMS_POSITIONS_OFFSETS_PAYLOADS TermVectors = 4
)

func (TermVectors) Descriptor 

func (TermVectors) Descriptor() protoreflect.EnumDescriptor

func (TermVectors) Enum 

func (x TermVectors) Enum() *TermVectors

func (TermVectors) EnumDescriptor deprecated 

func (TermVectors) EnumDescriptor() ([]byte, []int)

Deprecated: Use TermVectors.Descriptor instead.

func (TermVectors) Number 

func (x TermVectors) Number() protoreflect.EnumNumber

func (TermVectors) String 

func (x TermVectors) String() string

func (TermVectors) Type 

func (TermVectors) Type() protoreflect.EnumType

type TermsCollector 

type TermsCollector struct {

	// Types that are assignable to TermsSource:
	//
	//	*TermsCollector_Field
	//	*TermsCollector_Script
	TermsSource isTermsCollector_TermsSource `protobuf_oneof:"TermsSource"`
	// Maximum number of top terms to return
	Size int32 `protobuf:"varint,3,opt,name=size,proto3" json:"size,omitempty"`
	// How results Buckets should be ordered, defaults to descending Bucket _count
	Order *BucketOrder `protobuf:"bytes,4,opt,name=order,proto3" json:"order,omitempty"`
	// contains filtered or unexported fields
}

Definition of term aggregating collector

func (*TermsCollector) Descriptor deprecated 

func (*TermsCollector) Descriptor() ([]byte, []int)

Deprecated: Use TermsCollector.ProtoReflect.Descriptor instead.

func (*TermsCollector) GetField 

func (x *TermsCollector) GetField() string

func (*TermsCollector) GetOrder added in v0.23.0 

func (x *TermsCollector) GetOrder() *BucketOrder

func (*TermsCollector) GetScript 

func (x *TermsCollector) GetScript() *Script

func (*TermsCollector) GetSize 

func (x *TermsCollector) GetSize() int32

func (*TermsCollector) GetTermsSource 

func (m *TermsCollector) GetTermsSource() isTermsCollector_TermsSource

func (*TermsCollector) ProtoMessage 

func (*TermsCollector) ProtoMessage()

func (*TermsCollector) ProtoReflect 

func (x *TermsCollector) ProtoReflect() protoreflect.Message

func (*TermsCollector) Reset 

func (x *TermsCollector) Reset()

func (*TermsCollector) String 

func (x *TermsCollector) String() string

type TermsCollector_Field 

type TermsCollector_Field struct {
	// Use field values for terms
	Field string `protobuf:"bytes,1,opt,name=field,proto3,oneof"`
}

type TermsCollector_Script 

type TermsCollector_Script struct {
	// Use FacetScript definition to produce terms
	Script *Script `protobuf:"bytes,2,opt,name=script,proto3,oneof"`
}

type TextDocValuesType 

type TextDocValuesType int32

Type of doc values to use for storing text values 

const (
	// Unspecified doc values type, use field default
	TextDocValuesType_TEXT_DOC_VALUES_TYPE_UNSPECIFIED TextDocValuesType = 0
	// Binary doc values support text longer than 32766 bytes and are good when most values are unique or
	// you don't need to use sorting/aggregations on the field.
	TextDocValuesType_TEXT_DOC_VALUES_TYPE_BINARY TextDocValuesType = 1
	// Sorted doc values only store values shorter than 32766 bytes and are better when many values are not unique.
	TextDocValuesType_TEXT_DOC_VALUES_TYPE_SORTED TextDocValuesType = 2
)

func (TextDocValuesType) Descriptor 

func (TextDocValuesType) Descriptor() protoreflect.EnumDescriptor

func (TextDocValuesType) Enum 

func (x TextDocValuesType) Enum() *TextDocValuesType

func (TextDocValuesType) EnumDescriptor deprecated 

func (TextDocValuesType) EnumDescriptor() ([]byte, []int)

Deprecated: Use TextDocValuesType.Descriptor instead.

func (TextDocValuesType) Number 

func (x TextDocValuesType) Number() protoreflect.EnumNumber

func (TextDocValuesType) String 

func (x TextDocValuesType) String() string

func (TextDocValuesType) Type 

func (TextDocValuesType) Type() protoreflect.EnumType

type TopHitsCollector added in v0.13.0 

type TopHitsCollector struct {

	// Offset for retrieval of top hits
	StartHit int32 `protobuf:"varint,1,opt,name=startHit,proto3" json:"startHit,omitempty"`
	// Total hits to collect, note that the number of hits returned is (topHits - startHit)
	TopHits int32 `protobuf:"varint,2,opt,name=topHits,proto3" json:"topHits,omitempty"`
	// When specified, collector does sort based collection. Otherwise, relevance score is used
	QuerySort *QuerySortField `protobuf:"bytes,3,opt,name=querySort,proto3" json:"querySort,omitempty"`
	// Which fields to retrieve
	RetrieveFields []string `protobuf:"bytes,4,rep,name=retrieveFields,proto3" json:"retrieveFields,omitempty"`
	// If Lucene explanation should be included in the collector response
	Explain bool `protobuf:"varint,5,opt,name=explain,proto3" json:"explain,omitempty"`
	// contains filtered or unexported fields
}

Definition of top hits based collector

func (*TopHitsCollector) Descriptor deprecated added in v0.13.0 

func (*TopHitsCollector) Descriptor() ([]byte, []int)

Deprecated: Use TopHitsCollector.ProtoReflect.Descriptor instead.

func (*TopHitsCollector) GetExplain added in v0.23.0 

func (x *TopHitsCollector) GetExplain() bool

func (*TopHitsCollector) GetQuerySort added in v0.13.0 

func (x *TopHitsCollector) GetQuerySort() *QuerySortField

func (*TopHitsCollector) GetRetrieveFields added in v0.13.0 

func (x *TopHitsCollector) GetRetrieveFields() []string

func (*TopHitsCollector) GetStartHit added in v0.13.0 

func (x *TopHitsCollector) GetStartHit() int32

func (*TopHitsCollector) GetTopHits added in v0.13.0 

func (x *TopHitsCollector) GetTopHits() int32

func (*TopHitsCollector) ProtoMessage added in v0.13.0 

func (*TopHitsCollector) ProtoMessage()

func (*TopHitsCollector) ProtoReflect added in v0.13.0 

func (x *TopHitsCollector) ProtoReflect() protoreflect.Message

func (*TopHitsCollector) Reset added in v0.13.0 

func (x *TopHitsCollector) Reset()

func (*TopHitsCollector) String added in v0.13.0 

func (x *TopHitsCollector) String() string

type TotalHits 

type TotalHits struct {
	Relation TotalHits_Relation `protobuf:"varint,1,opt,name=relation,proto3,enum=luceneserver.TotalHits_Relation" json:"relation,omitempty"`
	// The value of the total hit count. Must be interpreted in the context of {#relation}.
	Value int64 `protobuf:"varint,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Query total hits

func (*TotalHits) Descriptor deprecated 

func (*TotalHits) Descriptor() ([]byte, []int)

Deprecated: Use TotalHits.ProtoReflect.Descriptor instead.

func (*TotalHits) GetRelation 

func (x *TotalHits) GetRelation() TotalHits_Relation

func (*TotalHits) GetValue 

func (x *TotalHits) GetValue() int64

func (*TotalHits) ProtoMessage 

func (*TotalHits) ProtoMessage()

func (*TotalHits) ProtoReflect 

func (x *TotalHits) ProtoReflect() protoreflect.Message

func (*TotalHits) Reset 

func (x *TotalHits) Reset()

func (*TotalHits) String 

func (x *TotalHits) String() string

type TotalHits_Relation 

type TotalHits_Relation int32

How the {TotalHits#value} should be interpreted 

const (
	// The total hit count is equal to {@link TotalHits#value}
	TotalHits_EQUAL_TO TotalHits_Relation = 0
	// The total hit count is greater than or equal to {@link TotalHits#value}
	TotalHits_GREATER_THAN_OR_EQUAL_TO TotalHits_Relation = 1
)

func (TotalHits_Relation) Descriptor 

func (TotalHits_Relation) Descriptor() protoreflect.EnumDescriptor

func (TotalHits_Relation) Enum 

func (x TotalHits_Relation) Enum() *TotalHits_Relation

func (TotalHits_Relation) EnumDescriptor deprecated 

func (TotalHits_Relation) EnumDescriptor() ([]byte, []int)

Deprecated: Use TotalHits_Relation.Descriptor instead.

func (TotalHits_Relation) Number 

func (x TotalHits_Relation) Number() protoreflect.EnumNumber

func (TotalHits_Relation) String 

func (x TotalHits_Relation) String() string

func (TotalHits_Relation) Type 

func (TotalHits_Relation) Type() protoreflect.EnumType

type TransferStatus 

type TransferStatus struct {

	// Response message
	Message string `protobuf:"bytes,1,opt,name=Message,proto3" json:"Message,omitempty"`
	// Transfer status code
	Code TransferStatusCode `protobuf:"varint,2,opt,name=Code,proto3,enum=luceneserver.TransferStatusCode" json:"Code,omitempty"`
	// contains filtered or unexported fields
}

Response with transfer status

func (*TransferStatus) Descriptor deprecated 

func (*TransferStatus) Descriptor() ([]byte, []int)

Deprecated: Use TransferStatus.ProtoReflect.Descriptor instead.

func (*TransferStatus) GetCode 

func (x *TransferStatus) GetCode() TransferStatusCode

func (*TransferStatus) GetMessage 

func (x *TransferStatus) GetMessage() string

func (*TransferStatus) ProtoMessage 

func (*TransferStatus) ProtoMessage()

func (*TransferStatus) ProtoReflect 

func (x *TransferStatus) ProtoReflect() protoreflect.Message

func (*TransferStatus) Reset 

func (x *TransferStatus) Reset()

func (*TransferStatus) String 

func (x *TransferStatus) String() string

type TransferStatusCode 

type TransferStatusCode int32

Status of file copy 

const (
	TransferStatusCode_Unknown TransferStatusCode = 0
	TransferStatusCode_Done    TransferStatusCode = 1
	TransferStatusCode_Failed  TransferStatusCode = 2
	TransferStatusCode_Ongoing TransferStatusCode = 3
)

func (TransferStatusCode) Descriptor 

func (TransferStatusCode) Descriptor() protoreflect.EnumDescriptor

func (TransferStatusCode) Enum 

func (x TransferStatusCode) Enum() *TransferStatusCode

func (TransferStatusCode) EnumDescriptor deprecated 

func (TransferStatusCode) EnumDescriptor() ([]byte, []int)

Deprecated: Use TransferStatusCode.Descriptor instead.

func (TransferStatusCode) Number 

func (x TransferStatusCode) Number() protoreflect.EnumNumber

func (TransferStatusCode) String 

func (x TransferStatusCode) String() string

func (TransferStatusCode) Type 

func (TransferStatusCode) Type() protoreflect.EnumType

type UnimplementedLuceneServerServer 

type UnimplementedLuceneServerServer struct {
}

UnimplementedLuceneServerServer can be embedded to have forward compatible implementations.

func (*UnimplementedLuceneServerServer) AddDocuments 

func (*UnimplementedLuceneServerServer) AddDocuments(LuceneServer_AddDocumentsServer) error

func (*UnimplementedLuceneServerServer) BackupWarmingQueries 

func (*UnimplementedLuceneServerServer) BackupWarmingQueries(context.Context, *BackupWarmingQueriesRequest) (*BackupWarmingQueriesResponse, error)

func (*UnimplementedLuceneServerServer) Commit 

func (*UnimplementedLuceneServerServer) Commit(context.Context, *CommitRequest) (*CommitResponse, error)

func (*UnimplementedLuceneServerServer) CreateIndex 

func (*UnimplementedLuceneServerServer) CreateIndex(context.Context, *CreateIndexRequest) (*CreateIndexResponse, error)

func (*UnimplementedLuceneServerServer) CreateSnapshot 

func (*UnimplementedLuceneServerServer) CreateSnapshot(context.Context, *CreateSnapshotRequest) (*CreateSnapshotResponse, error)

func (*UnimplementedLuceneServerServer) Custom added in v0.11.0 

func (*UnimplementedLuceneServerServer) Custom(context.Context, *CustomRequest) (*CustomResponse, error)

func (*UnimplementedLuceneServerServer) Delete 

func (*UnimplementedLuceneServerServer) Delete(context.Context, *AddDocumentRequest) (*AddDocumentResponse, error)

func (*UnimplementedLuceneServerServer) DeleteAll 

func (*UnimplementedLuceneServerServer) DeleteAll(context.Context, *DeleteAllDocumentsRequest) (*DeleteAllDocumentsResponse, error)

func (*UnimplementedLuceneServerServer) DeleteByQuery 

func (*UnimplementedLuceneServerServer) DeleteByQuery(context.Context, *DeleteByQueryRequest) (*AddDocumentResponse, error)

func (*UnimplementedLuceneServerServer) DeleteIndex 

func (*UnimplementedLuceneServerServer) DeleteIndex(context.Context, *DeleteIndexRequest) (*DeleteIndexResponse, error)

func (*UnimplementedLuceneServerServer) ForceMerge 

func (*UnimplementedLuceneServerServer) ForceMerge(context.Context, *ForceMergeRequest) (*ForceMergeResponse, error)

func (*UnimplementedLuceneServerServer) ForceMergeDeletes 

func (*UnimplementedLuceneServerServer) ForceMergeDeletes(context.Context, *ForceMergeDeletesRequest) (*ForceMergeDeletesResponse, error)

func (*UnimplementedLuceneServerServer) GetAllSnapshotIndexGen 

func (*UnimplementedLuceneServerServer) GetAllSnapshotIndexGen(context.Context, *GetAllSnapshotGenRequest) (*GetAllSnapshotGenResponse, error)

func (*UnimplementedLuceneServerServer) GlobalState 

func (*UnimplementedLuceneServerServer) GlobalState(context.Context, *GlobalStateRequest) (*GlobalStateResponse, error)

func (*UnimplementedLuceneServerServer) IndexState 

func (*UnimplementedLuceneServerServer) IndexState(context.Context, *IndexStateRequest) (*IndexStateResponse, error)

func (*UnimplementedLuceneServerServer) Indices 

func (*UnimplementedLuceneServerServer) Indices(context.Context, *IndicesRequest) (*IndicesResponse, error)

func (*UnimplementedLuceneServerServer) LiveSettings 

func (*UnimplementedLuceneServerServer) LiveSettings(context.Context, *LiveSettingsRequest) (*LiveSettingsResponse, error)

func (*UnimplementedLuceneServerServer) LiveSettingsV2 added in v0.11.0 

func (*UnimplementedLuceneServerServer) LiveSettingsV2(context.Context, *LiveSettingsV2Request) (*LiveSettingsV2Response, error)

func (*UnimplementedLuceneServerServer) Metrics 

func (*UnimplementedLuceneServerServer) Metrics(context.Context, *emptypb.Empty) (*httpbody.HttpBody, error)

func (*UnimplementedLuceneServerServer) NodeInfo 

func (*UnimplementedLuceneServerServer) NodeInfo(context.Context, *NodeInfoRequest) (*NodeInfoResponse, error)

func (*UnimplementedLuceneServerServer) Ready 

func (*UnimplementedLuceneServerServer) Ready(context.Context, *ReadyCheckRequest) (*HealthCheckResponse, error)

func (*UnimplementedLuceneServerServer) Refresh 

func (*UnimplementedLuceneServerServer) Refresh(context.Context, *RefreshRequest) (*RefreshResponse, error)

func (*UnimplementedLuceneServerServer) RegisterFields 

func (*UnimplementedLuceneServerServer) RegisterFields(context.Context, *FieldDefRequest) (*FieldDefResponse, error)

func (*UnimplementedLuceneServerServer) ReleaseSnapshot 

func (*UnimplementedLuceneServerServer) ReleaseSnapshot(context.Context, *ReleaseSnapshotRequest) (*ReleaseSnapshotResponse, error)

func (*UnimplementedLuceneServerServer) ReloadState added in v0.13.0 

func (*UnimplementedLuceneServerServer) ReloadState(context.Context, *ReloadStateRequest) (*ReloadStateResponse, error)

func (*UnimplementedLuceneServerServer) Search 

func (*UnimplementedLuceneServerServer) Search(context.Context, *SearchRequest) (*SearchResponse, error)

func (*UnimplementedLuceneServerServer) SearchV2 

func (*UnimplementedLuceneServerServer) SearchV2(context.Context, *SearchRequest) (*anypb.Any, error)

func (*UnimplementedLuceneServerServer) Settings 

func (*UnimplementedLuceneServerServer) Settings(context.Context, *SettingsRequest) (*SettingsResponse, error)

func (*UnimplementedLuceneServerServer) SettingsV2 added in v0.11.0 

func (*UnimplementedLuceneServerServer) SettingsV2(context.Context, *SettingsV2Request) (*SettingsV2Response, error)

func (*UnimplementedLuceneServerServer) StartIndex 

func (*UnimplementedLuceneServerServer) StartIndex(context.Context, *StartIndexRequest) (*StartIndexResponse, error)

func (*UnimplementedLuceneServerServer) StartIndexV2 added in v0.18.0 

func (*UnimplementedLuceneServerServer) StartIndexV2(context.Context, *StartIndexV2Request) (*StartIndexResponse, error)

func (*UnimplementedLuceneServerServer) State 

func (*UnimplementedLuceneServerServer) State(context.Context, *StateRequest) (*StateResponse, error)

func (*UnimplementedLuceneServerServer) Stats 

func (*UnimplementedLuceneServerServer) Stats(context.Context, *StatsRequest) (*StatsResponse, error)

func (*UnimplementedLuceneServerServer) Status 

func (*UnimplementedLuceneServerServer) Status(context.Context, *HealthCheckRequest) (*HealthCheckResponse, error)

func (*UnimplementedLuceneServerServer) StopIndex 

func (*UnimplementedLuceneServerServer) StopIndex(context.Context, *StopIndexRequest) (*DummyResponse, error)

func (*UnimplementedLuceneServerServer) UpdateFields 

func (*UnimplementedLuceneServerServer) UpdateFields(context.Context, *FieldDefRequest) (*FieldDefResponse, error)

type UnimplementedReplicationServerServer 

type UnimplementedReplicationServerServer struct {
}

UnimplementedReplicationServerServer can be embedded to have forward compatible implementations.

func (*UnimplementedReplicationServerServer) AddReplicas 

func (*UnimplementedReplicationServerServer) AddReplicas(context.Context, *AddReplicaRequest) (*AddReplicaResponse, error)

func (*UnimplementedReplicationServerServer) CopyFiles 

func (*UnimplementedReplicationServerServer) CopyFiles(*CopyFiles, ReplicationServer_CopyFilesServer) error

func (*UnimplementedReplicationServerServer) GetConnectedNodes 

func (*UnimplementedReplicationServerServer) GetConnectedNodes(context.Context, *GetNodesRequest) (*GetNodesResponse, error)

func (*UnimplementedReplicationServerServer) GetCurrentSearcherVersion 

func (*UnimplementedReplicationServerServer) GetCurrentSearcherVersion(context.Context, *IndexName) (*SearcherVersion, error)

func (*UnimplementedReplicationServerServer) NewNRTPoint 

func (*UnimplementedReplicationServerServer) NewNRTPoint(context.Context, *NewNRTPoint) (*TransferStatus, error)

func (*UnimplementedReplicationServerServer) RecvCopyState 

func (*UnimplementedReplicationServerServer) RecvCopyState(context.Context, *CopyStateRequest) (*CopyState, error)

func (*UnimplementedReplicationServerServer) RecvRawFile 

func (*UnimplementedReplicationServerServer) RecvRawFile(*FileInfo, ReplicationServer_RecvRawFileServer) error

func (*UnimplementedReplicationServerServer) RecvRawFileV2 

func (*UnimplementedReplicationServerServer) RecvRawFileV2(ReplicationServer_RecvRawFileV2Server) error

func (*UnimplementedReplicationServerServer) SendRawFile 

func (*UnimplementedReplicationServerServer) SendRawFile(ReplicationServer_SendRawFileServer) error

func (*UnimplementedReplicationServerServer) WriteNRTPoint 

func (*UnimplementedReplicationServerServer) WriteNRTPoint(context.Context, *IndexName) (*SearcherVersion, error)

type VectorElementType 

type VectorElementType int32

Vector field element type 

const (
	// Single precision floating point
	VectorElementType_VECTOR_ELEMENT_FLOAT VectorElementType = 0
	// Signed byte
	VectorElementType_VECTOR_ELEMENT_BYTE VectorElementType = 1
)

func (VectorElementType) Descriptor 

func (VectorElementType) Descriptor() protoreflect.EnumDescriptor

func (VectorElementType) Enum 

func (x VectorElementType) Enum() *VectorElementType

func (VectorElementType) EnumDescriptor deprecated 

func (VectorElementType) EnumDescriptor() ([]byte, []int)

Deprecated: Use VectorElementType.Descriptor instead.

func (VectorElementType) Number 

func (x VectorElementType) Number() protoreflect.EnumNumber

func (VectorElementType) String 

func (x VectorElementType) String() string

func (VectorElementType) Type 

func (VectorElementType) Type() protoreflect.EnumType

type VectorIndexingOptions 

type VectorIndexingOptions struct {

	// The vector indexing type, supports 'hnsw' and 'hnsw_scalar_quantized', default: hnsw
	Type *string `protobuf:"bytes,1,opt,name=type,proto3,oneof" json:"type,omitempty"`
	// The number of neighbors each node will be connected to in the HNSW graph, default: 16
	HnswM *int32 `protobuf:"varint,2,opt,name=hnsw_m,json=hnswM,proto3,oneof" json:"hnsw_m,omitempty"`
	// The number of candidates to track while assembling the list of nearest neighbors for each new node, default: 100
	HnswEfConstruction *int32 `protobuf:"varint,3,opt,name=hnsw_ef_construction,json=hnswEfConstruction,proto3,oneof" json:"hnsw_ef_construction,omitempty"`
	// Number of threads to use for merging vector data, default: 1
	MergeWorkers *int32 `protobuf:"varint,4,opt,name=merge_workers,json=mergeWorkers,proto3,oneof" json:"merge_workers,omitempty"`
	// The confidenceInterval for scalar quantizing the vectors. When unset, it is calculated based on the
	// vector dimension. When `0`, the quantiles are dynamically determined by sampling many confidence intervals and
	// determining the most accurate pair. Otherwise, the value must be between 0.9 and 1.0 (both inclusive).
	// default: unset
	QuantizedConfidenceInterval *float32 `` /* 152-byte string literal not displayed */
	// The number of bits to use for quantizing the vectors. It can have the following values:
	//
	//	4 - half byte
	//	7 - signed byte (default)
	QuantizedBits *int32 `protobuf:"varint,6,opt,name=quantized_bits,json=quantizedBits,proto3,oneof" json:"quantized_bits,omitempty"`
	// Whether to compress the vectors, if true, the vectors that are quantized with <= 4 bits will be compressed into
	// a single byte. If false, the vectors will be stored as is. This provides a trade-off of memory usage and speed.
	// default: false
	QuantizedCompress *bool `protobuf:"varint,7,opt,name=quantized_compress,json=quantizedCompress,proto3,oneof" json:"quantized_compress,omitempty"`
	// contains filtered or unexported fields
}

Options for indexing a VECTOR field for search

func (*VectorIndexingOptions) Descriptor deprecated 

func (*VectorIndexingOptions) Descriptor() ([]byte, []int)

Deprecated: Use VectorIndexingOptions.ProtoReflect.Descriptor instead.

func (*VectorIndexingOptions) GetHnswEfConstruction 

func (x *VectorIndexingOptions) GetHnswEfConstruction() int32

func (*VectorIndexingOptions) GetHnswM 

func (x *VectorIndexingOptions) GetHnswM() int32

func (*VectorIndexingOptions) GetMergeWorkers 

func (x *VectorIndexingOptions) GetMergeWorkers() int32

func (*VectorIndexingOptions) GetQuantizedBits 

func (x *VectorIndexingOptions) GetQuantizedBits() int32

func (*VectorIndexingOptions) GetQuantizedCompress 

func (x *VectorIndexingOptions) GetQuantizedCompress() bool

func (*VectorIndexingOptions) GetQuantizedConfidenceInterval 

func (x *VectorIndexingOptions) GetQuantizedConfidenceInterval() float32

func (*VectorIndexingOptions) GetType 

func (x *VectorIndexingOptions) GetType() string

func (*VectorIndexingOptions) ProtoMessage 

func (*VectorIndexingOptions) ProtoMessage()

func (*VectorIndexingOptions) ProtoReflect 

func (x *VectorIndexingOptions) ProtoReflect() protoreflect.Message

func (*VectorIndexingOptions) Reset 

func (x *VectorIndexingOptions) Reset()

func (*VectorIndexingOptions) String 

func (x *VectorIndexingOptions) String() string

type VirtualField 

type VirtualField struct {

	// Script defining this field's values
	Script *Script `protobuf:"bytes,1,opt,name=script,proto3" json:"script,omitempty"`
	// Virtual field's name. Must be different from registered fields and any other virtual fields.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Virtual field used during search

func (*VirtualField) Descriptor deprecated 

func (*VirtualField) Descriptor() ([]byte, []int)

Deprecated: Use VirtualField.ProtoReflect.Descriptor instead.

func (*VirtualField) GetName 

func (x *VirtualField) GetName() string

func (*VirtualField) GetScript 

func (x *VirtualField) GetScript() *Script

func (*VirtualField) ProtoMessage 

func (*VirtualField) ProtoMessage()

func (*VirtualField) ProtoReflect 

func (x *VirtualField) ProtoReflect() protoreflect.Message

func (*VirtualField) Reset 

func (x *VirtualField) Reset()

func (*VirtualField) String 

func (x *VirtualField) String() string

type WildcardQuery added in v0.39.0 

type WildcardQuery struct {

	// Field in the document to query
	Field string `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
	// Pattern to search for
	Text string `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
	// Method used to rewrite the query
	Rewrite RewriteMethod `protobuf:"varint,3,opt,name=rewrite,proto3,enum=luceneserver.RewriteMethod" json:"rewrite,omitempty"`
	// Specifies the size to use for the TOP_TERMS* rewrite methods
	RewriteTopTermsSize int32 `protobuf:"varint,4,opt,name=rewriteTopTermsSize,proto3" json:"rewriteTopTermsSize,omitempty"`
	// contains filtered or unexported fields
}

A query that matches documents containing terms matching a pattern

func (*WildcardQuery) Descriptor deprecated added in v0.39.0 

func (*WildcardQuery) Descriptor() ([]byte, []int)

Deprecated: Use WildcardQuery.ProtoReflect.Descriptor instead.

func (*WildcardQuery) GetField added in v0.39.0 

func (x *WildcardQuery) GetField() string

func (*WildcardQuery) GetRewrite added in v0.39.0 

func (x *WildcardQuery) GetRewrite() RewriteMethod

func (*WildcardQuery) GetRewriteTopTermsSize added in v0.39.0 

func (x *WildcardQuery) GetRewriteTopTermsSize() int32

func (*WildcardQuery) GetText added in v0.39.0 

func (x *WildcardQuery) GetText() string

func (*WildcardQuery) ProtoMessage added in v0.39.0 

func (*WildcardQuery) ProtoMessage()

func (*WildcardQuery) ProtoReflect added in v0.39.0 

func (x *WildcardQuery) ProtoReflect() protoreflect.Message

func (*WildcardQuery) Reset added in v0.39.0 

func (x *WildcardQuery) Reset()

func (*WildcardQuery) String added in v0.39.0 

func (x *WildcardQuery) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.