resources

package
v1.1.0 Latest Latest
Warning

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

Go to latest
Published: Apr 27, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ConfigParams

func ConfigParams() []configparam.ConfigParam

ConfigParams function returns the configuration parameters of all registered resource kinds.

func ExportFn

func ExportFn(kind string) func(context.Context, *client.Client, export.EventHandler, bool) error

ExportFn returns the export function of a given kind.

func KindNames

func KindNames() []string

KindNames function returns the names of the registered kinds.

func RegisterKind

func RegisterKind(kind Kind)

RegisterKind function registers a resource kind.

Types

type Kind

type Kind interface {
	KindName() string
	// Param method returns the configuration parameters specific
	// to a resource kind.
	Param() configparam.ConfigParam
	// Export method performs the export operation of a resource
	// kind. The method first identifies the resources that are to
	// be exportd using the values of the related configuration
	// parameters. Then it collects the resource definitions
	// through the cfClient. Finally, the resources are exported
	// using the eventHandler.
	Export(ctx context.Context, cfClient *client.Client, evHandler export.EventHandler, resolveReferences bool) error
}

Kind interface must be implemented by each CF resource kinds.

Jump to

Keyboard shortcuts

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