searchsvc

Documentation

Index

• type ClientConstructor
• type IDListWriter
• type Option
  • func WithLogger(l *logger.Logger) Option
• type Prm
  • func (p *Prm) SetCommonParameters(common *util.CommonPrm)
  • func (p *Prm) SetRequestForwarder(f RequestForwarder)
  • func (p *Prm) SetWriter(w IDListWriter)
  • func (p *Prm) WithContainerID(id cid.ID)
  • func (p *Prm) WithSearchFilters(fs objectSDK.SearchFilters)
• type RequestForwarder
• type Service
  • func New(e *engine.StorageEngine, cc ClientConstructor, tg *util.TraverserGenerator, ...) *Service
  • func (s *Service) Search(ctx context.Context, prm Prm) error

Types

type ClientConstructor

type ClientConstructor interface {
	Get(client.NodeInfo) (client.MultiAddressClient, error)
}

type IDListWriter

type IDListWriter interface {
	WriteIDs([]oid.ID) error
}

IDListWriter is an interface of target component to write list of object identifiers.

type Option

type Option func(*cfg)

Option is a Service's constructor option.

func WithLogger

func WithLogger(l *logger.Logger) Option

WithLogger returns option to specify Get service's logger.

type Prm

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

Prm groups parameters of Get service call.

func (*Prm) SetCommonParameters

func (p *Prm) SetCommonParameters(common *util.CommonPrm)

SetCommonParameters sets common parameters of the operation.

func (*Prm) SetRequestForwarder

func (p *Prm) SetRequestForwarder(f RequestForwarder)

SetRequestForwarder sets callback for forwarding of the original request.

func (*Prm) SetWriter

func (p *Prm) SetWriter(w IDListWriter)

SetWriter sets target component to write list of object identifiers.

func (*Prm) WithContainerID

func (p *Prm) WithContainerID(id cid.ID)

WithContainerID sets identifier of the container to search the objects.

func (*Prm) WithSearchFilters

func (p *Prm) WithSearchFilters(fs objectSDK.SearchFilters)

WithSearchFilters sets search filters.

type RequestForwarder

type RequestForwarder func(context.Context, coreclient.NodeInfo, coreclient.MultiAddressClient) ([]oid.ID, error)

RequestForwarder is a callback for forwarding of the original Search requests.

type Service

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

Service is an utility serving requests of Object.Search service.

func New

func New(e *engine.StorageEngine,
	cc ClientConstructor,
	tg *util.TraverserGenerator,
	ns netmap.Source,
	ks *util.KeyStorage,
	opts ...Option,
) *Service

New creates, initializes and returns utility serving Object.Get service requests.

func (*Service) Search

func (s *Service) Search(ctx context.Context, prm Prm) error

Search serves a request to select the objects.