api

package
v0.0.0-...-8693642 Latest Latest
Warning

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

 Go to latest Published: Aug 9, 2021 License: MIT Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	FileType_name = map[int32]string{
		0: "CSV",
		1: "XLXS",
		2: "HTML",
	}
	FileType_value = map[string]int32{
		"CSV":  0,
		"XLXS": 1,
		"HTML": 2,
	}
)

Enum value maps for FileType.

View Source 
var File_obsidian_proto protoreflect.FileDescriptor
View Source 
var Obsidian_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "api.Obsidian",
	HandlerType: (*ObsidianServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "AddDatasource",
			Handler:    _Obsidian_AddDatasource_Handler,
		},
		{
			MethodName: "CheckForDatasource",
			Handler:    _Obsidian_CheckForDatasource_Handler,
		},
		{
			MethodName: "HTMLNodeHelper",
			Handler:    _Obsidian_HTMLNodeHelper_Handler,
		},
		{
			MethodName: "HTMLSearch",
			Handler:    _Obsidian_HTMLSearch_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "obsidian.proto",
}

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

Functions

func HTMLNodeRequestHelp 

func HTMLNodeRequestHelp() []string

func RegisterObsidianServer 

func RegisterObsidianServer(s grpc.ServiceRegistrar, srv ObsidianServer)

Types

type CheckDatasourceRequest 

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

func (*CheckDatasourceRequest) Descriptor deprecated 

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

Deprecated: Use CheckDatasourceRequest.ProtoReflect.Descriptor instead.

func (*CheckDatasourceRequest) GetDatasourceAlias 

func (x *CheckDatasourceRequest) GetDatasourceAlias() string

func (*CheckDatasourceRequest) ProtoMessage 

func (*CheckDatasourceRequest) ProtoMessage()

func (*CheckDatasourceRequest) ProtoReflect 

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

func (*CheckDatasourceRequest) Reset 

func (x *CheckDatasourceRequest) Reset()

func (*CheckDatasourceRequest) String 

func (x *CheckDatasourceRequest) String() string

type CheckDatasourceResponse 

type CheckDatasourceResponse struct {
	Message  string `protobuf:"bytes,1,opt,name=Message,proto3" json:"Message,omitempty"`
	FilePath string `protobuf:"bytes,2,opt,name=FilePath,proto3" json:"FilePath,omitempty"`
	// contains filtered or unexported fields
}

func (*CheckDatasourceResponse) Descriptor deprecated 

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

Deprecated: Use CheckDatasourceResponse.ProtoReflect.Descriptor instead.

func (*CheckDatasourceResponse) GetFilePath 

func (x *CheckDatasourceResponse) GetFilePath() string

func (*CheckDatasourceResponse) GetMessage 

func (x *CheckDatasourceResponse) GetMessage() string

func (*CheckDatasourceResponse) ProtoMessage 

func (*CheckDatasourceResponse) ProtoMessage()

func (*CheckDatasourceResponse) ProtoReflect 

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

func (*CheckDatasourceResponse) Reset 

func (x *CheckDatasourceResponse) Reset()

func (*CheckDatasourceResponse) String 

func (x *CheckDatasourceResponse) String() string

type DatasourceAdd 

type DatasourceAdd struct {
	OverwriteExisting bool
	Alias             string
}

type DatasourceAddRequest 

type DatasourceAddRequest struct {
	OverwriteExistingConfig       bool         `` /* 133-byte string literal not displayed */
	DatasourceName                string       `protobuf:"bytes,2,opt,name=datasource_name,json=datasourceName,proto3" json:"datasource_name,omitempty"`
	SearchInProgramDirectory      bool         `` /* 138-byte string literal not displayed */
	DirectoriesToSearch           []string     `protobuf:"bytes,4,rep,name=directories_to_search,json=directoriesToSearch,proto3" json:"directories_to_search,omitempty"`
	FileExtension                 FileType     `protobuf:"varint,5,opt,name=file_extension,json=fileExtension,proto3,enum=api.FileType" json:"file_extension,omitempty"`
	FilenameSpecifications        []*FileSpec  `` /* 127-byte string literal not displayed */
	RequireAllValueSpecifications bool         `` /* 153-byte string literal not displayed */
	ValueSpecifications           []*ValueSpec `protobuf:"bytes,8,rep,name=value_specifications,json=valueSpecifications,proto3" json:"value_specifications,omitempty"`
	// contains filtered or unexported fields
}

For specifying parameters of a new datasource

func (*DatasourceAddRequest) Alias 

func (req *DatasourceAddRequest) Alias() string

Alias returns the value of DatasourceName.

func (*DatasourceAddRequest) Descriptor deprecated 

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

Deprecated: Use DatasourceAddRequest.ProtoReflect.Descriptor instead.

func (*DatasourceAddRequest) FileType 

func (req *DatasourceAddRequest) FileType() string

FileType returns the string value of FileExtension.

func (*DatasourceAddRequest) FilenameSpecs 

func (req *DatasourceAddRequest) FilenameSpecs() (fileSpecs []datasource.FilenameSpec)

FilenameSpecs returns the FilenameSpec equivalent of FilenameSpecifications.

func (*DatasourceAddRequest) GetDatasourceName 

func (x *DatasourceAddRequest) GetDatasourceName() string

func (*DatasourceAddRequest) GetDirectoriesToSearch 

func (x *DatasourceAddRequest) GetDirectoriesToSearch() []string

func (*DatasourceAddRequest) GetFileExtension 

func (x *DatasourceAddRequest) GetFileExtension() FileType

func (*DatasourceAddRequest) GetFilenameSpecifications 

func (x *DatasourceAddRequest) GetFilenameSpecifications() []*FileSpec

func (*DatasourceAddRequest) GetOverwriteExistingConfig 

func (x *DatasourceAddRequest) GetOverwriteExistingConfig() bool

func (*DatasourceAddRequest) GetRequireAllValueSpecifications 

func (x *DatasourceAddRequest) GetRequireAllValueSpecifications() bool

func (*DatasourceAddRequest) GetSearchInProgramDirectory 

func (x *DatasourceAddRequest) GetSearchInProgramDirectory() bool

func (*DatasourceAddRequest) GetValueSpecifications 

func (x *DatasourceAddRequest) GetValueSpecifications() []*ValueSpec

func (*DatasourceAddRequest) IncludeProgramDirectory 

func (req *DatasourceAddRequest) IncludeProgramDirectory() bool

IncludeProgramDirectory returns the value of SearchInProgramDirectory.

func (*DatasourceAddRequest) OverwriteExisting 

func (req *DatasourceAddRequest) OverwriteExisting() bool

OverwriteExisting returns the value of OverwriteExistingConfig.

func (*DatasourceAddRequest) Paths 

func (req *DatasourceAddRequest) Paths() []string

Paths returns the value of DirectoriesToSearch.

func (*DatasourceAddRequest) ProtoMessage 

func (*DatasourceAddRequest) ProtoMessage()

func (*DatasourceAddRequest) ProtoReflect 

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

func (*DatasourceAddRequest) RequireAllValueSpecs 

func (req *DatasourceAddRequest) RequireAllValueSpecs() bool

RequireAllValueSpecs returns the value of RequireAllValueSpecifications.

func (*DatasourceAddRequest) Reset 

func (x *DatasourceAddRequest) Reset()

func (*DatasourceAddRequest) String 

func (x *DatasourceAddRequest) String() string

func (*DatasourceAddRequest) ValueSpecs 

func (req *DatasourceAddRequest) ValueSpecs() (valueSpecs []datasource.ValueSpec)

ValueSpecs returns the ValueSpec equivalent of ValueSpecifications.

type FileSpec 

type FileSpec struct {
	Filename            string `protobuf:"bytes,1,opt,name=Filename,proto3" json:"Filename,omitempty"`
	FilenameIsSubstring bool   `protobuf:"varint,2,opt,name=FilenameIsSubstring,proto3" json:"FilenameIsSubstring,omitempty"`
	// contains filtered or unexported fields
}

func (*FileSpec) Descriptor deprecated 

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

Deprecated: Use FileSpec.ProtoReflect.Descriptor instead.

func (*FileSpec) GetFilename 

func (x *FileSpec) GetFilename() string

func (*FileSpec) GetFilenameIsSubstring 

func (x *FileSpec) GetFilenameIsSubstring() bool

func (*FileSpec) ProtoMessage 

func (*FileSpec) ProtoMessage()

func (*FileSpec) ProtoReflect 

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

func (*FileSpec) Reset 

func (x *FileSpec) Reset()

func (*FileSpec) String 

func (x *FileSpec) String() string

type FileType 

type FileType int32
const (
	FileType_CSV  FileType = 0
	FileType_XLXS FileType = 1
	FileType_HTML FileType = 2
)

func (FileType) Descriptor 

func (FileType) Descriptor() protoreflect.EnumDescriptor

func (FileType) Enum 

func (x FileType) Enum() *FileType

func (FileType) EnumDescriptor deprecated 

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

Deprecated: Use FileType.Descriptor instead.

func (FileType) Number 

func (x FileType) Number() protoreflect.EnumNumber

func (FileType) String 

func (x FileType) String() string

func (FileType) Type 

func (FileType) Type() protoreflect.EnumType

type HTMLNodeList 

type HTMLNodeList struct {
	Name  string   `protobuf:"bytes,1,opt,name=Name,proto3" json:"Name,omitempty"`
	Nodes []string `protobuf:"bytes,2,rep,name=Nodes,proto3" json:"Nodes,omitempty"`
	// contains filtered or unexported fields
}

func (*HTMLNodeList) Descriptor deprecated 

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

Deprecated: Use HTMLNodeList.ProtoReflect.Descriptor instead.

func (*HTMLNodeList) GetName 

func (x *HTMLNodeList) GetName() string

func (*HTMLNodeList) GetNodes 

func (x *HTMLNodeList) GetNodes() []string

func (*HTMLNodeList) ProtoMessage 

func (*HTMLNodeList) ProtoMessage()

func (*HTMLNodeList) ProtoReflect 

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

func (*HTMLNodeList) Reset 

func (x *HTMLNodeList) Reset()

func (*HTMLNodeList) String 

func (x *HTMLNodeList) String() string

type HTMLNodeRequest 

type HTMLNodeRequest struct {
	Help            bool     `protobuf:"varint,1,opt,name=Help,proto3" json:"Help,omitempty"`
	DatasourceAlias string   `protobuf:"bytes,2,opt,name=DatasourceAlias,proto3" json:"DatasourceAlias,omitempty"`
	ParentLimit     int32    `protobuf:"varint,3,opt,name=ParentLimit,proto3" json:"ParentLimit,omitempty"`
	ValuesToFind    []string `protobuf:"bytes,4,rep,name=ValuesToFind,proto3" json:"ValuesToFind,omitempty"`
	// contains filtered or unexported fields
}

func (*HTMLNodeRequest) Descriptor deprecated 

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

Deprecated: Use HTMLNodeRequest.ProtoReflect.Descriptor instead.

func (*HTMLNodeRequest) GetDatasourceAlias 

func (x *HTMLNodeRequest) GetDatasourceAlias() string

func (*HTMLNodeRequest) GetHelp 

func (x *HTMLNodeRequest) GetHelp() bool

func (*HTMLNodeRequest) GetParentLimit 

func (x *HTMLNodeRequest) GetParentLimit() int32

func (*HTMLNodeRequest) GetValuesToFind 

func (x *HTMLNodeRequest) GetValuesToFind() []string

func (*HTMLNodeRequest) ProtoMessage 

func (*HTMLNodeRequest) ProtoMessage()

func (*HTMLNodeRequest) ProtoReflect 

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

func (*HTMLNodeRequest) Reset 

func (x *HTMLNodeRequest) Reset()

func (*HTMLNodeRequest) String 

func (x *HTMLNodeRequest) String() string

type HTMLSearchGroup 

type HTMLSearchGroup struct {
	Values []string `protobuf:"bytes,1,rep,name=Values,proto3" json:"Values,omitempty"`
	// contains filtered or unexported fields
}

func (*HTMLSearchGroup) Descriptor deprecated 

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

Deprecated: Use HTMLSearchGroup.ProtoReflect.Descriptor instead.

func (*HTMLSearchGroup) GetValues 

func (x *HTMLSearchGroup) GetValues() []string

func (*HTMLSearchGroup) ProtoMessage 

func (*HTMLSearchGroup) ProtoMessage()

func (*HTMLSearchGroup) ProtoReflect 

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

func (*HTMLSearchGroup) Reset 

func (x *HTMLSearchGroup) Reset()

func (*HTMLSearchGroup) String 

func (x *HTMLSearchGroup) String() string

type HTMLSearchRequest 

type HTMLSearchRequest struct {
	DatasourceAlias string             `protobuf:"bytes,1,opt,name=DatasourceAlias,proto3" json:"DatasourceAlias,omitempty"`
	SearchGroups    []*HTMLSearchGroup `protobuf:"bytes,2,rep,name=SearchGroups,proto3" json:"SearchGroups,omitempty"`
	// contains filtered or unexported fields
}

func (*HTMLSearchRequest) Descriptor deprecated 

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

Deprecated: Use HTMLSearchRequest.ProtoReflect.Descriptor instead.

func (*HTMLSearchRequest) GetDatasourceAlias 

func (x *HTMLSearchRequest) GetDatasourceAlias() string

func (*HTMLSearchRequest) GetSearchGroups 

func (x *HTMLSearchRequest) GetSearchGroups() []*HTMLSearchGroup

func (*HTMLSearchRequest) ProtoMessage 

func (*HTMLSearchRequest) ProtoMessage()

func (*HTMLSearchRequest) ProtoReflect 

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

func (*HTMLSearchRequest) Reset 

func (x *HTMLSearchRequest) Reset()

func (*HTMLSearchRequest) SearchGroupsAsStrings 

func (sReq *HTMLSearchRequest) SearchGroupsAsStrings() [][]string

SearchGroupsAsStrings converts the SearchGroups field to a 2d string slice.

func (*HTMLSearchRequest) String 

func (x *HTMLSearchRequest) String() string

type HTMLSearchResponse 

type HTMLSearchResponse struct {
	Message []string        `protobuf:"bytes,1,rep,name=Message,proto3" json:"Message,omitempty"`
	Results []*HTMLNodeList `protobuf:"bytes,2,rep,name=Results,proto3" json:"Results,omitempty"`
	// contains filtered or unexported fields
}

func (*HTMLSearchResponse) Descriptor deprecated 

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

Deprecated: Use HTMLSearchResponse.ProtoReflect.Descriptor instead.

func (*HTMLSearchResponse) GetMessage 

func (x *HTMLSearchResponse) GetMessage() []string

func (*HTMLSearchResponse) GetResults 

func (x *HTMLSearchResponse) GetResults() []*HTMLNodeList

func (*HTMLSearchResponse) ProtoMessage 

func (*HTMLSearchResponse) ProtoMessage()

func (*HTMLSearchResponse) ProtoReflect 

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

func (*HTMLSearchResponse) Reset 

func (x *HTMLSearchResponse) Reset()

func (*HTMLSearchResponse) String 

func (x *HTMLSearchResponse) String() string

type HTMlNodeResponse 

type HTMlNodeResponse struct {
	Message  []string        `protobuf:"bytes,1,rep,name=Message,proto3" json:"Message,omitempty"`
	NodeList []*HTMLNodeList `protobuf:"bytes,2,rep,name=NodeList,proto3" json:"NodeList,omitempty"`
	// contains filtered or unexported fields
}

func (*HTMlNodeResponse) Descriptor deprecated 

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

Deprecated: Use HTMlNodeResponse.ProtoReflect.Descriptor instead.

func (*HTMlNodeResponse) GetMessage 

func (x *HTMlNodeResponse) GetMessage() []string

func (*HTMlNodeResponse) GetNodeList 

func (x *HTMlNodeResponse) GetNodeList() []*HTMLNodeList

func (*HTMlNodeResponse) ProtoMessage 

func (*HTMlNodeResponse) ProtoMessage()

func (*HTMlNodeResponse) ProtoReflect 

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

func (*HTMlNodeResponse) Reset 

func (x *HTMlNodeResponse) Reset()

func (*HTMlNodeResponse) String 

func (x *HTMlNodeResponse) String() string

type ObsidianClient 

type ObsidianClient interface {
	AddDatasource(ctx context.Context, in *DatasourceAddRequest, opts ...grpc.CallOption) (*Response, error)
	CheckForDatasource(ctx context.Context, in *CheckDatasourceRequest, opts ...grpc.CallOption) (*CheckDatasourceResponse, error)
	HTMLNodeHelper(ctx context.Context, in *HTMLNodeRequest, opts ...grpc.CallOption) (*HTMlNodeResponse, error)
	HTMLSearch(ctx context.Context, in *HTMLSearchRequest, opts ...grpc.CallOption) (*HTMLSearchResponse, error)
}

ObsidianClient is the client API for Obsidian 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.

func NewObsidianClient 

func NewObsidianClient(cc grpc.ClientConnInterface) ObsidianClient

type ObsidianServer 

type ObsidianServer interface {
	AddDatasource(context.Context, *DatasourceAddRequest) (*Response, error)
	CheckForDatasource(context.Context, *CheckDatasourceRequest) (*CheckDatasourceResponse, error)
	HTMLNodeHelper(context.Context, *HTMLNodeRequest) (*HTMlNodeResponse, error)
	HTMLSearch(context.Context, *HTMLSearchRequest) (*HTMLSearchResponse, error)
	// contains filtered or unexported methods
}

ObsidianServer is the server API for Obsidian service. All implementations must embed UnimplementedObsidianServer for forward compatibility

type Response 

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

func (*Response) Descriptor deprecated 

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

Deprecated: Use Response.ProtoReflect.Descriptor instead.

func (*Response) GetMessage 

func (x *Response) GetMessage() string

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

type UnimplementedObsidianServer 

type UnimplementedObsidianServer struct {
}

UnimplementedObsidianServer must be embedded to have forward compatible implementations.

func (UnimplementedObsidianServer) AddDatasource 

func (UnimplementedObsidianServer) AddDatasource(context.Context, *DatasourceAddRequest) (*Response, error)

func (UnimplementedObsidianServer) CheckForDatasource 

func (UnimplementedObsidianServer) CheckForDatasource(context.Context, *CheckDatasourceRequest) (*CheckDatasourceResponse, error)

func (UnimplementedObsidianServer) HTMLNodeHelper 

func (UnimplementedObsidianServer) HTMLNodeHelper(context.Context, *HTMLNodeRequest) (*HTMlNodeResponse, error)

func (UnimplementedObsidianServer) HTMLSearch 

func (UnimplementedObsidianServer) HTMLSearch(context.Context, *HTMLSearchRequest) (*HTMLSearchResponse, error)

type UnsafeObsidianServer 

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

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

type ValueSpec 

type ValueSpec struct {
	Value       string `protobuf:"bytes,1,opt,name=Value,proto3" json:"Value,omitempty"`
	IsSubstring bool   `protobuf:"varint,2,opt,name=IsSubstring,proto3" json:"IsSubstring,omitempty"`
	InRow       int32  `protobuf:"varint,3,opt,name=InRow,proto3" json:"InRow,omitempty"`
	InColumn    int32  `protobuf:"varint,4,opt,name=InColumn,proto3" json:"InColumn,omitempty"`
	AnyPage     bool   `protobuf:"varint,5,opt,name=AnyPage,proto3" json:"AnyPage,omitempty"`
	OnPage      int32  `protobuf:"varint,6,opt,name=OnPage,proto3" json:"OnPage,omitempty"`
	// contains filtered or unexported fields
}

func (*ValueSpec) Descriptor deprecated 

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

Deprecated: Use ValueSpec.ProtoReflect.Descriptor instead.

func (*ValueSpec) GetAnyPage 

func (x *ValueSpec) GetAnyPage() bool

func (*ValueSpec) GetInColumn 

func (x *ValueSpec) GetInColumn() int32

func (*ValueSpec) GetInRow 

func (x *ValueSpec) GetInRow() int32

func (*ValueSpec) GetIsSubstring 

func (x *ValueSpec) GetIsSubstring() bool

func (*ValueSpec) GetOnPage 

func (x *ValueSpec) GetOnPage() int32

func (*ValueSpec) GetValue 

func (x *ValueSpec) GetValue() string

func (*ValueSpec) ProtoMessage 

func (*ValueSpec) ProtoMessage()

func (*ValueSpec) ProtoReflect 

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

func (*ValueSpec) Reset 

func (x *ValueSpec) Reset()

func (*ValueSpec) String 

func (x *ValueSpec) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.