statestore

Documentation

Index

• type Service
  • func New(cfg config.View) Service

Types

type Service

type Service interface {
	// HealthCheck indicates if the database is reachable.
	HealthCheck(ctx context.Context) error

	// CreateTicket creates a new Ticket in the state storage. This method fails if the Ticket already exists.
	CreateTicket(ctx context.Context, ticket *pb.Ticket) error

	// GetTicket gets the Ticket with the specified id from state storage. This method fails if the Ticket does not exist.
	GetTicket(ctx context.Context, id string) (*pb.Ticket, error)

	// DeleteTicket removes the Ticket with the specified id from state storage. This method succeeds if the Ticket does not exist.
	DeleteTicket(ctx context.Context, id string) error

	// IndexTicket indexes the Ticket id for the configured index fields.
	IndexTicket(ctx context.Context, ticket *pb.Ticket) error

	// DeindexTicket removes the indexing for the specified Ticket. Only the indexes are removed but the Ticket continues to exist.
	DeindexTicket(ctx context.Context, id string) error

	// FilterTickets returns the Ticket ids for the Tickets meeting the specified filtering criteria.
	FilterTickets(ctx context.Context, filters []*pb.Filter, pageSize int, callback func([]*pb.Ticket) error) error

	// UpdateAssignments update the match assignments for the input ticket ids
	UpdateAssignments(ctx context.Context, ids []string, assignment *pb.Assignment) error

	// GetAssignments returns the assignment associated with the input ticket id
	GetAssignments(ctx context.Context, id string, callback func(*pb.Assignment) error) error

	// AddProposedTickets appends new proposed tickets to the proposed sorted set with current timestamp
	AddTicketsToIgnoreList(ctx context.Context, ids []string) error

	// Closes the connection to the underlying storage.
	Close() error
}

Service is a generic interface for talking to a storage backend.

func New

func New(cfg config.View) Service

New creates a Service based on the configuration.