package
0.2.0-alpha
Repository: https://github.com/vmware-archive/dispatch.git
Documentation: pkg.go.dev

# Functions

FilterByApplication creates a filter, which will filter based on the supplied application name.
FilterEverything creates a filter, which will matches all entities.
FilterExists creates a filter, which will filter entities with Delete=true.
FilterStatByApplication defines one filter statement by application name.
GetDataType returns the data type of the given entity.
IsUniqueViolation is a helper function to safely return UniqueViolation if available.
NewFromBackend creates new entity store created from a backend DB.

# Constants

FilterScopeExtra defines that the subject is a extra field extended from BaseEntity.
FilterScopeField defines that the subject is a BaseEntity field.
FilterScopeTag defines that the subject is a BaseEntity Tag.
FilterVerbAfter tests two time.Time.
FilterVerbBefore tests two time.Time.
FilterVerbEqual tests equality.
FilterVerbIn tests containment.
StatusCREATING object is CREATING it is not a guarantee that the object is also created and ready in the underlying driver should wait until the READY state to use the object.
StatusDELETED object is DELETED Note for dispatch team: leave this here, reserved for when we use UUID instead of entity name.
StatusDELETING object is DELETING it is not a guarantee that it has been deleted from the underlying driver user should not reuse the object name until it is transfered to DELETED state.
StatusERROR unexpected error state you should not use the object until the state is tranfered to READY or the object is deleted.
StatusINITIALIZED object is INITIALIZED this status is used by image manager.
StatusMISSING temporary error state Used when external resources cannot be found.
StatusREADY object is READY to be used.
StatusUNKNOWN is not an error, just that the current status is inderminate.
StatusUPDATING object is UPDATING it is not a guarantee that changes will be reflected by the underlying driver when updated, will transfer to READY state.

# Structs

BackendConfig list a set of configuration values for backend DB.
BaseEntity is the base struct for all stored objects.
FilterStat (Filter Statement) defines one filter criterion.
Options defines a set of query options for list and get.

# Interfaces

Entity is the base interface for all stored objects.
EntityStore is a wrapper around libkv and provides convenience methods to serializing and deserializing objects.
Filter defines a set of criteria to filter entities when listing.

# Type aliases

DataType represents the stored struct type.
Reason represents the reason of current status.
Scope describes which scope this filter is applied on.
Spec represents the desired state/status.
Status represents the current state.
Tags are filterable metadata as key pairs.
Verb describe the filter verb.