docstore

package
v2.3.5+incompatible Latest Latest
Warning

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

 Go to latest Published: Sep 13, 2021 License: AGPL-3.0 Imports: 6 Imported by: 113

Documentation

Overview

Package docstore is a generated protocol buffer package.

It is generated from these files: 

docstore.proto

It has these top-level messages: 

Document
DocumentQuery
PutDocumentRequest
PutDocumentResponse
GetDocumentRequest
GetDocumentResponse
DeleteDocumentsRequest
DeleteDocumentsResponse
ListDocumentsRequest
ListDocumentsResponse
CountDocumentsResponse

Package docstore is a generated protocol buffer package.

It is generated from these files: 

docstore.proto

It has these top-level messages: 

Document
DocumentQuery
PutDocumentRequest
PutDocumentResponse
GetDocumentRequest
GetDocumentResponse
DeleteDocumentsRequest
DeleteDocumentsResponse
ListDocumentsRequest
ListDocumentsResponse
CountDocumentsResponse

Index

Constants

This section is empty.

Variables

View Source 
var DocumentType_name = map[int32]string{
	0: "JSON",
	1: "BINARY",
}
View Source 
var DocumentType_value = map[string]int32{
	"JSON":   0,
	"BINARY": 1,
}

Functions

func RegisterDocStoreHandler 

func RegisterDocStoreHandler(s server.Server, hdlr DocStoreHandler, opts ...server.HandlerOption)

Types

type CountDocumentsResponse 

type CountDocumentsResponse struct {
	Total int64 `protobuf:"varint,1,opt,name=Total" json:"Total,omitempty"`
}

func (*CountDocumentsResponse) Descriptor 

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

func (*CountDocumentsResponse) GetTotal 

func (m *CountDocumentsResponse) GetTotal() int64

func (*CountDocumentsResponse) ProtoMessage 

func (*CountDocumentsResponse) ProtoMessage()

func (*CountDocumentsResponse) Reset 

func (m *CountDocumentsResponse) Reset()

func (*CountDocumentsResponse) String 

func (m *CountDocumentsResponse) String() string

type DeleteDocumentsRequest 

type DeleteDocumentsRequest struct {
	StoreID    string         `protobuf:"bytes,1,opt,name=StoreID" json:"StoreID,omitempty"`
	DocumentID string         `protobuf:"bytes,2,opt,name=DocumentID" json:"DocumentID,omitempty"`
	Query      *DocumentQuery `protobuf:"bytes,3,opt,name=Query" json:"Query,omitempty"`
}

func (*DeleteDocumentsRequest) Descriptor 

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

func (*DeleteDocumentsRequest) GetDocumentID 

func (m *DeleteDocumentsRequest) GetDocumentID() string

func (*DeleteDocumentsRequest) GetQuery 

func (m *DeleteDocumentsRequest) GetQuery() *DocumentQuery

func (*DeleteDocumentsRequest) GetStoreID 

func (m *DeleteDocumentsRequest) GetStoreID() string

func (*DeleteDocumentsRequest) ProtoMessage 

func (*DeleteDocumentsRequest) ProtoMessage()

func (*DeleteDocumentsRequest) Reset 

func (m *DeleteDocumentsRequest) Reset()

func (*DeleteDocumentsRequest) String 

func (m *DeleteDocumentsRequest) String() string

type DeleteDocumentsResponse 

type DeleteDocumentsResponse struct {
	Success       bool  `protobuf:"varint,1,opt,name=Success" json:"Success,omitempty"`
	DeletionCount int32 `protobuf:"varint,2,opt,name=DeletionCount" json:"DeletionCount,omitempty"`
}

func (*DeleteDocumentsResponse) Descriptor 

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

func (*DeleteDocumentsResponse) GetDeletionCount 

func (m *DeleteDocumentsResponse) GetDeletionCount() int32

func (*DeleteDocumentsResponse) GetSuccess 

func (m *DeleteDocumentsResponse) GetSuccess() bool

func (*DeleteDocumentsResponse) ProtoMessage 

func (*DeleteDocumentsResponse) ProtoMessage()

func (*DeleteDocumentsResponse) Reset 

func (m *DeleteDocumentsResponse) Reset()

func (*DeleteDocumentsResponse) String 

func (m *DeleteDocumentsResponse) String() string

type DocStore 

type DocStore struct {
	DocStoreHandler
}

func (*DocStore) CountDocuments 

func (h *DocStore) CountDocuments(ctx context.Context, in *ListDocumentsRequest, out *CountDocumentsResponse) error

func (*DocStore) DeleteDocuments 

func (h *DocStore) DeleteDocuments(ctx context.Context, in *DeleteDocumentsRequest, out *DeleteDocumentsResponse) error

func (*DocStore) GetDocument 

func (h *DocStore) GetDocument(ctx context.Context, in *GetDocumentRequest, out *GetDocumentResponse) error

func (*DocStore) ListDocuments 

func (h *DocStore) ListDocuments(ctx context.Context, stream server.Streamer) error

func (*DocStore) PutDocument 

func (h *DocStore) PutDocument(ctx context.Context, in *PutDocumentRequest, out *PutDocumentResponse) error

type DocStoreClient 

type DocStoreClient interface {
	PutDocument(ctx context.Context, in *PutDocumentRequest, opts ...client.CallOption) (*PutDocumentResponse, error)
	GetDocument(ctx context.Context, in *GetDocumentRequest, opts ...client.CallOption) (*GetDocumentResponse, error)
	DeleteDocuments(ctx context.Context, in *DeleteDocumentsRequest, opts ...client.CallOption) (*DeleteDocumentsResponse, error)
	CountDocuments(ctx context.Context, in *ListDocumentsRequest, opts ...client.CallOption) (*CountDocumentsResponse, error)
	ListDocuments(ctx context.Context, in *ListDocumentsRequest, opts ...client.CallOption) (DocStore_ListDocumentsClient, error)
}

func NewDocStoreClient 

func NewDocStoreClient(serviceName string, c client.Client) DocStoreClient

type DocStoreHandler 

type DocStoreHandler interface {
	PutDocument(context.Context, *PutDocumentRequest, *PutDocumentResponse) error
	GetDocument(context.Context, *GetDocumentRequest, *GetDocumentResponse) error
	DeleteDocuments(context.Context, *DeleteDocumentsRequest, *DeleteDocumentsResponse) error
	CountDocuments(context.Context, *ListDocumentsRequest, *CountDocumentsResponse) error
	ListDocuments(context.Context, *ListDocumentsRequest, DocStore_ListDocumentsStream) error
}

type DocStore_ListDocumentsClient 

type DocStore_ListDocumentsClient interface {
	SendMsg(interface{}) error
	RecvMsg(interface{}) error
	Close() error
	Recv() (*ListDocumentsResponse, error)
}

type DocStore_ListDocumentsStream 

type DocStore_ListDocumentsStream interface {
	SendMsg(interface{}) error
	RecvMsg(interface{}) error
	Close() error
	Send(*ListDocumentsResponse) error
}

type Document 

type Document struct {
	ID            string       `protobuf:"bytes,2,opt,name=ID" json:"ID,omitempty"`
	Type          DocumentType `protobuf:"varint,3,opt,name=Type,enum=docstore.DocumentType" json:"Type,omitempty"`
	Owner         string       `protobuf:"bytes,4,opt,name=Owner" json:"Owner,omitempty"`
	Data          string       `protobuf:"bytes,5,opt,name=Data" json:"Data,omitempty"`
	IndexableMeta string       `protobuf:"bytes,6,opt,name=IndexableMeta" json:"IndexableMeta,omitempty"`
}

func (*Document) Descriptor 

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

func (*Document) GetData 

func (m *Document) GetData() string

func (*Document) GetID 

func (m *Document) GetID() string

func (*Document) GetIndexableMeta 

func (m *Document) GetIndexableMeta() string

func (*Document) GetOwner 

func (m *Document) GetOwner() string

func (*Document) GetType 

func (m *Document) GetType() DocumentType

func (*Document) ProtoMessage 

func (*Document) ProtoMessage()

func (*Document) Reset 

func (m *Document) Reset()

func (*Document) String 

func (m *Document) String() string

type DocumentQuery 

type DocumentQuery struct {
	ID        string `protobuf:"bytes,2,opt,name=ID" json:"ID,omitempty"`
	Owner     string `protobuf:"bytes,3,opt,name=Owner" json:"Owner,omitempty"`
	MetaQuery string `protobuf:"bytes,4,opt,name=MetaQuery" json:"MetaQuery,omitempty"`
}

func (*DocumentQuery) Descriptor 

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

func (*DocumentQuery) GetID 

func (m *DocumentQuery) GetID() string

func (*DocumentQuery) GetMetaQuery 

func (m *DocumentQuery) GetMetaQuery() string

func (*DocumentQuery) GetOwner 

func (m *DocumentQuery) GetOwner() string

func (*DocumentQuery) ProtoMessage 

func (*DocumentQuery) ProtoMessage()

func (*DocumentQuery) Reset 

func (m *DocumentQuery) Reset()

func (*DocumentQuery) String 

func (m *DocumentQuery) String() string

type DocumentType 

type DocumentType int32
const (
	DocumentType_JSON   DocumentType = 0
	DocumentType_BINARY DocumentType = 1
)

func (DocumentType) EnumDescriptor 

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

func (DocumentType) String 

func (x DocumentType) String() string

type GetDocumentRequest 

type GetDocumentRequest struct {
	StoreID    string `protobuf:"bytes,1,opt,name=StoreID" json:"StoreID,omitempty"`
	DocumentID string `protobuf:"bytes,2,opt,name=DocumentID" json:"DocumentID,omitempty"`
}

func (*GetDocumentRequest) Descriptor 

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

func (*GetDocumentRequest) GetDocumentID 

func (m *GetDocumentRequest) GetDocumentID() string

func (*GetDocumentRequest) GetStoreID 

func (m *GetDocumentRequest) GetStoreID() string

func (*GetDocumentRequest) ProtoMessage 

func (*GetDocumentRequest) ProtoMessage()

func (*GetDocumentRequest) Reset 

func (m *GetDocumentRequest) Reset()

func (*GetDocumentRequest) String 

func (m *GetDocumentRequest) String() string

type GetDocumentResponse 

type GetDocumentResponse struct {
	Document  *Document `protobuf:"bytes,1,opt,name=Document" json:"Document,omitempty"`
	BinaryUrl string    `protobuf:"bytes,2,opt,name=BinaryUrl" json:"BinaryUrl,omitempty"`
}

func (*GetDocumentResponse) Descriptor 

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

func (*GetDocumentResponse) GetBinaryUrl 

func (m *GetDocumentResponse) GetBinaryUrl() string

func (*GetDocumentResponse) GetDocument 

func (m *GetDocumentResponse) GetDocument() *Document

func (*GetDocumentResponse) ProtoMessage 

func (*GetDocumentResponse) ProtoMessage()

func (*GetDocumentResponse) Reset 

func (m *GetDocumentResponse) Reset()

func (*GetDocumentResponse) String 

func (m *GetDocumentResponse) String() string

type ListDocumentsRequest 

type ListDocumentsRequest struct {
	StoreID string         `protobuf:"bytes,1,opt,name=StoreID" json:"StoreID,omitempty"`
	Query   *DocumentQuery `protobuf:"bytes,2,opt,name=Query" json:"Query,omitempty"`
}

func (*ListDocumentsRequest) Descriptor 

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

func (*ListDocumentsRequest) GetQuery 

func (m *ListDocumentsRequest) GetQuery() *DocumentQuery

func (*ListDocumentsRequest) GetStoreID 

func (m *ListDocumentsRequest) GetStoreID() string

func (*ListDocumentsRequest) ProtoMessage 

func (*ListDocumentsRequest) ProtoMessage()

func (*ListDocumentsRequest) Reset 

func (m *ListDocumentsRequest) Reset()

func (*ListDocumentsRequest) String 

func (m *ListDocumentsRequest) String() string

type ListDocumentsResponse 

type ListDocumentsResponse struct {
	Document  *Document `protobuf:"bytes,1,opt,name=Document" json:"Document,omitempty"`
	BinaryUrl string    `protobuf:"bytes,2,opt,name=BinaryUrl" json:"BinaryUrl,omitempty"`
	Score     int32     `protobuf:"varint,3,opt,name=Score" json:"Score,omitempty"`
}

func (*ListDocumentsResponse) Descriptor 

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

func (*ListDocumentsResponse) GetBinaryUrl 

func (m *ListDocumentsResponse) GetBinaryUrl() string

func (*ListDocumentsResponse) GetDocument 

func (m *ListDocumentsResponse) GetDocument() *Document

func (*ListDocumentsResponse) GetScore 

func (m *ListDocumentsResponse) GetScore() int32

func (*ListDocumentsResponse) ProtoMessage 

func (*ListDocumentsResponse) ProtoMessage()

func (*ListDocumentsResponse) Reset 

func (m *ListDocumentsResponse) Reset()

func (*ListDocumentsResponse) String 

func (m *ListDocumentsResponse) String() string

type PutDocumentRequest 

type PutDocumentRequest struct {
	StoreID    string    `protobuf:"bytes,1,opt,name=StoreID" json:"StoreID,omitempty"`
	DocumentID string    `protobuf:"bytes,2,opt,name=DocumentID" json:"DocumentID,omitempty"`
	Document   *Document `protobuf:"bytes,3,opt,name=Document" json:"Document,omitempty"`
}

func (*PutDocumentRequest) Descriptor 

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

func (*PutDocumentRequest) GetDocument 

func (m *PutDocumentRequest) GetDocument() *Document

func (*PutDocumentRequest) GetDocumentID 

func (m *PutDocumentRequest) GetDocumentID() string

func (*PutDocumentRequest) GetStoreID 

func (m *PutDocumentRequest) GetStoreID() string

func (*PutDocumentRequest) ProtoMessage 

func (*PutDocumentRequest) ProtoMessage()

func (*PutDocumentRequest) Reset 

func (m *PutDocumentRequest) Reset()

func (*PutDocumentRequest) String 

func (m *PutDocumentRequest) String() string

type PutDocumentResponse 

type PutDocumentResponse struct {
	Document *Document `protobuf:"bytes,1,opt,name=Document" json:"Document,omitempty"`
}

func (*PutDocumentResponse) Descriptor 

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

func (*PutDocumentResponse) GetDocument 

func (m *PutDocumentResponse) GetDocument() *Document

func (*PutDocumentResponse) ProtoMessage 

func (*PutDocumentResponse) ProtoMessage()

func (*PutDocumentResponse) Reset 

func (m *PutDocumentResponse) Reset()

func (*PutDocumentResponse) String 

func (m *PutDocumentResponse) String() string

type ShareDocument added in v1.2.0 

type ShareDocument struct {
	ShareType             string                      `json:"SHARE_TYPE"`
	ExpireTime            int64                       `json:"EXPIRE_TIME"`
	ShortFormUrl          string                      `json:"SHORT_FORM_URL"`
	RepositoryId          string                      `json:"REPOSITORY"`
	ParentRepositoryId    string                      `json:"PARENT_REPOSITORY_ID"`
	DownloadDisabled      bool                        `json:"DOWNLOAD_DISABLED"`
	ApplicationBase       string                      `json:"PYDIO_APPLICATION_BASE"`
	TemplateName          string                      `json:"PYDIO_TEMPLATE_NAME"`
	DownloadLimit         int64                       `json:"DOWNLOAD_LIMIT"`
	DownloadCount         int64                       `json:"DOWNLOAD_COUNT"`
	PreLogUser            string                      `json:"PRELOG_USER"`
	PresetLogin           string                      `json:"PRESET_LOGIN"`
	Target                string                      `json:"TARGET"`
	TargetUsers           map[string]*TargetUserEntry `json:"TARGET_USERS"`
	RestrictToTargetUsers bool                        `json:"RESTRICT_TO_TARGET_USERS"`
	OwnerId               string                      `json:"OWNER_ID"`
	PreUserUuid           string                      `json:"USER_UUID"`
}

HashDocument is a Json Marshallable representation of a document, compatible with legacy.

type TargetUserEntry added in v1.2.0 

type TargetUserEntry struct {
	Display       string `json:"display"`
	DownloadCount int32  `json:"download_count"`
}

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.