entity

Documentation

Index

• type Metadata
  • func New() Metadata
  • func NewAt(now time.Time) Metadata
  • func NewIn(ctx context.Context) Metadata
  • func NewInAt(ctx context.Context, now time.Time) Metadata
  • func (e Metadata) Clone(now time.Time) Metadata
  • func (e Metadata) CloneIn(ctx context.Context, now time.Time) Metadata
  • func (e Metadata) GetID() ids.ID
  • func (e Metadata) GetTenant() string

Types

type Metadata

type Metadata struct {
	ID        ids.ID    `json:"id" bson:"_id"`
	CreatedAt time.Time `json:"createdAt" bson:"createdAt"`
	UpdatedAt time.Time `json:"updatedAt" bson:"updatedAt"`
	Version   int       `json:"version" bson:"version"`
	Tenant    string    `json:"tenant,omitempty" bson:"tenant,omitempty"`
}

Metadata is the metadata for any entity.

func New

func New() Metadata

func NewAt

func NewAt(now time.Time) Metadata

func NewIn

func NewIn(ctx context.Context) Metadata

NewIn creates a new entity with the given context.

func NewInAt

func NewInAt(ctx context.Context, now time.Time) Metadata

NewInAt creates a new entity with the given context and time.

func (Metadata) Clone

func (e Metadata) Clone(now time.Time) Metadata

Clone returns a clone of the entity with a new ID and CreatedAt if necessary. Updates UpdatedAt.

func (Metadata) CloneIn

func (e Metadata) CloneIn(ctx context.Context, now time.Time) Metadata

func (Metadata) GetID

func (e Metadata) GetID() ids.ID

GetID returns the ID of the entity. Implements Identifiable interfaces.

func (Metadata) GetTenant

func (e Metadata) GetTenant() string