repositorysocket

package
v0.19.3-pre1 Latest Latest
Warning

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

Go to latest
Published: Nov 24, 2025 License: MIT Imports: 6 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_repositorysocket_service_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Authenticate

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

Authenticate is used to authenticate a connection. The socket will be closed if the client fails to reauthenticate before the token expires. The socket will also be closed if the user sub changes between authenticate calls.

Responds with RespSuccess if the connection is successfully authenticated.

func (*Authenticate) Descriptor deprecated

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

Deprecated: Use Authenticate.ProtoReflect.Descriptor instead.

func (*Authenticate) GetToken

func (x *Authenticate) GetToken() string

func (*Authenticate) ProtoMessage

func (*Authenticate) ProtoMessage()

func (*Authenticate) ProtoReflect

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

func (*Authenticate) Reset

func (x *Authenticate) Reset()

func (*Authenticate) String

func (x *Authenticate) String() string

type Call

type Call struct {

	// CallID uniquely identifies this call and will be referenced in the
	// response.
	CallId           string            `protobuf:"bytes,1,opt,name=call_id,json=callId,proto3" json:"call_id,omitempty"`
	Authenticate     *Authenticate     `protobuf:"bytes,2,opt,name=authenticate,proto3" json:"authenticate,omitempty"`
	GetDocuments     *GetDocuments     `protobuf:"bytes,3,opt,name=get_documents,json=getDocuments,proto3" json:"get_documents,omitempty"`
	CloseDocumentSet *CloseDocumentSet `protobuf:"bytes,4,opt,name=close_document_set,json=closeDocumentSet,proto3" json:"close_document_set,omitempty"`
	// contains filtered or unexported fields
}

func (*Call) Descriptor deprecated

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

Deprecated: Use Call.ProtoReflect.Descriptor instead.

func (*Call) GetAuthenticate

func (x *Call) GetAuthenticate() *Authenticate

func (*Call) GetCallId

func (x *Call) GetCallId() string

func (*Call) GetCloseDocumentSet

func (x *Call) GetCloseDocumentSet() *CloseDocumentSet

func (*Call) GetGetDocuments

func (x *Call) GetGetDocuments() *GetDocuments

func (*Call) ProtoMessage

func (*Call) ProtoMessage()

func (*Call) ProtoReflect

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

func (*Call) Reset

func (x *Call) Reset()

func (*Call) String

func (x *Call) String() string

type CloseDocumentSet

type CloseDocumentSet struct {

	// SetName is the name of the document set to close.
	SetName string `protobuf:"bytes,1,opt,name=set_name,json=setName,proto3" json:"set_name,omitempty"`
	// contains filtered or unexported fields
}

CloseDocumentSet is used to stop recieving updates for a document set.

Responds with RespSuccess if the set was closed, or error code 'not_found' if the document set is unknown.

func (*CloseDocumentSet) Descriptor deprecated

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

Deprecated: Use CloseDocumentSet.ProtoReflect.Descriptor instead.

func (*CloseDocumentSet) GetSetName

func (x *CloseDocumentSet) GetSetName() string

func (*CloseDocumentSet) ProtoMessage

func (*CloseDocumentSet) ProtoMessage()

func (*CloseDocumentSet) ProtoReflect

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

func (*CloseDocumentSet) Reset

func (x *CloseDocumentSet) Reset()

func (*CloseDocumentSet) String

func (x *CloseDocumentSet) String() string

type DocumentBatch

type DocumentBatch struct {

	// SetName is the name of the set that result is for.
	SetName string `protobuf:"bytes,1,opt,name=set_name,json=setName,proto3" json:"set_name,omitempty"`
	// Documents is a batch of documents that are included in the set.
	Documents []*DocumentState `protobuf:"bytes,2,rep,name=documents,proto3" json:"documents,omitempty"`
	// FinalBatch is set to true for the last batch in the response.
	FinalBatch bool `protobuf:"varint,3,opt,name=final_batch,json=finalBatch,proto3" json:"final_batch,omitempty"`
	// contains filtered or unexported fields
}

DocumentBatch is emitted in response to a CallGetDocuments message. Multiple batch messages can be emitted for a single get documents call.

func (*DocumentBatch) Descriptor deprecated

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

Deprecated: Use DocumentBatch.ProtoReflect.Descriptor instead.

func (*DocumentBatch) GetDocuments

func (x *DocumentBatch) GetDocuments() []*DocumentState

func (*DocumentBatch) GetFinalBatch

func (x *DocumentBatch) GetFinalBatch() bool

func (*DocumentBatch) GetSetName

func (x *DocumentBatch) GetSetName() string

func (*DocumentBatch) ProtoMessage

func (*DocumentBatch) ProtoMessage()

func (*DocumentBatch) ProtoReflect

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

func (*DocumentBatch) Reset

func (x *DocumentBatch) Reset()

func (*DocumentBatch) String

func (x *DocumentBatch) String() string

type DocumentRemoved

type DocumentRemoved struct {
	SetName      string `protobuf:"bytes,1,opt,name=set_name,json=setName,proto3" json:"set_name,omitempty"`
	DocumentUuid string `protobuf:"bytes,2,opt,name=document_uuid,json=documentUuid,proto3" json:"document_uuid,omitempty"`
	// contains filtered or unexported fields
}

DocumentRemoved is emitted when a document is removed from the set.

func (*DocumentRemoved) Descriptor deprecated

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

Deprecated: Use DocumentRemoved.ProtoReflect.Descriptor instead.

func (*DocumentRemoved) GetDocumentUuid

func (x *DocumentRemoved) GetDocumentUuid() string

func (*DocumentRemoved) GetSetName

func (x *DocumentRemoved) GetSetName() string

func (*DocumentRemoved) ProtoMessage

func (*DocumentRemoved) ProtoMessage()

func (*DocumentRemoved) ProtoReflect

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

func (*DocumentRemoved) Reset

func (x *DocumentRemoved) Reset()

func (*DocumentRemoved) String

func (x *DocumentRemoved) String() string

type DocumentState

type DocumentState struct {

	// Meta information about the document.
	Meta *repository.DocumentMeta `protobuf:"bytes,1,opt,name=meta,proto3" json:"meta,omitempty"`
	// Document is the document itself.
	Document *newsdoc.Document `protobuf:"bytes,2,opt,name=document,proto3" json:"document,omitempty"`
	// contains filtered or unexported fields
}

func (*DocumentState) Descriptor deprecated

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

Deprecated: Use DocumentState.ProtoReflect.Descriptor instead.

func (*DocumentState) GetDocument

func (x *DocumentState) GetDocument() *newsdoc.Document

func (*DocumentState) GetMeta

func (x *DocumentState) GetMeta() *repository.DocumentMeta

func (*DocumentState) ProtoMessage

func (*DocumentState) ProtoMessage()

func (*DocumentState) ProtoReflect

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

func (*DocumentState) Reset

func (x *DocumentState) Reset()

func (*DocumentState) String

func (x *DocumentState) String() string

type DocumentUpdate

type DocumentUpdate struct {

	// SetName is the name of the set that result is for.
	SetName string `protobuf:"bytes,1,opt,name=set_name,json=setName,proto3" json:"set_name,omitempty"`
	// Event is the change event for the document.
	Event *repository.EventlogItem `protobuf:"bytes,2,opt,name=event,proto3" json:"event,omitempty"`
	// Meta information about the document, only included if the document is newly
	// added to the document set.
	Meta *repository.DocumentMeta `protobuf:"bytes,3,opt,name=meta,proto3" json:"meta,omitempty"`
	// Document is included for document update events or if the document is newly
	// added to the document set.
	Document *newsdoc.Document `protobuf:"bytes,4,opt,name=document,proto3" json:"document,omitempty"`
	// Included is true if the update is for a document that was added through
	// inclusion.
	Included bool `protobuf:"varint,5,opt,name=included,proto3" json:"included,omitempty"`
	// contains filtered or unexported fields
}

DocumentUpdate is emitted when a write operation has affected a document in a set.

func (*DocumentUpdate) Descriptor deprecated

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

Deprecated: Use DocumentUpdate.ProtoReflect.Descriptor instead.

func (*DocumentUpdate) GetDocument

func (x *DocumentUpdate) GetDocument() *newsdoc.Document

func (*DocumentUpdate) GetEvent

func (x *DocumentUpdate) GetEvent() *repository.EventlogItem

func (*DocumentUpdate) GetIncluded

func (x *DocumentUpdate) GetIncluded() bool

func (*DocumentUpdate) GetMeta

func (x *DocumentUpdate) GetMeta() *repository.DocumentMeta

func (*DocumentUpdate) GetSetName

func (x *DocumentUpdate) GetSetName() string

func (*DocumentUpdate) ProtoMessage

func (*DocumentUpdate) ProtoMessage()

func (*DocumentUpdate) ProtoReflect

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

func (*DocumentUpdate) Reset

func (x *DocumentUpdate) Reset()

func (*DocumentUpdate) String

func (x *DocumentUpdate) String() string

type Error

type Error struct {

	// ErrorCode classifying the error.
	ErrorCode string `protobuf:"bytes,1,opt,name=error_code,json=errorCode,proto3" json:"error_code,omitempty"`
	// ErrorMessage describing the error.
	ErrorMessage string `protobuf:"bytes,2,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
	// contains filtered or unexported fields
}

Error is used to communicate errors.

func (*Error) Descriptor deprecated

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

Deprecated: Use Error.ProtoReflect.Descriptor instead.

func (*Error) GetErrorCode

func (x *Error) GetErrorCode() string

func (*Error) GetErrorMessage

func (x *Error) GetErrorMessage() 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 GetDocuments

type GetDocuments struct {

	// SetName is the name of the document set. Required when subscribing.
	SetName string `protobuf:"bytes,1,opt,name=set_name,json=setName,proto3" json:"set_name,omitempty"`
	// Type of the documents to get.
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// Timespan is the inclusive time range to get documents for. Optional, this
	// is only available for document types with time expressions and/or
	// deliverables.
	Timespan *repository.Timespan `protobuf:"bytes,3,opt,name=timespan,proto3" json:"timespan,omitempty"`
	// Labels are the labels that the documents must match.
	Labels []string `protobuf:"bytes,4,rep,name=labels,proto3" json:"labels,omitempty"`
	// Filter to apply to the documents.
	Filter *repository.DocumentFilter `protobuf:"bytes,5,opt,name=filter,proto3" json:"filter,omitempty"`
	// Include will include documents with an UUID that matches the uuid of the
	// newdoc extraction expression. Timespans, labels and filters will not be
	// applied to included documents.
	Include []string `protobuf:"bytes,6,rep,name=include,proto3" json:"include,omitempty"`
	// IncludeACLs should be set to true to include ACL update events in the
	// stream of updates.
	IncludeAcls bool `protobuf:"varint,7,opt,name=include_acls,json=includeAcls,proto3" json:"include_acls,omitempty"`
	// contains filtered or unexported fields
}

GetDocuments is used to fetch and optionally subscribe to a set of documents.

Responds with a series of RespGetDocumentsBatch followed by RespDocumentUpdate as changes occur.

func (*GetDocuments) Descriptor deprecated

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

Deprecated: Use GetDocuments.ProtoReflect.Descriptor instead.

func (*GetDocuments) GetFilter

func (x *GetDocuments) GetFilter() *repository.DocumentFilter

func (*GetDocuments) GetInclude

func (x *GetDocuments) GetInclude() []string

func (*GetDocuments) GetIncludeAcls

func (x *GetDocuments) GetIncludeAcls() bool

func (*GetDocuments) GetLabels

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

func (*GetDocuments) GetSetName

func (x *GetDocuments) GetSetName() string

func (*GetDocuments) GetTimespan

func (x *GetDocuments) GetTimespan() *repository.Timespan

func (*GetDocuments) GetType

func (x *GetDocuments) GetType() string

func (*GetDocuments) ProtoMessage

func (*GetDocuments) ProtoMessage()

func (*GetDocuments) ProtoReflect

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

func (*GetDocuments) Reset

func (x *GetDocuments) Reset()

func (*GetDocuments) String

func (x *GetDocuments) String() string

type InclusionBatch

type InclusionBatch struct {

	// SetName is the name of the set that result is for.
	SetName string `protobuf:"bytes,1,opt,name=set_name,json=setName,proto3" json:"set_name,omitempty"`
	// Documents is a batch of documents that are included in the set.
	Documents []*InclusionDocument `protobuf:"bytes,2,rep,name=documents,proto3" json:"documents,omitempty"`
	// contains filtered or unexported fields
}

InclusionBatch is emitted when documents are first included by documents in the set.

func (*InclusionBatch) Descriptor deprecated

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

Deprecated: Use InclusionBatch.ProtoReflect.Descriptor instead.

func (*InclusionBatch) GetDocuments

func (x *InclusionBatch) GetDocuments() []*InclusionDocument

func (*InclusionBatch) GetSetName

func (x *InclusionBatch) GetSetName() string

func (*InclusionBatch) ProtoMessage

func (*InclusionBatch) ProtoMessage()

func (*InclusionBatch) ProtoReflect

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

func (*InclusionBatch) Reset

func (x *InclusionBatch) Reset()

func (*InclusionBatch) String

func (x *InclusionBatch) String() string

type InclusionDocument

type InclusionDocument struct {
	Uuid  string         `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	State *DocumentState `protobuf:"bytes,2,opt,name=state,proto3" json:"state,omitempty"`
	// contains filtered or unexported fields
}

InclusionDocument is a document that was referenced by a document in the set.

func (*InclusionDocument) Descriptor deprecated

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

Deprecated: Use InclusionDocument.ProtoReflect.Descriptor instead.

func (*InclusionDocument) GetState

func (x *InclusionDocument) GetState() *DocumentState

func (*InclusionDocument) GetUuid

func (x *InclusionDocument) GetUuid() string

func (*InclusionDocument) ProtoMessage

func (*InclusionDocument) ProtoMessage()

func (*InclusionDocument) ProtoReflect

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

func (*InclusionDocument) Reset

func (x *InclusionDocument) Reset()

func (*InclusionDocument) String

func (x *InclusionDocument) String() string

type Response

type Response struct {

	// CallID is the ID of the call that this is a response to.
	CallId string `protobuf:"bytes,1,opt,name=call_id,json=callId,proto3" json:"call_id,omitempty"`
	// Error is set if the call failed.
	Error          *Error           `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"`
	DocumentBatch  *DocumentBatch   `protobuf:"bytes,3,opt,name=document_batch,json=documentBatch,proto3" json:"document_batch,omitempty"`
	DocumentUpdate *DocumentUpdate  `protobuf:"bytes,4,opt,name=document_update,json=documentUpdate,proto3" json:"document_update,omitempty"`
	InclusionBatch *InclusionBatch  `protobuf:"bytes,5,opt,name=inclusion_batch,json=inclusionBatch,proto3" json:"inclusion_batch,omitempty"`
	Removed        *DocumentRemoved `protobuf:"bytes,6,opt,name=removed,proto3" json:"removed,omitempty"`
	// Handled is true when the call has been completely handled without errors.
	Handled bool `protobuf:"varint,7,opt,name=handled,proto3" json:"handled,omitempty"`
	// contains filtered or unexported fields
}

func (*Response) Descriptor deprecated

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

Deprecated: Use Response.ProtoReflect.Descriptor instead.

func (*Response) GetCallId

func (x *Response) GetCallId() string

func (*Response) GetDocumentBatch

func (x *Response) GetDocumentBatch() *DocumentBatch

func (*Response) GetDocumentUpdate

func (x *Response) GetDocumentUpdate() *DocumentUpdate

func (*Response) GetError

func (x *Response) GetError() *Error

func (*Response) GetHandled

func (x *Response) GetHandled() bool

func (*Response) GetInclusionBatch

func (x *Response) GetInclusionBatch() *InclusionBatch

func (*Response) GetRemoved

func (x *Response) GetRemoved() *DocumentRemoved

func (*Response) ProtoMessage

func (*Response) ProtoMessage()

func (*Response) ProtoReflect

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

func (*Response) Reset

func (x *Response) Reset()

func (*Response) String

func (x *Response) String() string

Jump to

Keyboard shortcuts

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