datagatherer

package
v1.9.0-alpha.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 3, 2026 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Overview

Package datagatherer provides the DataGatherer interface.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Config

type Config interface {
	// NewDataGatherer constructs a DataGatherer with an specific configuration.
	NewDataGatherer(ctx context.Context) (DataGatherer, error)
}

Config is the configuration of a DataGatherer.

type DataGatherer

type DataGatherer interface {
	// Fetch retrieves data.
	// count is the number of items that were discovered. A negative count means the number
	// of items was indeterminate.
	Fetch() (data any, count int, err error)
	// Run starts the data gatherer's informers for resource collection.
	// Returns error if the data gatherer informer wasn't initialized
	Run(ctx context.Context) error
	// WaitForCacheSync waits for the data gatherer's informers cache to sync.
	WaitForCacheSync(ctx context.Context) error
}

DataGatherer is the interface for Data Gatherers. Data Gatherers are in charge of fetching data from a certain cloud provider API or Kubernetes component.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL