seqproxyapi

package
v0.48.1 Latest Latest
Warning

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

Go to latest
Published: Dec 24, 2025 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

View Source
const (
	SeqProxyApi_Search_FullMethodName                 = "/seqproxyapi.v1.SeqProxyApi/Search"
	SeqProxyApi_ComplexSearch_FullMethodName          = "/seqproxyapi.v1.SeqProxyApi/ComplexSearch"
	SeqProxyApi_GetAggregation_FullMethodName         = "/seqproxyapi.v1.SeqProxyApi/GetAggregation"
	SeqProxyApi_GetHistogram_FullMethodName           = "/seqproxyapi.v1.SeqProxyApi/GetHistogram"
	SeqProxyApi_Fetch_FullMethodName                  = "/seqproxyapi.v1.SeqProxyApi/Fetch"
	SeqProxyApi_Mapping_FullMethodName                = "/seqproxyapi.v1.SeqProxyApi/Mapping"
	SeqProxyApi_Status_FullMethodName                 = "/seqproxyapi.v1.SeqProxyApi/Status"
	SeqProxyApi_Export_FullMethodName                 = "/seqproxyapi.v1.SeqProxyApi/Export"
	SeqProxyApi_StartAsyncSearch_FullMethodName       = "/seqproxyapi.v1.SeqProxyApi/StartAsyncSearch"
	SeqProxyApi_FetchAsyncSearchResult_FullMethodName = "/seqproxyapi.v1.SeqProxyApi/FetchAsyncSearchResult"
	SeqProxyApi_CancelAsyncSearch_FullMethodName      = "/seqproxyapi.v1.SeqProxyApi/CancelAsyncSearch"
	SeqProxyApi_DeleteAsyncSearch_FullMethodName      = "/seqproxyapi.v1.SeqProxyApi/DeleteAsyncSearch"
	SeqProxyApi_GetAsyncSearchesList_FullMethodName   = "/seqproxyapi.v1.SeqProxyApi/GetAsyncSearchesList"
)

Variables

View Source
var (
	ErrorCode_name = map[int32]string{
		0: "ERROR_CODE_UNSPECIFIED",
		1: "ERROR_CODE_NO",
		2: "ERROR_CODE_PARTIAL_RESPONSE",
		3: "ERROR_CODE_TOO_MANY_FRACTIONS_HIT",
	}
	ErrorCode_value = map[string]int32{
		"ERROR_CODE_UNSPECIFIED":            0,
		"ERROR_CODE_NO":                     1,
		"ERROR_CODE_PARTIAL_RESPONSE":       2,
		"ERROR_CODE_TOO_MANY_FRACTIONS_HIT": 3,
	}
)

Enum value maps for ErrorCode.

View Source
var (
	AggFunc_name = map[int32]string{
		0: "AGG_FUNC_COUNT",
		1: "AGG_FUNC_SUM",
		2: "AGG_FUNC_MIN",
		3: "AGG_FUNC_MAX",
		4: "AGG_FUNC_AVG",
		5: "AGG_FUNC_QUANTILE",
		6: "AGG_FUNC_UNIQUE",
	}
	AggFunc_value = map[string]int32{
		"AGG_FUNC_COUNT":    0,
		"AGG_FUNC_SUM":      1,
		"AGG_FUNC_MIN":      2,
		"AGG_FUNC_MAX":      3,
		"AGG_FUNC_AVG":      4,
		"AGG_FUNC_QUANTILE": 5,
		"AGG_FUNC_UNIQUE":   6,
	}
)

Enum value maps for AggFunc.

View Source
var (
	Order_name = map[int32]string{
		0: "ORDER_DESC",
		1: "ORDER_ASC",
	}
	Order_value = map[string]int32{
		"ORDER_DESC": 0,
		"ORDER_ASC":  1,
	}
)

Enum value maps for Order.

View Source
var (
	AsyncSearchStatus_name = map[int32]string{
		0: "AsyncSearchStatusInProgress",
		1: "AsyncSearchStatusDone",
		2: "AsyncSearchStatusCanceled",
		3: "AsyncSearchStatusError",
	}
	AsyncSearchStatus_value = map[string]int32{
		"AsyncSearchStatusInProgress": 0,
		"AsyncSearchStatusDone":       1,
		"AsyncSearchStatusCanceled":   2,
		"AsyncSearchStatusError":      3,
	}
)

Enum value maps for AsyncSearchStatus.

View Source
var File_v1_seq_proxy_api_proto protoreflect.FileDescriptor
View Source
var SeqProxyApi_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "seqproxyapi.v1.SeqProxyApi",
	HandlerType: (*SeqProxyApiServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Search",
			Handler:    _SeqProxyApi_Search_Handler,
		},
		{
			MethodName: "ComplexSearch",
			Handler:    _SeqProxyApi_ComplexSearch_Handler,
		},
		{
			MethodName: "GetAggregation",
			Handler:    _SeqProxyApi_GetAggregation_Handler,
		},
		{
			MethodName: "GetHistogram",
			Handler:    _SeqProxyApi_GetHistogram_Handler,
		},
		{
			MethodName: "Mapping",
			Handler:    _SeqProxyApi_Mapping_Handler,
		},
		{
			MethodName: "Status",
			Handler:    _SeqProxyApi_Status_Handler,
		},
		{
			MethodName: "StartAsyncSearch",
			Handler:    _SeqProxyApi_StartAsyncSearch_Handler,
		},
		{
			MethodName: "FetchAsyncSearchResult",
			Handler:    _SeqProxyApi_FetchAsyncSearchResult_Handler,
		},
		{
			MethodName: "CancelAsyncSearch",
			Handler:    _SeqProxyApi_CancelAsyncSearch_Handler,
		},
		{
			MethodName: "DeleteAsyncSearch",
			Handler:    _SeqProxyApi_DeleteAsyncSearch_Handler,
		},
		{
			MethodName: "GetAsyncSearchesList",
			Handler:    _SeqProxyApi_GetAsyncSearchesList_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "Fetch",
			Handler:       _SeqProxyApi_Fetch_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "Export",
			Handler:       _SeqProxyApi_Export_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "v1/seq_proxy_api.proto",
}

SeqProxyApi_ServiceDesc is the grpc.ServiceDesc for SeqProxyApi service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterSeqProxyApiServer

func RegisterSeqProxyApiServer(s grpc.ServiceRegistrar, srv SeqProxyApiServer)

Types

type AggFunc

type AggFunc int32

Aggregation function used in request.

const (
	AggFunc_AGG_FUNC_COUNT    AggFunc = 0 // Returns how many times `field` was equal to particular value.
	AggFunc_AGG_FUNC_SUM      AggFunc = 1 // Performs an addition operation on `field`, among documents with same `group_by` field.
	AggFunc_AGG_FUNC_MIN      AggFunc = 2 // Finds minimum value for `field`, among documents with same `group_by` field.
	AggFunc_AGG_FUNC_MAX      AggFunc = 3 // Finds maximum value for `field`, among documents with same `group_by` field.
	AggFunc_AGG_FUNC_AVG      AggFunc = 4 // Finds average value for `field`, among documents with same `group_by` field.
	AggFunc_AGG_FUNC_QUANTILE AggFunc = 5 // Finds quantiles for `field`, among documents with same `group_by` field.
	AggFunc_AGG_FUNC_UNIQUE   AggFunc = 6 // Finds unique values for `group_by` field.
)

func (AggFunc) Descriptor

func (AggFunc) Descriptor() protoreflect.EnumDescriptor

func (AggFunc) Enum

func (x AggFunc) Enum() *AggFunc

func (AggFunc) EnumDescriptor deprecated

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

Deprecated: Use AggFunc.Descriptor instead.

func (AggFunc) Number

func (x AggFunc) Number() protoreflect.EnumNumber

func (AggFunc) String

func (x AggFunc) String() string

func (AggFunc) Type

func (AggFunc) Type() protoreflect.EnumType

type AggQuery

type AggQuery struct {
	Field     string    `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`                            // Field over which aggregation function is used on.
	GroupBy   string    `protobuf:"bytes,3,opt,name=group_by,json=groupBy,proto3" json:"group_by,omitempty"`         // Field over which to create group for further aggregation.
	Func      AggFunc   `protobuf:"varint,4,opt,name=func,proto3,enum=seqproxyapi.v1.AggFunc" json:"func,omitempty"` // Function to apply on aggregated field.
	Quantiles []float64 `protobuf:"fixed64,5,rep,packed,name=quantiles,proto3" json:"quantiles,omitempty"`           // Field used only for `AGG_FUNC_QUANTILE`. Represents list of quantiles to calculate.
	Interval  *string   `protobuf:"bytes,6,opt,name=interval,proto3,oneof" json:"interval,omitempty"`                // Field used only for time series.
	// contains filtered or unexported fields
}

Aggregation query. Generally uses `field` and `group_by`, for details, refer to AggFunc definition.

func (*AggQuery) Descriptor deprecated

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

Deprecated: Use AggQuery.ProtoReflect.Descriptor instead.

func (*AggQuery) GetField

func (x *AggQuery) GetField() string

func (*AggQuery) GetFunc

func (x *AggQuery) GetFunc() AggFunc

func (*AggQuery) GetGroupBy

func (x *AggQuery) GetGroupBy() string

func (*AggQuery) GetInterval

func (x *AggQuery) GetInterval() string

func (*AggQuery) GetQuantiles

func (x *AggQuery) GetQuantiles() []float64

func (*AggQuery) ProtoMessage

func (*AggQuery) ProtoMessage()

func (*AggQuery) ProtoReflect

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

func (*AggQuery) Reset

func (x *AggQuery) Reset()

func (*AggQuery) String

func (x *AggQuery) String() string

type Aggregation

type Aggregation struct {
	Buckets   []*Aggregation_Bucket `protobuf:"bytes,1,rep,name=buckets,proto3" json:"buckets,omitempty"`                       // List of aggregations for given request.
	NotExists int64                 `protobuf:"varint,2,opt,name=not_exists,json=notExists,proto3" json:"not_exists,omitempty"` // Number of documents in which such field does not exist
	// contains filtered or unexported fields
}

Aggregation response.

func (*Aggregation) Descriptor deprecated

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

Deprecated: Use Aggregation.ProtoReflect.Descriptor instead.

func (*Aggregation) GetBuckets

func (x *Aggregation) GetBuckets() []*Aggregation_Bucket

func (*Aggregation) GetNotExists

func (x *Aggregation) GetNotExists() int64

func (*Aggregation) ProtoMessage

func (*Aggregation) ProtoMessage()

func (*Aggregation) ProtoReflect

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

func (*Aggregation) Reset

func (x *Aggregation) Reset()

func (*Aggregation) String

func (x *Aggregation) String() string

type Aggregation_Bucket

type Aggregation_Bucket struct {
	Key       string                 `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`                               // Field name.
	Value     float64                `protobuf:"fixed64,3,opt,name=value,proto3" json:"value,omitempty"`                         // Calculated aggregation value.
	NotExists int64                  `protobuf:"varint,4,opt,name=not_exists,json=notExists,proto3" json:"not_exists,omitempty"` // Number of documents without presence of that field.
	Quantiles []float64              `protobuf:"fixed64,5,rep,packed,name=quantiles,proto3" json:"quantiles,omitempty"`          // Value of quantiles for given request. Returned when quantiles aggregation func used.
	Ts        *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=ts,proto3,oneof" json:"ts,omitempty"`                           // Will be used to determine bin of time series.
	// contains filtered or unexported fields
}

Key-value pair containing result of single aggregation.

func (*Aggregation_Bucket) Descriptor deprecated

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

Deprecated: Use Aggregation_Bucket.ProtoReflect.Descriptor instead.

func (*Aggregation_Bucket) GetKey

func (x *Aggregation_Bucket) GetKey() string

func (*Aggregation_Bucket) GetNotExists

func (x *Aggregation_Bucket) GetNotExists() int64

func (*Aggregation_Bucket) GetQuantiles

func (x *Aggregation_Bucket) GetQuantiles() []float64

func (*Aggregation_Bucket) GetTs

func (*Aggregation_Bucket) GetValue

func (x *Aggregation_Bucket) GetValue() float64

func (*Aggregation_Bucket) ProtoMessage

func (*Aggregation_Bucket) ProtoMessage()

func (*Aggregation_Bucket) ProtoReflect

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

func (*Aggregation_Bucket) Reset

func (x *Aggregation_Bucket) Reset()

func (*Aggregation_Bucket) String

func (x *Aggregation_Bucket) String() string

type AsyncSearchStatus

type AsyncSearchStatus int32
const (
	// The asynchronous search is still in progress.
	// See the 'progress' field for completion percentage.
	AsyncSearchStatus_AsyncSearchStatusInProgress AsyncSearchStatus = 0
	// The asynchronous search completed successfully.
	AsyncSearchStatus_AsyncSearchStatusDone AsyncSearchStatus = 1
	// The asynchronous search was canceled, possibly via the CancelAsyncSearch handler.
	AsyncSearchStatus_AsyncSearchStatusCanceled AsyncSearchStatus = 2
	// The asynchronous search encountered errors in some shards.
	// See ComplexSearchResponse.Error for details.
	AsyncSearchStatus_AsyncSearchStatusError AsyncSearchStatus = 3
)

func (AsyncSearchStatus) Descriptor

func (AsyncSearchStatus) Enum

func (AsyncSearchStatus) EnumDescriptor deprecated

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

Deprecated: Use AsyncSearchStatus.Descriptor instead.

func (AsyncSearchStatus) Number

func (AsyncSearchStatus) String

func (x AsyncSearchStatus) String() string

func (AsyncSearchStatus) Type

type AsyncSearchesListItem

type AsyncSearchesListItem struct {
	SearchId   string                   `protobuf:"bytes,1,opt,name=search_id,json=searchId,proto3" json:"search_id,omitempty"`
	Status     AsyncSearchStatus        `protobuf:"varint,2,opt,name=status,proto3,enum=seqproxyapi.v1.AsyncSearchStatus" json:"status,omitempty"`
	Request    *StartAsyncSearchRequest `protobuf:"bytes,3,opt,name=request,proto3" json:"request,omitempty"`
	StartedAt  *timestamppb.Timestamp   `protobuf:"bytes,4,opt,name=started_at,json=startedAt,proto3" json:"started_at,omitempty"`
	ExpiresAt  *timestamppb.Timestamp   `protobuf:"bytes,5,opt,name=expires_at,json=expiresAt,proto3" json:"expires_at,omitempty"`
	CanceledAt *timestamppb.Timestamp   `protobuf:"bytes,6,opt,name=canceled_at,json=canceledAt,proto3,oneof" json:"canceled_at,omitempty"`
	// Search progress in range [0, 1].
	Progress float64 `protobuf:"fixed64,7,opt,name=progress,proto3" json:"progress,omitempty"`
	// The size of data stored on disk, in bytes.
	DiskUsage uint64  `protobuf:"varint,8,opt,name=disk_usage,json=diskUsage,proto3" json:"disk_usage,omitempty"`
	Error     *string `protobuf:"bytes,9,opt,name=error,proto3,oneof" json:"error,omitempty"`
	// contains filtered or unexported fields
}

func (*AsyncSearchesListItem) Descriptor deprecated

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

Deprecated: Use AsyncSearchesListItem.ProtoReflect.Descriptor instead.

func (*AsyncSearchesListItem) GetCanceledAt

func (x *AsyncSearchesListItem) GetCanceledAt() *timestamppb.Timestamp

func (*AsyncSearchesListItem) GetDiskUsage

func (x *AsyncSearchesListItem) GetDiskUsage() uint64

func (*AsyncSearchesListItem) GetError added in v0.44.0

func (x *AsyncSearchesListItem) GetError() string

func (*AsyncSearchesListItem) GetExpiresAt

func (x *AsyncSearchesListItem) GetExpiresAt() *timestamppb.Timestamp

func (*AsyncSearchesListItem) GetProgress

func (x *AsyncSearchesListItem) GetProgress() float64

func (*AsyncSearchesListItem) GetRequest

func (*AsyncSearchesListItem) GetSearchId

func (x *AsyncSearchesListItem) GetSearchId() string

func (*AsyncSearchesListItem) GetStartedAt

func (x *AsyncSearchesListItem) GetStartedAt() *timestamppb.Timestamp

func (*AsyncSearchesListItem) GetStatus

func (*AsyncSearchesListItem) ProtoMessage

func (*AsyncSearchesListItem) ProtoMessage()

func (*AsyncSearchesListItem) ProtoReflect

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

func (*AsyncSearchesListItem) Reset

func (x *AsyncSearchesListItem) Reset()

func (*AsyncSearchesListItem) String

func (x *AsyncSearchesListItem) String() string

type CancelAsyncSearchRequest

type CancelAsyncSearchRequest struct {
	SearchId string `protobuf:"bytes,1,opt,name=search_id,json=searchId,proto3" json:"search_id,omitempty"`
	// contains filtered or unexported fields
}

func (*CancelAsyncSearchRequest) Descriptor deprecated

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

Deprecated: Use CancelAsyncSearchRequest.ProtoReflect.Descriptor instead.

func (*CancelAsyncSearchRequest) GetSearchId

func (x *CancelAsyncSearchRequest) GetSearchId() string

func (*CancelAsyncSearchRequest) ProtoMessage

func (*CancelAsyncSearchRequest) ProtoMessage()

func (*CancelAsyncSearchRequest) ProtoReflect

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

func (*CancelAsyncSearchRequest) Reset

func (x *CancelAsyncSearchRequest) Reset()

func (*CancelAsyncSearchRequest) String

func (x *CancelAsyncSearchRequest) String() string

type CancelAsyncSearchResponse

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

func (*CancelAsyncSearchResponse) Descriptor deprecated

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

Deprecated: Use CancelAsyncSearchResponse.ProtoReflect.Descriptor instead.

func (*CancelAsyncSearchResponse) ProtoMessage

func (*CancelAsyncSearchResponse) ProtoMessage()

func (*CancelAsyncSearchResponse) ProtoReflect

func (*CancelAsyncSearchResponse) Reset

func (x *CancelAsyncSearchResponse) Reset()

func (*CancelAsyncSearchResponse) String

func (x *CancelAsyncSearchResponse) String() string

type ComplexSearchRequest

type ComplexSearchRequest struct {
	Query     *SearchQuery `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`                            // Search query.
	Aggs      []*AggQuery  `protobuf:"bytes,2,rep,name=aggs,proto3" json:"aggs,omitempty"`                              // List of aggregation queries.
	Hist      *HistQuery   `protobuf:"bytes,3,opt,name=hist,proto3,oneof" json:"hist,omitempty"`                        // Histogram query.
	Size      int64        `protobuf:"varint,4,opt,name=size,proto3" json:"size,omitempty"`                             // Maximum number of documents to return.
	Offset    int64        `protobuf:"varint,5,opt,name=offset,proto3" json:"offset,omitempty"`                         // Search offset.
	WithTotal bool         `protobuf:"varint,6,opt,name=with_total,json=withTotal,proto3" json:"with_total,omitempty"`  // Should total number of documents be returned in response.
	Order     Order        `protobuf:"varint,7,opt,name=order,proto3,enum=seqproxyapi.v1.Order" json:"order,omitempty"` // Document order ORDER_DESC/ORDER_ASC.
	// contains filtered or unexported fields
}

func (*ComplexSearchRequest) Descriptor deprecated

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

Deprecated: Use ComplexSearchRequest.ProtoReflect.Descriptor instead.

func (*ComplexSearchRequest) GetAggs

func (x *ComplexSearchRequest) GetAggs() []*AggQuery

func (*ComplexSearchRequest) GetHist

func (x *ComplexSearchRequest) GetHist() *HistQuery

func (*ComplexSearchRequest) GetOffset

func (x *ComplexSearchRequest) GetOffset() int64

func (*ComplexSearchRequest) GetOrder

func (x *ComplexSearchRequest) GetOrder() Order

func (*ComplexSearchRequest) GetQuery

func (x *ComplexSearchRequest) GetQuery() *SearchQuery

func (*ComplexSearchRequest) GetSize

func (x *ComplexSearchRequest) GetSize() int64

func (*ComplexSearchRequest) GetWithTotal

func (x *ComplexSearchRequest) GetWithTotal() bool

func (*ComplexSearchRequest) ProtoMessage

func (*ComplexSearchRequest) ProtoMessage()

func (*ComplexSearchRequest) ProtoReflect

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

func (*ComplexSearchRequest) Reset

func (x *ComplexSearchRequest) Reset()

func (*ComplexSearchRequest) String

func (x *ComplexSearchRequest) String() string

type ComplexSearchResponse

type ComplexSearchResponse struct {

	// Deprecated: Marked as deprecated in v1/seq_proxy_api.proto.
	PartialResponse bool           `protobuf:"varint,1,opt,name=partial_response,json=partialResponse,proto3" json:"partial_response,omitempty"` // True if some stores returned an error. Deprecated, use `Error` instead.
	Total           int64          `protobuf:"varint,2,opt,name=total,proto3" json:"total,omitempty"`                                            // Total number of documents satisfying request. Returned if `with_total` field in request is `true`.
	Docs            []*Document    `protobuf:"bytes,3,rep,name=docs,proto3" json:"docs,omitempty"`                                               // Documents, satisfying the request.
	Aggs            []*Aggregation `protobuf:"bytes,4,rep,name=aggs,proto3" json:"aggs,omitempty"`                                               // Aggregation results.
	Hist            *Histogram     `protobuf:"bytes,5,opt,name=hist,proto3,oneof" json:"hist,omitempty"`                                         // Histogram results.
	Error           *Error         `protobuf:"bytes,6,opt,name=error,proto3" json:"error,omitempty"`                                             // Error if happened.
	// contains filtered or unexported fields
}

func (*ComplexSearchResponse) Descriptor deprecated

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

Deprecated: Use ComplexSearchResponse.ProtoReflect.Descriptor instead.

func (*ComplexSearchResponse) GetAggs

func (x *ComplexSearchResponse) GetAggs() []*Aggregation

func (*ComplexSearchResponse) GetDocs

func (x *ComplexSearchResponse) GetDocs() []*Document

func (*ComplexSearchResponse) GetError

func (x *ComplexSearchResponse) GetError() *Error

func (*ComplexSearchResponse) GetHist

func (x *ComplexSearchResponse) GetHist() *Histogram

func (*ComplexSearchResponse) GetPartialResponse deprecated

func (x *ComplexSearchResponse) GetPartialResponse() bool

Deprecated: Marked as deprecated in v1/seq_proxy_api.proto.

func (*ComplexSearchResponse) GetTotal

func (x *ComplexSearchResponse) GetTotal() int64

func (*ComplexSearchResponse) ProtoMessage

func (*ComplexSearchResponse) ProtoMessage()

func (*ComplexSearchResponse) ProtoReflect

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

func (*ComplexSearchResponse) Reset

func (x *ComplexSearchResponse) Reset()

func (*ComplexSearchResponse) String

func (x *ComplexSearchResponse) String() string

type DeleteAsyncSearchRequest

type DeleteAsyncSearchRequest struct {
	SearchId string `protobuf:"bytes,1,opt,name=search_id,json=searchId,proto3" json:"search_id,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteAsyncSearchRequest) Descriptor deprecated

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

Deprecated: Use DeleteAsyncSearchRequest.ProtoReflect.Descriptor instead.

func (*DeleteAsyncSearchRequest) GetSearchId

func (x *DeleteAsyncSearchRequest) GetSearchId() string

func (*DeleteAsyncSearchRequest) ProtoMessage

func (*DeleteAsyncSearchRequest) ProtoMessage()

func (*DeleteAsyncSearchRequest) ProtoReflect

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

func (*DeleteAsyncSearchRequest) Reset

func (x *DeleteAsyncSearchRequest) Reset()

func (*DeleteAsyncSearchRequest) String

func (x *DeleteAsyncSearchRequest) String() string

type DeleteAsyncSearchResponse

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

func (*DeleteAsyncSearchResponse) Descriptor deprecated

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

Deprecated: Use DeleteAsyncSearchResponse.ProtoReflect.Descriptor instead.

func (*DeleteAsyncSearchResponse) ProtoMessage

func (*DeleteAsyncSearchResponse) ProtoMessage()

func (*DeleteAsyncSearchResponse) ProtoReflect

func (*DeleteAsyncSearchResponse) Reset

func (x *DeleteAsyncSearchResponse) Reset()

func (*DeleteAsyncSearchResponse) String

func (x *DeleteAsyncSearchResponse) String() string

type Document

type Document struct {
	Id   string                 `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`     // seq-id of the document.
	Data []byte                 `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"` // content of the document in utf-8 format.
	Time *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=time,proto3" json:"time,omitempty"` // timestamp from the document.
	// contains filtered or unexported fields
}

Document returned by seq-db.

func (*Document) Descriptor deprecated

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

Deprecated: Use Document.ProtoReflect.Descriptor instead.

func (*Document) GetData

func (x *Document) GetData() []byte

func (*Document) GetId

func (x *Document) GetId() string

func (*Document) GetTime

func (x *Document) GetTime() *timestamppb.Timestamp

func (*Document) ProtoMessage

func (*Document) ProtoMessage()

func (*Document) ProtoReflect

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

func (*Document) Reset

func (x *Document) Reset()

func (*Document) String

func (x *Document) String() string

type Error

type Error struct {
	Code    ErrorCode `protobuf:"varint,1,opt,name=code,proto3,enum=seqproxyapi.v1.ErrorCode" json:"code,omitempty"` // Response error code.
	Message string    `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`                          // Additional message.
	// contains filtered or unexported fields
}

Additional details provided if an error during request handling occurred.

func (*Error) Descriptor deprecated

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

Deprecated: Use Error.ProtoReflect.Descriptor instead.

func (*Error) GetCode

func (x *Error) GetCode() ErrorCode

func (*Error) GetMessage

func (x *Error) GetMessage() string

func (*Error) ProtoMessage

func (*Error) ProtoMessage()

func (*Error) ProtoReflect

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

func (*Error) Reset

func (x *Error) Reset()

func (*Error) String

func (x *Error) String() string

type ErrorCode

type ErrorCode int32

Custom error code, returned by seq-db proxy.

const (
	ErrorCode_ERROR_CODE_UNSPECIFIED            ErrorCode = 0 // Unknown/undefined code.
	ErrorCode_ERROR_CODE_NO                     ErrorCode = 1 // No error code. Returned when there were no problems during the request handling.
	ErrorCode_ERROR_CODE_PARTIAL_RESPONSE       ErrorCode = 2 // Partial response code. Returned when some of the seq-stores returned an error.
	ErrorCode_ERROR_CODE_TOO_MANY_FRACTIONS_HIT ErrorCode = 3 // Too many fractions hit code. Returned when too many fractions were hit during search exceeded limit.
)

func (ErrorCode) Descriptor

func (ErrorCode) Descriptor() protoreflect.EnumDescriptor

func (ErrorCode) Enum

func (x ErrorCode) Enum() *ErrorCode

func (ErrorCode) EnumDescriptor deprecated

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

Deprecated: Use ErrorCode.Descriptor instead.

func (ErrorCode) Number

func (x ErrorCode) Number() protoreflect.EnumNumber

func (ErrorCode) String

func (x ErrorCode) String() string

func (ErrorCode) Type

type ExportRequest

type ExportRequest struct {
	Query  *SearchQuery `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`    // Search query.
	Size   int64        `protobuf:"varint,2,opt,name=size,proto3" json:"size,omitempty"`     // Maximum number of documents to return.
	Offset int64        `protobuf:"varint,3,opt,name=offset,proto3" json:"offset,omitempty"` // Search offset.
	// contains filtered or unexported fields
}

func (*ExportRequest) Descriptor deprecated

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

Deprecated: Use ExportRequest.ProtoReflect.Descriptor instead.

func (*ExportRequest) GetOffset

func (x *ExportRequest) GetOffset() int64

func (*ExportRequest) GetQuery

func (x *ExportRequest) GetQuery() *SearchQuery

func (*ExportRequest) GetSize

func (x *ExportRequest) GetSize() int64

func (*ExportRequest) ProtoMessage

func (*ExportRequest) ProtoMessage()

func (*ExportRequest) ProtoReflect

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

func (*ExportRequest) Reset

func (x *ExportRequest) Reset()

func (*ExportRequest) String

func (x *ExportRequest) String() string

type ExportResponse

type ExportResponse struct {
	Doc *Document `protobuf:"bytes,1,opt,name=doc,proto3" json:"doc,omitempty"` // Response document.
	// contains filtered or unexported fields
}

func (*ExportResponse) Descriptor deprecated

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

Deprecated: Use ExportResponse.ProtoReflect.Descriptor instead.

func (*ExportResponse) GetDoc

func (x *ExportResponse) GetDoc() *Document

func (*ExportResponse) ProtoMessage

func (*ExportResponse) ProtoMessage()

func (*ExportResponse) ProtoReflect

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

func (*ExportResponse) Reset

func (x *ExportResponse) Reset()

func (*ExportResponse) String

func (x *ExportResponse) String() string

type FetchAsyncSearchResultRequest

type FetchAsyncSearchResultRequest struct {
	SearchId string `protobuf:"bytes,1,opt,name=search_id,json=searchId,proto3" json:"search_id,omitempty"`
	// Maximum number of documents to fetch (pagination).
	// Ignored if with_docs was set to false, since documents are not stored in that case.
	Size int32 `protobuf:"varint,2,opt,name=size,proto3" json:"size,omitempty"`
	// Document offset (pagination).
	// Ignored if with_docs was set to false, since documents are not stored in that case.
	Offset int32 `protobuf:"varint,3,opt,name=offset,proto3" json:"offset,omitempty"`
	// Documents sort order.
	Order Order `protobuf:"varint,4,opt,name=order,proto3,enum=seqproxyapi.v1.Order" json:"order,omitempty"`
	// contains filtered or unexported fields
}

func (*FetchAsyncSearchResultRequest) Descriptor deprecated

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

Deprecated: Use FetchAsyncSearchResultRequest.ProtoReflect.Descriptor instead.

func (*FetchAsyncSearchResultRequest) GetOffset

func (x *FetchAsyncSearchResultRequest) GetOffset() int32

func (*FetchAsyncSearchResultRequest) GetOrder

func (x *FetchAsyncSearchResultRequest) GetOrder() Order

func (*FetchAsyncSearchResultRequest) GetSearchId

func (x *FetchAsyncSearchResultRequest) GetSearchId() string

func (*FetchAsyncSearchResultRequest) GetSize

func (x *FetchAsyncSearchResultRequest) GetSize() int32

func (*FetchAsyncSearchResultRequest) ProtoMessage

func (*FetchAsyncSearchResultRequest) ProtoMessage()

func (*FetchAsyncSearchResultRequest) ProtoReflect

func (*FetchAsyncSearchResultRequest) Reset

func (x *FetchAsyncSearchResultRequest) Reset()

func (*FetchAsyncSearchResultRequest) String

type FetchAsyncSearchResultResponse

type FetchAsyncSearchResultResponse struct {
	Status     AsyncSearchStatus        `protobuf:"varint,1,opt,name=status,proto3,enum=seqproxyapi.v1.AsyncSearchStatus" json:"status,omitempty"`
	Request    *StartAsyncSearchRequest `protobuf:"bytes,2,opt,name=request,proto3" json:"request,omitempty"`
	Response   *ComplexSearchResponse   `protobuf:"bytes,3,opt,name=response,proto3" json:"response,omitempty"`
	StartedAt  *timestamppb.Timestamp   `protobuf:"bytes,4,opt,name=started_at,json=startedAt,proto3" json:"started_at,omitempty"`
	ExpiresAt  *timestamppb.Timestamp   `protobuf:"bytes,5,opt,name=expires_at,json=expiresAt,proto3" json:"expires_at,omitempty"`
	CanceledAt *timestamppb.Timestamp   `protobuf:"bytes,6,opt,name=canceled_at,json=canceledAt,proto3,oneof" json:"canceled_at,omitempty"`
	// Search progress in range [0, 1].
	Progress float64 `protobuf:"fixed64,7,opt,name=progress,proto3" json:"progress,omitempty"`
	// The size of data stored on disk, in bytes.
	DiskUsage uint64 `protobuf:"varint,8,opt,name=disk_usage,json=diskUsage,proto3" json:"disk_usage,omitempty"`
	// contains filtered or unexported fields
}

func (*FetchAsyncSearchResultResponse) Descriptor deprecated

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

Deprecated: Use FetchAsyncSearchResultResponse.ProtoReflect.Descriptor instead.

func (*FetchAsyncSearchResultResponse) GetCanceledAt

func (*FetchAsyncSearchResultResponse) GetDiskUsage

func (x *FetchAsyncSearchResultResponse) GetDiskUsage() uint64

func (*FetchAsyncSearchResultResponse) GetExpiresAt

func (*FetchAsyncSearchResultResponse) GetProgress

func (x *FetchAsyncSearchResultResponse) GetProgress() float64

func (*FetchAsyncSearchResultResponse) GetRequest

func (*FetchAsyncSearchResultResponse) GetResponse

func (*FetchAsyncSearchResultResponse) GetStartedAt

func (*FetchAsyncSearchResultResponse) GetStatus

func (*FetchAsyncSearchResultResponse) ProtoMessage

func (*FetchAsyncSearchResultResponse) ProtoMessage()

func (*FetchAsyncSearchResultResponse) ProtoReflect

func (*FetchAsyncSearchResultResponse) Reset

func (x *FetchAsyncSearchResultResponse) Reset()

func (*FetchAsyncSearchResultResponse) String

type FetchRequest

type FetchRequest struct {
	Ids []string `protobuf:"bytes,1,rep,name=ids,proto3" json:"ids,omitempty"` // Document ids to fetch.
	// contains filtered or unexported fields
}

func (*FetchRequest) Descriptor deprecated

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

Deprecated: Use FetchRequest.ProtoReflect.Descriptor instead.

func (*FetchRequest) GetIds

func (x *FetchRequest) GetIds() []string

func (*FetchRequest) ProtoMessage

func (*FetchRequest) ProtoMessage()

func (*FetchRequest) ProtoReflect

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

func (*FetchRequest) Reset

func (x *FetchRequest) Reset()

func (*FetchRequest) String

func (x *FetchRequest) String() string

type GetAggregationRequest

type GetAggregationRequest struct {
	Query *SearchQuery `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"` // Search query.
	Aggs  []*AggQuery  `protobuf:"bytes,2,rep,name=aggs,proto3" json:"aggs,omitempty"`   // List of aggregation queries.
	// contains filtered or unexported fields
}

func (*GetAggregationRequest) Descriptor deprecated

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

Deprecated: Use GetAggregationRequest.ProtoReflect.Descriptor instead.

func (*GetAggregationRequest) GetAggs

func (x *GetAggregationRequest) GetAggs() []*AggQuery

func (*GetAggregationRequest) GetQuery

func (x *GetAggregationRequest) GetQuery() *SearchQuery

func (*GetAggregationRequest) ProtoMessage

func (*GetAggregationRequest) ProtoMessage()

func (*GetAggregationRequest) ProtoReflect

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

func (*GetAggregationRequest) Reset

func (x *GetAggregationRequest) Reset()

func (*GetAggregationRequest) String

func (x *GetAggregationRequest) String() string

type GetAggregationResponse

type GetAggregationResponse struct {

	// Deprecated: Marked as deprecated in v1/seq_proxy_api.proto.
	PartialResponse bool           `protobuf:"varint,1,opt,name=partial_response,json=partialResponse,proto3" json:"partial_response,omitempty"` // True if some stores returned an error. Deprecated, use `Error` instead.
	Total           int64          `protobuf:"varint,2,opt,name=total,proto3" json:"total,omitempty"`                                            // Total number of documents satisfying request. Returned if `with_total` field in request is `true`.
	Aggs            []*Aggregation `protobuf:"bytes,3,rep,name=aggs,proto3" json:"aggs,omitempty"`                                               // Aggregation results.
	Error           *Error         `protobuf:"bytes,4,opt,name=error,proto3" json:"error,omitempty"`                                             // Error if happened.
	// contains filtered or unexported fields
}

func (*GetAggregationResponse) Descriptor deprecated

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

Deprecated: Use GetAggregationResponse.ProtoReflect.Descriptor instead.

func (*GetAggregationResponse) GetAggs

func (x *GetAggregationResponse) GetAggs() []*Aggregation

func (*GetAggregationResponse) GetError

func (x *GetAggregationResponse) GetError() *Error

func (*GetAggregationResponse) GetPartialResponse deprecated

func (x *GetAggregationResponse) GetPartialResponse() bool

Deprecated: Marked as deprecated in v1/seq_proxy_api.proto.

func (*GetAggregationResponse) GetTotal

func (x *GetAggregationResponse) GetTotal() int64

func (*GetAggregationResponse) ProtoMessage

func (*GetAggregationResponse) ProtoMessage()

func (*GetAggregationResponse) ProtoReflect

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

func (*GetAggregationResponse) Reset

func (x *GetAggregationResponse) Reset()

func (*GetAggregationResponse) String

func (x *GetAggregationResponse) String() string

type GetAsyncSearchesListRequest

type GetAsyncSearchesListRequest struct {
	Status *AsyncSearchStatus `protobuf:"varint,1,opt,name=status,proto3,enum=seqproxyapi.v1.AsyncSearchStatus,oneof" json:"status,omitempty"`
	// Maximum number of searches to fetch (pagination).
	Size int32 `protobuf:"varint,2,opt,name=size,proto3" json:"size,omitempty"`
	// Searches offset (pagination).
	Offset int32 `protobuf:"varint,3,opt,name=offset,proto3" json:"offset,omitempty"`
	// list of async search ids to filter out result
	Ids []string `protobuf:"bytes,4,rep,name=ids,proto3" json:"ids,omitempty"`
	// contains filtered or unexported fields
}

func (*GetAsyncSearchesListRequest) Descriptor deprecated

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

Deprecated: Use GetAsyncSearchesListRequest.ProtoReflect.Descriptor instead.

func (*GetAsyncSearchesListRequest) GetIds

func (x *GetAsyncSearchesListRequest) GetIds() []string

func (*GetAsyncSearchesListRequest) GetOffset

func (x *GetAsyncSearchesListRequest) GetOffset() int32

func (*GetAsyncSearchesListRequest) GetSize

func (x *GetAsyncSearchesListRequest) GetSize() int32

func (*GetAsyncSearchesListRequest) GetStatus

func (*GetAsyncSearchesListRequest) ProtoMessage

func (*GetAsyncSearchesListRequest) ProtoMessage()

func (*GetAsyncSearchesListRequest) ProtoReflect

func (*GetAsyncSearchesListRequest) Reset

func (x *GetAsyncSearchesListRequest) Reset()

func (*GetAsyncSearchesListRequest) String

func (x *GetAsyncSearchesListRequest) String() string

type GetAsyncSearchesListResponse

type GetAsyncSearchesListResponse struct {
	Searches []*AsyncSearchesListItem `protobuf:"bytes,1,rep,name=searches,proto3" json:"searches,omitempty"`
	// contains filtered or unexported fields
}

func (*GetAsyncSearchesListResponse) Descriptor deprecated

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

Deprecated: Use GetAsyncSearchesListResponse.ProtoReflect.Descriptor instead.

func (*GetAsyncSearchesListResponse) GetSearches

func (*GetAsyncSearchesListResponse) ProtoMessage

func (*GetAsyncSearchesListResponse) ProtoMessage()

func (*GetAsyncSearchesListResponse) ProtoReflect

func (*GetAsyncSearchesListResponse) Reset

func (x *GetAsyncSearchesListResponse) Reset()

func (*GetAsyncSearchesListResponse) String

type GetHistogramRequest

type GetHistogramRequest struct {
	Query *SearchQuery `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"` // Search query.
	Hist  *HistQuery   `protobuf:"bytes,2,opt,name=hist,proto3" json:"hist,omitempty"`   // Histogram query.
	// contains filtered or unexported fields
}

func (*GetHistogramRequest) Descriptor deprecated

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

Deprecated: Use GetHistogramRequest.ProtoReflect.Descriptor instead.

func (*GetHistogramRequest) GetHist

func (x *GetHistogramRequest) GetHist() *HistQuery

func (*GetHistogramRequest) GetQuery

func (x *GetHistogramRequest) GetQuery() *SearchQuery

func (*GetHistogramRequest) ProtoMessage

func (*GetHistogramRequest) ProtoMessage()

func (*GetHistogramRequest) ProtoReflect

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

func (*GetHistogramRequest) Reset

func (x *GetHistogramRequest) Reset()

func (*GetHistogramRequest) String

func (x *GetHistogramRequest) String() string

type GetHistogramResponse

type GetHistogramResponse struct {

	// Deprecated: Marked as deprecated in v1/seq_proxy_api.proto.
	PartialResponse bool       `protobuf:"varint,1,opt,name=partial_response,json=partialResponse,proto3" json:"partial_response,omitempty"` // True if some stores returned an error. Deprecated, use `Error` instead.
	Total           int64      `protobuf:"varint,2,opt,name=total,proto3" json:"total,omitempty"`                                            // Total number of documents satisfying request. Returned if `with_total` field in request is `true`.
	Hist            *Histogram `protobuf:"bytes,3,opt,name=hist,proto3" json:"hist,omitempty"`                                               // Histogram results.
	Error           *Error     `protobuf:"bytes,4,opt,name=error,proto3" json:"error,omitempty"`                                             // Error if happened.
	// contains filtered or unexported fields
}

func (*GetHistogramResponse) Descriptor deprecated

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

Deprecated: Use GetHistogramResponse.ProtoReflect.Descriptor instead.

func (*GetHistogramResponse) GetError

func (x *GetHistogramResponse) GetError() *Error

func (*GetHistogramResponse) GetHist

func (x *GetHistogramResponse) GetHist() *Histogram

func (*GetHistogramResponse) GetPartialResponse deprecated

func (x *GetHistogramResponse) GetPartialResponse() bool

Deprecated: Marked as deprecated in v1/seq_proxy_api.proto.

func (*GetHistogramResponse) GetTotal

func (x *GetHistogramResponse) GetTotal() int64

func (*GetHistogramResponse) ProtoMessage

func (*GetHistogramResponse) ProtoMessage()

func (*GetHistogramResponse) ProtoReflect

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

func (*GetHistogramResponse) Reset

func (x *GetHistogramResponse) Reset()

func (*GetHistogramResponse) String

func (x *GetHistogramResponse) String() string

type HistQuery

type HistQuery struct {
	Interval string `protobuf:"bytes,1,opt,name=interval,proto3" json:"interval,omitempty"` // Interval in promql duration format like `1m`, `5s`. More details: https://prometheus.io/docs/prometheus/latest/querying/basics/#float-literals-and-time-durations
	// contains filtered or unexported fields
}

Histogram query

func (*HistQuery) Descriptor deprecated

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

Deprecated: Use HistQuery.ProtoReflect.Descriptor instead.

func (*HistQuery) GetInterval

func (x *HistQuery) GetInterval() string

func (*HistQuery) ProtoMessage

func (*HistQuery) ProtoMessage()

func (*HistQuery) ProtoReflect

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

func (*HistQuery) Reset

func (x *HistQuery) Reset()

func (*HistQuery) String

func (x *HistQuery) String() string

type Histogram

type Histogram struct {
	Buckets []*Histogram_Bucket `protobuf:"bytes,1,rep,name=buckets,proto3" json:"buckets,omitempty"` // Buckets for given histogram request.
	// contains filtered or unexported fields
}

Histogram response.

func (*Histogram) Descriptor deprecated

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

Deprecated: Use Histogram.ProtoReflect.Descriptor instead.

func (*Histogram) GetBuckets

func (x *Histogram) GetBuckets() []*Histogram_Bucket

func (*Histogram) ProtoMessage

func (*Histogram) ProtoMessage()

func (*Histogram) ProtoReflect

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

func (*Histogram) Reset

func (x *Histogram) Reset()

func (*Histogram) String

func (x *Histogram) String() string

type Histogram_Bucket

type Histogram_Bucket struct {
	DocCount uint64                 `protobuf:"varint,1,opt,name=doc_count,json=docCount,proto3" json:"doc_count,omitempty"` // Number of documents in bucket.
	Ts       *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=ts,proto3" json:"ts,omitempty"`                              // Left border of the bucket.
	// contains filtered or unexported fields
}

Key-value pair with time as a key and number of documents in this bucket as a value.

func (*Histogram_Bucket) Descriptor deprecated

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

Deprecated: Use Histogram_Bucket.ProtoReflect.Descriptor instead.

func (*Histogram_Bucket) GetDocCount

func (x *Histogram_Bucket) GetDocCount() uint64

func (*Histogram_Bucket) GetTs

func (*Histogram_Bucket) ProtoMessage

func (*Histogram_Bucket) ProtoMessage()

func (*Histogram_Bucket) ProtoReflect

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

func (*Histogram_Bucket) Reset

func (x *Histogram_Bucket) Reset()

func (*Histogram_Bucket) String

func (x *Histogram_Bucket) String() string

type MappingRequest

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

func (*MappingRequest) Descriptor deprecated

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

Deprecated: Use MappingRequest.ProtoReflect.Descriptor instead.

func (*MappingRequest) ProtoMessage

func (*MappingRequest) ProtoMessage()

func (*MappingRequest) ProtoReflect

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

func (*MappingRequest) Reset

func (x *MappingRequest) Reset()

func (*MappingRequest) String

func (x *MappingRequest) String() string

type MappingResponse

type MappingResponse struct {
	Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"` // utf-8 encoded mapping info.
	// contains filtered or unexported fields
}

func (*MappingResponse) Descriptor deprecated

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

Deprecated: Use MappingResponse.ProtoReflect.Descriptor instead.

func (*MappingResponse) GetData

func (x *MappingResponse) GetData() []byte

func (*MappingResponse) ProtoMessage

func (*MappingResponse) ProtoMessage()

func (*MappingResponse) ProtoReflect

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

func (*MappingResponse) Reset

func (x *MappingResponse) Reset()

func (*MappingResponse) String

func (x *MappingResponse) String() string

type Order

type Order int32

Order of document sorting.

const (
	Order_ORDER_DESC Order = 0 // Type for descending order.
	Order_ORDER_ASC  Order = 1 // Type for ascending order.
)

func (Order) Descriptor

func (Order) Descriptor() protoreflect.EnumDescriptor

func (Order) Enum

func (x Order) Enum() *Order

func (Order) EnumDescriptor deprecated

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

Deprecated: Use Order.Descriptor instead.

func (Order) Number

func (x Order) Number() protoreflect.EnumNumber

func (Order) String

func (x Order) String() string

func (Order) Type

func (Order) Type() protoreflect.EnumType

type SearchQuery

type SearchQuery struct {
	Query   string                 `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`      // Search query.
	From    *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=from,proto3" json:"from,omitempty"`        // Lower bound for search (inclusive).
	To      *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=to,proto3" json:"to,omitempty"`            // Upper bound for search (inclusive).
	Explain bool                   `protobuf:"varint,4,opt,name=explain,proto3" json:"explain,omitempty"` // Should request be explained (tracing will be provided with the result).
	// contains filtered or unexported fields
}

General search query for requesting documents.

func (*SearchQuery) Descriptor deprecated

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

Deprecated: Use SearchQuery.ProtoReflect.Descriptor instead.

func (*SearchQuery) GetExplain

func (x *SearchQuery) GetExplain() bool

func (*SearchQuery) GetFrom

func (x *SearchQuery) GetFrom() *timestamppb.Timestamp

func (*SearchQuery) GetQuery

func (x *SearchQuery) GetQuery() string

func (*SearchQuery) GetTo

func (x *SearchQuery) GetTo() *timestamppb.Timestamp

func (*SearchQuery) ProtoMessage

func (*SearchQuery) ProtoMessage()

func (*SearchQuery) ProtoReflect

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

func (*SearchQuery) Reset

func (x *SearchQuery) Reset()

func (*SearchQuery) String

func (x *SearchQuery) String() string

type SearchRequest

type SearchRequest struct {
	Query     *SearchQuery `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`                            // Search query.
	Size      int64        `protobuf:"varint,2,opt,name=size,proto3" json:"size,omitempty"`                             // Maximum number of documents to return.
	Offset    int64        `protobuf:"varint,3,opt,name=offset,proto3" json:"offset,omitempty"`                         // Search offset.
	WithTotal bool         `protobuf:"varint,4,opt,name=with_total,json=withTotal,proto3" json:"with_total,omitempty"`  // Should total number of documents be returned in response.
	Order     Order        `protobuf:"varint,5,opt,name=order,proto3,enum=seqproxyapi.v1.Order" json:"order,omitempty"` // Document order ORDER_DESC/ORDER_ASC.
	// contains filtered or unexported fields
}

func (*SearchRequest) Descriptor deprecated

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

Deprecated: Use SearchRequest.ProtoReflect.Descriptor instead.

func (*SearchRequest) GetOffset

func (x *SearchRequest) GetOffset() int64

func (*SearchRequest) GetOrder

func (x *SearchRequest) GetOrder() Order

func (*SearchRequest) GetQuery

func (x *SearchRequest) GetQuery() *SearchQuery

func (*SearchRequest) GetSize

func (x *SearchRequest) GetSize() int64

func (*SearchRequest) GetWithTotal

func (x *SearchRequest) GetWithTotal() bool

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 SearchResponse

type SearchResponse struct {

	// Deprecated: Marked as deprecated in v1/seq_proxy_api.proto.
	PartialResponse bool        `protobuf:"varint,1,opt,name=partial_response,json=partialResponse,proto3" json:"partial_response,omitempty"` // True if some stores returned an error. Deprecated, use `Error` instead.
	Total           int64       `protobuf:"varint,2,opt,name=total,proto3" json:"total,omitempty"`                                            // Total number of documents satisfying request. Returned if `with_total` field in request is `true`.
	Docs            []*Document `protobuf:"bytes,3,rep,name=docs,proto3" json:"docs,omitempty"`                                               // Documents, satisfying the request.
	Error           *Error      `protobuf:"bytes,4,opt,name=error,proto3" json:"error,omitempty"`                                             // Error if happened.
	// contains filtered or unexported fields
}

func (*SearchResponse) Descriptor deprecated

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

Deprecated: Use SearchResponse.ProtoReflect.Descriptor instead.

func (*SearchResponse) GetDocs

func (x *SearchResponse) GetDocs() []*Document

func (*SearchResponse) GetError

func (x *SearchResponse) GetError() *Error

func (*SearchResponse) GetPartialResponse deprecated

func (x *SearchResponse) GetPartialResponse() bool

Deprecated: Marked as deprecated in v1/seq_proxy_api.proto.

func (*SearchResponse) GetTotal

func (x *SearchResponse) GetTotal() int64

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 SeqProxyApiClient

type SeqProxyApiClient interface {
	// Fetch documents for given SearchQuery.
	Search(ctx context.Context, in *SearchRequest, opts ...grpc.CallOption) (*SearchResponse, error)
	// Fetch documents, aggregations and histograms for given queries correspondingly.
	ComplexSearch(ctx context.Context, in *ComplexSearchRequest, opts ...grpc.CallOption) (*ComplexSearchResponse, error)
	// Fetch aggregations for given SearchQuery and AggQueries.
	GetAggregation(ctx context.Context, in *GetAggregationRequest, opts ...grpc.CallOption) (*GetAggregationResponse, error)
	// Fetch histogram for given SearchQuery and HistQuery.
	GetHistogram(ctx context.Context, in *GetHistogramRequest, opts ...grpc.CallOption) (*GetHistogramResponse, error)
	// Fetch documents by the corresponding seq-ids.
	Fetch(ctx context.Context, in *FetchRequest, opts ...grpc.CallOption) (SeqProxyApi_FetchClient, error)
	// Fetch current seq-db mapping.
	Mapping(ctx context.Context, in *MappingRequest, opts ...grpc.CallOption) (*MappingResponse, error)
	// Fetch seq-db store's availability information.
	Status(ctx context.Context, in *StatusRequest, opts ...grpc.CallOption) (*StatusResponse, error)
	// Stream documents for given SearchQuery. Same as Search, but returns streaming response.
	Export(ctx context.Context, in *ExportRequest, opts ...grpc.CallOption) (SeqProxyApi_ExportClient, error)
	// Starts a new asynchronous search operation.
	// The server processes the request in the background and returns a search ID.
	StartAsyncSearch(ctx context.Context, in *StartAsyncSearchRequest, opts ...grpc.CallOption) (*StartAsyncSearchResponse, error)
	// Fetches the result or current status of a previously started async search.
	// Clients should use the search ID returned by StartAsyncSearch.
	FetchAsyncSearchResult(ctx context.Context, in *FetchAsyncSearchResultRequest, opts ...grpc.CallOption) (*FetchAsyncSearchResultResponse, error)
	// Cancels an ongoing asynchronous search operation if it hasn't completed yet.
	CancelAsyncSearch(ctx context.Context, in *CancelAsyncSearchRequest, opts ...grpc.CallOption) (*CancelAsyncSearchResponse, error)
	// Frees up resources if the result is no longer needed.
	DeleteAsyncSearch(ctx context.Context, in *DeleteAsyncSearchRequest, opts ...grpc.CallOption) (*DeleteAsyncSearchResponse, error)
	// Fetch list of async searches.
	GetAsyncSearchesList(ctx context.Context, in *GetAsyncSearchesListRequest, opts ...grpc.CallOption) (*GetAsyncSearchesListResponse, error)
}

SeqProxyApiClient is the client API for SeqProxyApi service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

seq-db public api. Exposes APIs related to document querying.

type SeqProxyApiServer

type SeqProxyApiServer interface {
	// Fetch documents for given SearchQuery.
	Search(context.Context, *SearchRequest) (*SearchResponse, error)
	// Fetch documents, aggregations and histograms for given queries correspondingly.
	ComplexSearch(context.Context, *ComplexSearchRequest) (*ComplexSearchResponse, error)
	// Fetch aggregations for given SearchQuery and AggQueries.
	GetAggregation(context.Context, *GetAggregationRequest) (*GetAggregationResponse, error)
	// Fetch histogram for given SearchQuery and HistQuery.
	GetHistogram(context.Context, *GetHistogramRequest) (*GetHistogramResponse, error)
	// Fetch documents by the corresponding seq-ids.
	Fetch(*FetchRequest, SeqProxyApi_FetchServer) error
	// Fetch current seq-db mapping.
	Mapping(context.Context, *MappingRequest) (*MappingResponse, error)
	// Fetch seq-db store's availability information.
	Status(context.Context, *StatusRequest) (*StatusResponse, error)
	// Stream documents for given SearchQuery. Same as Search, but returns streaming response.
	Export(*ExportRequest, SeqProxyApi_ExportServer) error
	// Starts a new asynchronous search operation.
	// The server processes the request in the background and returns a search ID.
	StartAsyncSearch(context.Context, *StartAsyncSearchRequest) (*StartAsyncSearchResponse, error)
	// Fetches the result or current status of a previously started async search.
	// Clients should use the search ID returned by StartAsyncSearch.
	FetchAsyncSearchResult(context.Context, *FetchAsyncSearchResultRequest) (*FetchAsyncSearchResultResponse, error)
	// Cancels an ongoing asynchronous search operation if it hasn't completed yet.
	CancelAsyncSearch(context.Context, *CancelAsyncSearchRequest) (*CancelAsyncSearchResponse, error)
	// Frees up resources if the result is no longer needed.
	DeleteAsyncSearch(context.Context, *DeleteAsyncSearchRequest) (*DeleteAsyncSearchResponse, error)
	// Fetch list of async searches.
	GetAsyncSearchesList(context.Context, *GetAsyncSearchesListRequest) (*GetAsyncSearchesListResponse, error)
}

SeqProxyApiServer is the server API for SeqProxyApi service. All implementations should embed UnimplementedSeqProxyApiServer for forward compatibility

seq-db public api. Exposes APIs related to document querying.

type SeqProxyApi_ExportClient

type SeqProxyApi_ExportClient interface {
	Recv() (*ExportResponse, error)
	grpc.ClientStream
}

type SeqProxyApi_ExportServer

type SeqProxyApi_ExportServer interface {
	Send(*ExportResponse) error
	grpc.ServerStream
}

type SeqProxyApi_FetchClient

type SeqProxyApi_FetchClient interface {
	Recv() (*Document, error)
	grpc.ClientStream
}

type SeqProxyApi_FetchServer

type SeqProxyApi_FetchServer interface {
	Send(*Document) error
	grpc.ServerStream
}

type StartAsyncSearchRequest

type StartAsyncSearchRequest struct {

	// Duration to retain the result of an asynchronous query.
	// After this period, the result will be deleted.
	Retention *durationpb.Duration `protobuf:"bytes,1,opt,name=retention,proto3" json:"retention,omitempty"`
	// Search query to execute.
	Query *SearchQuery `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
	// List of aggregation queries.
	Aggs []*AggQuery `protobuf:"bytes,3,rep,name=aggs,proto3" json:"aggs,omitempty"`
	// Optional histogram query.
	Hist *HistQuery `protobuf:"bytes,4,opt,name=hist,proto3,oneof" json:"hist,omitempty"`
	// Set this to true to enable document retrieval via FetchAsyncSearch.
	// Note: enabling this may significantly increase disk space usage.
	WithDocs bool `protobuf:"varint,5,opt,name=with_docs,json=withDocs,proto3" json:"with_docs,omitempty"`
	// Maximum number of documents to find. Doesn't affect aggs and hist.
	// Ignored if with_docs was set to false.
	Size int64 `protobuf:"varint,6,opt,name=size,proto3" json:"size,omitempty"`
	// contains filtered or unexported fields
}

func (*StartAsyncSearchRequest) Descriptor deprecated

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

Deprecated: Use StartAsyncSearchRequest.ProtoReflect.Descriptor instead.

func (*StartAsyncSearchRequest) GetAggs

func (x *StartAsyncSearchRequest) GetAggs() []*AggQuery

func (*StartAsyncSearchRequest) GetHist

func (x *StartAsyncSearchRequest) GetHist() *HistQuery

func (*StartAsyncSearchRequest) GetQuery

func (x *StartAsyncSearchRequest) GetQuery() *SearchQuery

func (*StartAsyncSearchRequest) GetRetention

func (x *StartAsyncSearchRequest) GetRetention() *durationpb.Duration

func (*StartAsyncSearchRequest) GetSize added in v0.41.0

func (x *StartAsyncSearchRequest) GetSize() int64

func (*StartAsyncSearchRequest) GetWithDocs

func (x *StartAsyncSearchRequest) GetWithDocs() bool

func (*StartAsyncSearchRequest) ProtoMessage

func (*StartAsyncSearchRequest) ProtoMessage()

func (*StartAsyncSearchRequest) ProtoReflect

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

func (*StartAsyncSearchRequest) Reset

func (x *StartAsyncSearchRequest) Reset()

func (*StartAsyncSearchRequest) String

func (x *StartAsyncSearchRequest) String() string

type StartAsyncSearchResponse

type StartAsyncSearchResponse struct {

	// Unique ID used to retrieve search results with FetchAsyncSearchResult.
	SearchId string `protobuf:"bytes,1,opt,name=search_id,json=searchId,proto3" json:"search_id,omitempty"`
	// contains filtered or unexported fields
}

func (*StartAsyncSearchResponse) Descriptor deprecated

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

Deprecated: Use StartAsyncSearchResponse.ProtoReflect.Descriptor instead.

func (*StartAsyncSearchResponse) GetSearchId

func (x *StartAsyncSearchResponse) GetSearchId() string

func (*StartAsyncSearchResponse) ProtoMessage

func (*StartAsyncSearchResponse) ProtoMessage()

func (*StartAsyncSearchResponse) ProtoReflect

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

func (*StartAsyncSearchResponse) Reset

func (x *StartAsyncSearchResponse) Reset()

func (*StartAsyncSearchResponse) String

func (x *StartAsyncSearchResponse) String() string

type StatusRequest

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

func (*StatusRequest) Descriptor deprecated

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

Deprecated: Use StatusRequest.ProtoReflect.Descriptor instead.

func (*StatusRequest) ProtoMessage

func (*StatusRequest) ProtoMessage()

func (*StatusRequest) ProtoReflect

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

func (*StatusRequest) Reset

func (x *StatusRequest) Reset()

func (*StatusRequest) String

func (x *StatusRequest) String() string

type StatusResponse

type StatusResponse struct {
	NumberOfStores    int32                  `protobuf:"varint,1,opt,name=number_of_stores,json=numberOfStores,proto3" json:"number_of_stores,omitempty"`               // Total number of stores.
	OldestStorageTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=oldest_storage_time,json=oldestStorageTime,proto3,oneof" json:"oldest_storage_time,omitempty"` // Timestamp of the oldest stored document across all stores.
	Stores            []*StoreStatus         `protobuf:"bytes,4,rep,name=stores,proto3" json:"stores,omitempty"`                                                        // Detailed information about each store.
	// contains filtered or unexported fields
}

func (*StatusResponse) Descriptor deprecated

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

Deprecated: Use StatusResponse.ProtoReflect.Descriptor instead.

func (*StatusResponse) GetNumberOfStores

func (x *StatusResponse) GetNumberOfStores() int32

func (*StatusResponse) GetOldestStorageTime

func (x *StatusResponse) GetOldestStorageTime() *timestamppb.Timestamp

func (*StatusResponse) GetStores

func (x *StatusResponse) GetStores() []*StoreStatus

func (*StatusResponse) ProtoMessage

func (*StatusResponse) ProtoMessage()

func (*StatusResponse) ProtoReflect

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

func (*StatusResponse) Reset

func (x *StatusResponse) Reset()

func (*StatusResponse) String

func (x *StatusResponse) String() string

type StoreStatus

type StoreStatus struct {
	Host   string             `protobuf:"bytes,1,opt,name=host,proto3" json:"host,omitempty"`           // Store's IP-address.
	Values *StoreStatusValues `protobuf:"bytes,2,opt,name=values,proto3,oneof" json:"values,omitempty"` // Store's status information.
	Error  *string            `protobuf:"bytes,3,opt,name=error,proto3,oneof" json:"error,omitempty"`   // Error during the request.
	// contains filtered or unexported fields
}

func (*StoreStatus) Descriptor deprecated

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

Deprecated: Use StoreStatus.ProtoReflect.Descriptor instead.

func (*StoreStatus) GetError

func (x *StoreStatus) GetError() string

func (*StoreStatus) GetHost

func (x *StoreStatus) GetHost() string

func (*StoreStatus) GetValues

func (x *StoreStatus) GetValues() *StoreStatusValues

func (*StoreStatus) ProtoMessage

func (*StoreStatus) ProtoMessage()

func (*StoreStatus) ProtoReflect

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

func (*StoreStatus) Reset

func (x *StoreStatus) Reset()

func (*StoreStatus) String

func (x *StoreStatus) String() string

type StoreStatusValues

type StoreStatusValues struct {
	OldestTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=oldest_time,json=oldestTime,proto3" json:"oldest_time,omitempty"` // Timestamp of the oldest stored document.
	// contains filtered or unexported fields
}

func (*StoreStatusValues) Descriptor deprecated

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

Deprecated: Use StoreStatusValues.ProtoReflect.Descriptor instead.

func (*StoreStatusValues) GetOldestTime

func (x *StoreStatusValues) GetOldestTime() *timestamppb.Timestamp

func (*StoreStatusValues) ProtoMessage

func (*StoreStatusValues) ProtoMessage()

func (*StoreStatusValues) ProtoReflect

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

func (*StoreStatusValues) Reset

func (x *StoreStatusValues) Reset()

func (*StoreStatusValues) String

func (x *StoreStatusValues) String() string

type UnimplementedSeqProxyApiServer

type UnimplementedSeqProxyApiServer struct {
}

UnimplementedSeqProxyApiServer should be embedded to have forward compatible implementations.

func (UnimplementedSeqProxyApiServer) CancelAsyncSearch

func (UnimplementedSeqProxyApiServer) ComplexSearch

func (UnimplementedSeqProxyApiServer) DeleteAsyncSearch

func (UnimplementedSeqProxyApiServer) Export

func (UnimplementedSeqProxyApiServer) Fetch

func (UnimplementedSeqProxyApiServer) GetAggregation

func (UnimplementedSeqProxyApiServer) GetHistogram

func (UnimplementedSeqProxyApiServer) Mapping

func (UnimplementedSeqProxyApiServer) Search

func (UnimplementedSeqProxyApiServer) StartAsyncSearch

func (UnimplementedSeqProxyApiServer) Status

type UnsafeSeqProxyApiServer

type UnsafeSeqProxyApiServer interface {
	// contains filtered or unexported methods
}

UnsafeSeqProxyApiServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SeqProxyApiServer will result in compilation errors.

Directories

Path Synopsis
Package mock_seqproxyapi is a generated GoMock package.
Package mock_seqproxyapi is a generated GoMock package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL