payloadshookcontext

Documentation

Index

• func Register(registry facade.FacadeRegistry)
• type UnitFacadeV1
  • func NewHookContextFacadeV1() (*UnitFacadeV1, error)
  • func NewUnitFacadeV1() *UnitFacadeV1
  • func (uf UnitFacadeV1) List(ctx context.Context, args params.Entities) (params.PayloadResults, error)
  • func (uf UnitFacadeV1) LookUp(ctx context.Context, args params.LookUpPayloadArgs) (params.PayloadResults, error)
  • func (uf UnitFacadeV1) SetStatus(ctx context.Context, args params.SetPayloadStatusArgs) (params.PayloadResults, error)
  • func (uf UnitFacadeV1) Track(ctx context.Context, args params.TrackPayloadArgs) (params.PayloadResults, error)
  • func (uf UnitFacadeV1) Untrack(ctx context.Context, args params.Entities) (params.PayloadResults, error)
• type UnitFacadeV2
  • func NewHookContextFacadeV2() (*UnitFacadeV2, error)
  • func NewUnitFacadeV2() *UnitFacadeV2

Functions

func Register

func Register(registry facade.FacadeRegistry)

Register is called to expose a package of facades onto a given registry.

Types

type UnitFacadeV1

type UnitFacadeV1 struct{}

UnitFacadeV1 serves payload-specific API methods.

func NewHookContextFacadeV1

func NewHookContextFacadeV1() (*UnitFacadeV1, error)

NewHookContextFacadeV1 returns a new payloads hook context facade for the State and Unit given. It is used for facade registration.

func NewUnitFacadeV1

func NewUnitFacadeV1() *UnitFacadeV1

NewUnitFacadeV1 builds a new facade for the given backend.

func (UnitFacadeV1) List

func (uf UnitFacadeV1) List(ctx context.Context, args params.Entities) (params.PayloadResults, error)

List builds the list of payload being tracked for the given unit and IDs. If no IDs are provided then all tracked payloads for the unit are returned.

func (UnitFacadeV1) LookUp

func (uf UnitFacadeV1) LookUp(ctx context.Context, args params.LookUpPayloadArgs) (params.PayloadResults, error)

LookUp identifies the payload with the provided name and raw ID.

func (UnitFacadeV1) SetStatus

func (uf UnitFacadeV1) SetStatus(ctx context.Context, args params.SetPayloadStatusArgs) (params.PayloadResults, error)

SetStatus sets the raw status of a payload.

func (UnitFacadeV1) Track

func (uf UnitFacadeV1) Track(ctx context.Context, args params.TrackPayloadArgs) (params.PayloadResults, error)

Track stores a payload to be tracked in state.

func (UnitFacadeV1) Untrack

func (uf UnitFacadeV1) Untrack(ctx context.Context, args params.Entities) (params.PayloadResults, error)

Untrack marks the identified payload as no longer being tracked.

type UnitFacadeV2

type UnitFacadeV2 struct{}

UnitFacadeV2 serves payload-specific API methods.

func NewHookContextFacadeV2

func NewHookContextFacadeV2() (*UnitFacadeV2, error)

NewHookContextFacadeV2 returns a new payloads hook context facade for the State and Unit given. It is used for facade registration.

func NewUnitFacadeV2

func NewUnitFacadeV2() *UnitFacadeV2

NewUnitFacadeV2 builds a new facade for the given backend.