task_metadata

Documentation

Index

• Constants
• type BindingContextAccessor
• type HookMetadata
  • func HookMetadataAccessor(t task.Task) (hookMeta HookMetadata)
  • func (m *HookMetadata) AppendBindingContext(context BindingContext) *HookMetadata
  • func (m HookMetadata) GetAllowFailure() bool
  • func (m HookMetadata) GetBinding() BindingType
  • func (m HookMetadata) GetBindingContext() []BindingContext
  • func (m HookMetadata) GetDescription() string
  • func (m HookMetadata) GetHookName() string
  • func (m HookMetadata) GetMonitorIDs() []string
  • func (m HookMetadata) IsSynchronization() bool
  • func (m *HookMetadata) WithAllowFailure(allowFailure bool) *HookMetadata
  • func (m *HookMetadata) WithBinding(binding BindingType) *HookMetadata
  • func (m *HookMetadata) WithBindingContext(context []BindingContext) *HookMetadata
  • func (m *HookMetadata) WithHookName(name string) *HookMetadata
• type HookNameAccessor
• type MonitorIDAccessor

Constants

const (
	// a task to run a particular hook
	HookRun                  task.TaskType = "HookRun"
	EnableKubernetesBindings task.TaskType = "EnableKubernetesBindings"
	EnableScheduleBindings   task.TaskType = "EnableScheduleBindings"
)

Types

type BindingContextAccessor

type BindingContextAccessor interface {
	GetBindingContext() []BindingContext
}

type HookMetadata

type HookMetadata struct {
	HookName       string // hook name
	Binding        string // binding name
	Group          string
	BindingType    BindingType
	BindingContext []BindingContext
	AllowFailure   bool     // Task considered as 'ok' if hook failed. False by default. Can be true for some schedule hooks.
	MonitorIDs     []string // monitor ids for Synchronization tasks

	ExecuteOnSynchronization bool // A flag to skip hook execution in Synchronization tasks.
}

func HookMetadataAccessor

func HookMetadataAccessor(t task.Task) (hookMeta HookMetadata)

func (*HookMetadata) AppendBindingContext

func (m *HookMetadata) AppendBindingContext(context BindingContext) *HookMetadata

func (HookMetadata) GetAllowFailure

func (m HookMetadata) GetAllowFailure() bool

func (HookMetadata) GetBinding

func (m HookMetadata) GetBinding() BindingType

func (HookMetadata) GetBindingContext

func (m HookMetadata) GetBindingContext() []BindingContext

func (HookMetadata) GetDescription

func (m HookMetadata) GetDescription() string

func (HookMetadata) GetHookName

func (m HookMetadata) GetHookName() string

func (HookMetadata) GetMonitorIDs

func (m HookMetadata) GetMonitorIDs() []string

func (HookMetadata) IsSynchronization

func (m HookMetadata) IsSynchronization() bool

func (*HookMetadata) WithAllowFailure

func (m *HookMetadata) WithAllowFailure(allowFailure bool) *HookMetadata

func (*HookMetadata) WithBinding

func (m *HookMetadata) WithBinding(binding BindingType) *HookMetadata

func (*HookMetadata) WithBindingContext

func (m *HookMetadata) WithBindingContext(context []BindingContext) *HookMetadata

func (*HookMetadata) WithHookName

func (m *HookMetadata) WithHookName(name string) *HookMetadata

type HookNameAccessor

type HookNameAccessor interface {
	GetHookName() string
}

type MonitorIDAccessor

type MonitorIDAccessor interface {
	GetMonitorIDs() []string
}