resource

Documentation

Overview

Package resource provides a way to interact with resources. This provides multiple interfaces to test against as resources can optionally implement these interfaces.

Index

• type Filter
• type HandleWaitHook
• type LegacyStringer
• type PropertyGetter
• type QueueItemHook
• type Resource
• type SettingsGetter

Types

type Filter

type Filter interface {
	Resource
	Filter() error
}

type HandleWaitHook

type HandleWaitHook interface {
	Resource
	HandleWait(context.Context) error
}

HandleWaitHook is an interface that allows a resource to handle waiting for a resource to be deleted. This is useful for resources that may take a while to delete, typically where the delete operation happens asynchronously from the initial delete command. This allows libnuke to not block during the delete operation.

type LegacyStringer

type LegacyStringer interface {
	Resource
	String() string
}

type PropertyGetter

type PropertyGetter interface {
	Resource
	Properties() types.Properties
}

type QueueItemHook

type QueueItemHook interface {
	Resource
	BeforeEnqueue(interface{})
}

QueueItemHook is an interface that allows a resource to modify the queue item to which it belongs to. For advanced use only, please use with caution!

type Resource

type Resource interface {
	Remove(ctx context.Context) error
}

type SettingsGetter

type SettingsGetter interface {
	Resource
	Settings(setting *settings.Setting)
}