bundle

Documentation

Index

• type BaseBundleMetadata
  • func NewBaseBundleMetadata() *BaseBundleMetadata
  • func (metadata *BaseBundleMetadata) MarkAsProcessed()
  • func (metadata *BaseBundleMetadata) Processed() bool
• type BundleMetadata
• type BundleSyncMode
• type GenericBundle
  • func NewGenericBundle() *GenericBundle
• type GetBundlesMetadataFunc

Types

type BaseBundleMetadata

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

BaseBundleMetadata wraps the shared data/functionality that the different transport BundleMetadata implementations- can be based on.

func NewBaseBundleMetadata

func NewBaseBundleMetadata() *BaseBundleMetadata

NewBaseBundleMetadata returns a new instance of BaseBundleMetadata.

func (*BaseBundleMetadata) MarkAsProcessed

func (metadata *BaseBundleMetadata) MarkAsProcessed()

MarkAsProcessed function that marks the metadata as processed.

func (*BaseBundleMetadata) Processed

func (metadata *BaseBundleMetadata) Processed() bool

Processed returns whether the bundle was processed or not.

type BundleMetadata

type BundleMetadata interface {
	// MarkAsProcessed function that marks the metadata as processed.
	MarkAsProcessed()
	// Processed returns whether the bundle was processed or not.
	Processed() bool
}

BundleMetadata may include metadata that relates to transport - e.g. commit offset.

type BundleSyncMode

type BundleSyncMode int8

BundleSyncMode used to identify hybrid sync mode - complete/delta bundles.

const (
	// CompleteStateMode used to identify sync mode of complete state bundles.
	CompleteStateMode BundleSyncMode = iota
	// DeltaStateMode used to identify sync mode of delta state bundles.
	DeltaStateMode BundleSyncMode = iota
)

type GenericBundle

type GenericBundle struct {
	Objects        []*unstructured.Unstructured `json:"objects"`
	DeletedObjects []*unstructured.Unstructured `json:"deletedObjects"`
}

GenericBundle bundle received from transport containing Objects/DeletedObjects.

func NewGenericBundle

func NewGenericBundle() *GenericBundle

NewGenericBundle returns a new instance of GenericBundle.

type GetBundlesMetadataFunc

type GetBundlesMetadataFunc func() []BundleMetadata

GetBundlesMetadataFunc is the function to be called by committer to fetch metadata to commit.