search

package
v1.0.3 Latest Latest
Warning

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

Go to latest
Published: Feb 24, 2026 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type InvalidPaginationParamsError

type InvalidPaginationParamsError interface {
	cenclierrors.CencliError
}

func NewInvalidPaginationParamsError

func NewInvalidPaginationParamsError(reason string) InvalidPaginationParamsError

type Params

type Params struct {
	OrgID        mo.Option[identifiers.OrganizationID]
	CollectionID mo.Option[identifiers.CollectionID]
	Query        string
	Fields       []string
	PageSize     mo.Option[uint64]
	MaxPages     mo.Option[uint64]
}

Params bundles inputs for performing a search query. Using a struct prevents parameter drift and keeps the API extensible.

type Result

type Result struct {
	Meta      *responsemeta.ResponseMeta
	Hits      []assets.Asset
	TotalHits int64
	// PartialError contains any error encountered after the first successful page.
	// When present, the result contains partial data and the error should be reported to the user.
	PartialError cenclierrors.CencliError
}

Result is the response from the search service.

type Service

type Service interface {
	Search(ctx context.Context, params Params) (Result, cenclierrors.CencliError)
}

Service provides asset search capabilities.

func New

func New(client client.Client) Service

Jump to

Keyboard shortcuts

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