bookkeeping

Documentation

Index

• Constants
• func NewPlugin(endpoint string) integration.Plugin
• type Plugin
  • func (p *Plugin) CallStack(data interface{}) (stack map[string]interface{})
  • func (p *Plugin) Destroy() error
  • func (p *Plugin) GetConnectionState() string
  • func (p *Plugin) GetData(_ []any) string
  • func (p *Plugin) GetEndpoint() string
  • func (p *Plugin) GetEnvironmentsData(envIds []uid.ID) map[uid.ID]string
  • func (p *Plugin) GetName() string
  • func (p *Plugin) GetPrettyName() string
  • func (p *Plugin) Init(instanceId string) error
  • func (p *Plugin) ObjectStack(_ map[string]string, _ map[string]string) (stack map[string]interface{})
• type RpcClient
  • func NewClient(cxt context.Context, cancel context.CancelFunc, endpoint string) *RpcClient
  • func (m *RpcClient) Close() error
  • func (m *RpcClient) GetConnState() connectivity.State

Constants

const (
	BKP_RUN_TIMEOUT  = 30 * time.Second
	BKP_ENV_TIMEOUT  = 30 * time.Second
	BKP_FILL_TIMEOUT = 30 * time.Second
)

Functions

func NewPlugin

func NewPlugin(endpoint string) integration.Plugin

******************************************** Plugin and inherited methods Instanciation // ********************************************

Types

type Plugin

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

func (*Plugin) CallStack

func (p *Plugin) CallStack(data interface{}) (stack map[string]interface{})

CallStack method, which adds functions to the call stack that can then be called under certain conditions via hooks and triggers in the readout-dataflow workflow

func (*Plugin) Destroy

func (p *Plugin) Destroy() error

func (*Plugin) GetConnectionState

func (p *Plugin) GetConnectionState() string

func (*Plugin) GetData

func (p *Plugin) GetData(_ []any) string

Make plugin-specific data across all instances available per data field

func (*Plugin) GetEndpoint

func (p *Plugin) GetEndpoint() string

func (*Plugin) GetEnvironmentsData

func (p *Plugin) GetEnvironmentsData(envIds []uid.ID) map[uid.ID]string

Make plugin-specific data across all instances available per environment

func (*Plugin) GetName

func (p *Plugin) GetName() string

func (*Plugin) GetPrettyName

func (p *Plugin) GetPrettyName() string

func (*Plugin) Init

func (p *Plugin) Init(instanceId string) error

*********************************** Initialize the Bookkeeping client // ***********************************

func (*Plugin) ObjectStack

func (p *Plugin) ObjectStack(_ map[string]string, _ map[string]string) (stack map[string]interface{})

ObjectStack method

type RpcClient

type RpcClient struct {
	bkpb.EnvironmentServiceClient
	bkpb.FlpServiceClient
	bkpb.LogServiceClient
	bkpb.RunServiceClient
	bkpb.LhcFillServiceClient
	// contains filtered or unexported fields
}

func NewClient

func NewClient(cxt context.Context, cancel context.CancelFunc, endpoint string) *RpcClient

func (*RpcClient) Close

func (m *RpcClient) Close() error

func (*RpcClient) GetConnState

func (m *RpcClient) GetConnState() connectivity.State