trailindex

package
v1.33.0 Latest Latest
Warning

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

Go to latest
Published: Jan 22, 2024 License: Apache-2.0 Imports: 2 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Connection

type Connection struct {
	ConnID string `json:"connection_id,omitempty"`
	Status string `json:"status,omitempty"`
}

Connection connection definition

type IndexResponse

type IndexResponse struct {
	ConnID      string `json:"connection_id,omitempty"`
	ChanID      string `json:"channel_id,omitempty"`
	Protocol    string `json:"protocol,omitempty"`
	ChannelType string `json:"type,omitempty"`
	TimeStamp   string `json:"timestamp,omitempty"`
	Content     string `json:"content,omitempty"`
	Position    int    `json:"position,omitempty"`
}

IndexResponse trail index response definition

type Params

type Params struct {
	Offset  int    `json:"offset,omitempty"`
	Limit   int    `json:"limit,omitempty"`
	Sortdir string `json:"sortdir,omitempty"`
}

Params struct for pagination queries.

type SearchRequestObject

type SearchRequestObject struct {
	ConnID    string `json:"connection_id"`
	ChanID    string `json:"channel_id"`
	Protocol  string `json:"protocol"`
	Keywords  string `json:"keywords"`
	StartTime string `json:"start_time"`
	EndTime   string `json:"end_time"`
	StartPos  int    `json:"start_position"`
	EndPos    int    `json:"end_position"`
}

SearchRequestObject search request object definition

type TrailIndex

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

TrailIndex is a trail index client instance.

func New

func New(api restapi.Connector) *TrailIndex

New creates a new trail index client instance, using the argument SDK API client.

func (*TrailIndex) IndexingStatus

func (store *TrailIndex) IndexingStatus(connectionID string) (*Connection, error)

IndexingStatus get indexing status of the connection

func (*TrailIndex) IndexingStatuses

func (store *TrailIndex) IndexingStatuses(connectionIDs []string) ([]Connection, error)

IndexingStatuses gets the statuses of the specified connections

func (*TrailIndex) SearchContent

func (store *TrailIndex) SearchContent(offset, limit int, sortdir string, searchObject SearchRequestObject) ([]IndexResponse, error)

SearchContent search for the content based on the search parameters defined

func (*TrailIndex) StartIndexing

func (store *TrailIndex) StartIndexing(connectionIDs []string) ([]Connection, error)

StartIndexing starts indexing of the specified connections

Jump to

Keyboard shortcuts

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