deletesvc

Documentation

Index

• type NetworkInfo
• type Option
  • func WithHeadService(h *getsvc.Service) Option
  • func WithKeyStorage(ks *util.KeyStorage) Option
  • func WithLogger(l *logger.Logger) Option
  • func WithNetworkInfo(netInfo NetworkInfo) Option
  • func WithPutService(p *putsvc.Service) Option
  • func WithSearchService(s *searchsvc.Service) Option
• type Prm
  • func (p *Prm) SetCommonParameters(common *util.CommonPrm)
  • func (p *Prm) WithAddress(addr oid.Address)
  • func (p *Prm) WithTombstoneAddressTarget(w TombstoneAddressWriter)
• type Service
  • func New(opts ...Option) *Service
  • func (s *Service) Delete(ctx context.Context, prm Prm) error
• type TombstoneAddressWriter

Types

type NetworkInfo

type NetworkInfo interface {
	netmap.State

	// Must return the lifespan of the tombstones
	// in the FrostFS epochs.
	TombstoneLifetime() (uint64, error)

	// Returns user ID of the local storage node. Result must not be nil.
	// New tombstone objects will have the result as an owner ID if removal is executed w/o a session.
	LocalNodeID() user.ID
}

NetworkInfo wraps network state and configurations.

type Option

type Option func(*cfg)

Option is a Service's constructor option.

func WithHeadService

func WithHeadService(h *getsvc.Service) Option

WithHeadService returns option to set Head service to work with object headers.

func WithKeyStorage

func WithKeyStorage(ks *util.KeyStorage) Option

WithKeyStorage returns option to set local private key storage.

func WithLogger

func WithLogger(l *logger.Logger) Option

WithLogger returns option to specify Delete service's logger.

func WithNetworkInfo

func WithNetworkInfo(netInfo NetworkInfo) Option

WithNetworkInfo returns option to set network information source.

func WithPutService

func WithPutService(p *putsvc.Service) Option

WithPutService returns option to specify put service.

func WithSearchService

func WithSearchService(s *searchsvc.Service) Option

WithSearchService returns option to set search service.

type Prm

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

Prm groups parameters of Delete service call.

func (*Prm) SetCommonParameters

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

SetCommonParameters sets common parameters of the operation.

func (*Prm) WithAddress

func (p *Prm) WithAddress(addr oid.Address)

WithAddress sets address of the object to be removed.

func (*Prm) WithTombstoneAddressTarget

func (p *Prm) WithTombstoneAddressTarget(w TombstoneAddressWriter)

WithTombstoneAddressTarget sets tombstone address destination.

type Service

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

Service utility serving requests of Object.Get service.

func New

func New(opts ...Option) *Service

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

func (*Service) Delete

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

Delete serves requests to remote the objects.

type TombstoneAddressWriter

type TombstoneAddressWriter interface {
	SetAddress(address oid.Address)
}

TombstoneAddressWriter is an interface of tombstone address setter.