apiplugin

Documentation

Index

• type Plugin
  • func NewPlugin(id PluginID, d *PluginSettings, createdAt time.Time, updatedAt *time.Time) (*Plugin, error)
  • func PluginFromProto(pb *pbplugin.Plugin) (*Plugin, error)
  • func (p *Plugin) Clone() *Plugin
  • func (p *Plugin) ID() PluginID
  • func (m *Plugin) MarshalJSON() ([]byte, error)
  • func (p *Plugin) PB() *pbplugin.Plugin
  • func (p *Plugin) Settings() *PluginSettings
  • func (m *Plugin) UnmarshalJSON(bs []byte) error
• type PluginDesc
  • func MustNewPluginDesc(doc string, members []*PluginMemberDesc) *PluginDesc
  • func MustPluginDescFromProto(pb *pbplugin.PluginDesc) *PluginDesc
  • func NewPluginDesc(doc string, members []*PluginMemberDesc) (*PluginDesc, error)
  • func PluginDescFromProto(pb *pbplugin.PluginDesc) (*PluginDesc, error)
  • func (p *PluginDesc) Clone() *PluginDesc
  • func (p *PluginDesc) Doc() string
  • func (m *PluginDesc) MarshalJSON() ([]byte, error)
  • func (p *PluginDesc) PB() *pbplugin.PluginDesc
  • func (m *PluginDesc) UnmarshalJSON(bs []byte) error
• type PluginExecSettings
  • func (x *PluginExecSettings) Clone() *PluginExecSettings
  • func (m *PluginExecSettings) MarshalJSON() ([]byte, error)
  • func (x *PluginExecSettings) PB() *pbplugin.PluginExecutionSettings
  • func (x *PluginExecSettings) Path() string
  • func (p *PluginExecSettings) SetPath(path string) *PluginExecSettings
  • func (m *PluginExecSettings) UnmarshalJSON(bs []byte) error
• type PluginExecSettingsPB
• type PluginID
  • func NewInternalPluginID(n PluginName) PluginID
  • func NewPluginID(a apiaccount.AccountName, n PluginName) PluginID
  • func (id PluginID) AccountName() apiaccount.AccountName
  • func (id PluginID) Empty() bool
  • func (id PluginID) IsInternal() bool
  • func (id *PluginID) MaybeString() string
  • func (id PluginID) PluginName() PluginName
  • func (id PluginID) Split() (apiaccount.AccountName, PluginName)
  • func (id PluginID) String() string
• type PluginMemberDesc
  • func MustNewPluginMemberDesc(name, doc string) *PluginMemberDesc
  • func MustPluginMemberDescFromProto(pb *pbplugin.PluginMemberDesc) *PluginMemberDesc
  • func NewPluginMemberDesc(name, doc string) (*PluginMemberDesc, error)
  • func PluginMemberDescFromProto(pb *pbplugin.PluginMemberDesc) (*PluginMemberDesc, error)
  • func (p *PluginMemberDesc) Clone() *PluginMemberDesc
  • func (p *PluginMemberDesc) Doc() string
  • func (m *PluginMemberDesc) MarshalJSON() ([]byte, error)
  • func (p *PluginMemberDesc) Name() string
  • func (p *PluginMemberDesc) PB() *pbplugin.PluginMemberDesc
  • func (m *PluginMemberDesc) UnmarshalJSON(bs []byte) error
• type PluginName
  • func (n PluginName) String() string
• type PluginPB
• type PluginSettings
  • func MustPluginSettingsFromProto(pb *pbplugin.PluginSettings) *PluginSettings
  • func PluginSettingsFromProto(pb *pbplugin.PluginSettings) (*PluginSettings, error)
  • func (p *PluginSettings) Address() string
  • func (d *PluginSettings) Clone() *PluginSettings
  • func (p *PluginSettings) Enabled() bool
  • func (p *PluginSettings) Exec() *PluginExecSettings
  • func (m *PluginSettings) MarshalJSON() ([]byte, error)
  • func (d *PluginSettings) PB() *pbplugin.PluginSettings
  • func (p *PluginSettings) Port() uint16
  • func (p *PluginSettings) SetAddress(a string) *PluginSettings
  • func (p *PluginSettings) SetEnabled(e bool) *PluginSettings
  • func (p *PluginSettings) SetExec(x *PluginExecSettings) *PluginSettings
  • func (p *PluginSettings) SetPort(port uint16) *PluginSettings
  • func (m *PluginSettings) UnmarshalJSON(bs []byte) error
• type PluginSettingsPB

Types

type Plugin

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

func NewPlugin

func NewPlugin(id PluginID, d *PluginSettings, createdAt time.Time, updatedAt *time.Time) (*Plugin, error)

func PluginFromProto

func PluginFromProto(pb *pbplugin.Plugin) (*Plugin, error)

func (*Plugin) Clone

func (p *Plugin) Clone() *Plugin

func (*Plugin) ID

func (p *Plugin) ID() PluginID

func (*Plugin) MarshalJSON

func (m *Plugin) MarshalJSON() ([]byte, error)

func (*Plugin) PB

func (p *Plugin) PB() *pbplugin.Plugin

func (*Plugin) Settings

func (p *Plugin) Settings() *PluginSettings

func (*Plugin) UnmarshalJSON

func (m *Plugin) UnmarshalJSON(bs []byte) error

type PluginDesc

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

func MustNewPluginDesc

func MustNewPluginDesc(doc string, members []*PluginMemberDesc) *PluginDesc

func MustPluginDescFromProto

func MustPluginDescFromProto(pb *pbplugin.PluginDesc) *PluginDesc

func NewPluginDesc

func NewPluginDesc(doc string, members []*PluginMemberDesc) (*PluginDesc, error)

func PluginDescFromProto

func PluginDescFromProto(pb *pbplugin.PluginDesc) (*PluginDesc, error)

func (*PluginDesc) Clone

func (p *PluginDesc) Clone() *PluginDesc

func (*PluginDesc) Doc

func (p *PluginDesc) Doc() string

func (*PluginDesc) MarshalJSON

func (m *PluginDesc) MarshalJSON() ([]byte, error)

func (*PluginDesc) PB

func (p *PluginDesc) PB() *pbplugin.PluginDesc

func (*PluginDesc) UnmarshalJSON

func (m *PluginDesc) UnmarshalJSON(bs []byte) error

type PluginExecSettings

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

func (*PluginExecSettings) Clone

func (x *PluginExecSettings) Clone() *PluginExecSettings

func (*PluginExecSettings) MarshalJSON

func (m *PluginExecSettings) MarshalJSON() ([]byte, error)

func (*PluginExecSettings) PB

func (x *PluginExecSettings) PB() *pbplugin.PluginExecutionSettings

func (*PluginExecSettings) Path

func (x *PluginExecSettings) Path() string

func (*PluginExecSettings) SetPath

func (p *PluginExecSettings) SetPath(path string) *PluginExecSettings

func (*PluginExecSettings) UnmarshalJSON

func (m *PluginExecSettings) UnmarshalJSON(bs []byte) error

type PluginExecSettingsPB

type PluginExecSettingsPB = pbplugin.PluginExecutionSettings

type PluginID

type PluginID string

func NewInternalPluginID

func NewInternalPluginID(n PluginName) PluginID

func NewPluginID

func NewPluginID(a apiaccount.AccountName, n PluginName) PluginID

func (PluginID) AccountName

func (id PluginID) AccountName() apiaccount.AccountName

func (PluginID) Empty

func (id PluginID) Empty() bool

func (PluginID) IsInternal

func (id PluginID) IsInternal() bool

func (*PluginID) MaybeString

func (id *PluginID) MaybeString() string

func (PluginID) PluginName

func (id PluginID) PluginName() PluginName

func (PluginID) Split

func (id PluginID) Split() (apiaccount.AccountName, PluginName)

func (PluginID) String

func (id PluginID) String() string

type PluginMemberDesc

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

func MustNewPluginMemberDesc

func MustNewPluginMemberDesc(name, doc string) *PluginMemberDesc

func MustPluginMemberDescFromProto

func MustPluginMemberDescFromProto(pb *pbplugin.PluginMemberDesc) *PluginMemberDesc

func NewPluginMemberDesc

func NewPluginMemberDesc(name, doc string) (*PluginMemberDesc, error)

func PluginMemberDescFromProto

func PluginMemberDescFromProto(pb *pbplugin.PluginMemberDesc) (*PluginMemberDesc, error)

func (*PluginMemberDesc) Clone

func (p *PluginMemberDesc) Clone() *PluginMemberDesc

func (*PluginMemberDesc) Doc

func (p *PluginMemberDesc) Doc() string

func (*PluginMemberDesc) MarshalJSON

func (m *PluginMemberDesc) MarshalJSON() ([]byte, error)

func (*PluginMemberDesc) Name

func (p *PluginMemberDesc) Name() string

func (*PluginMemberDesc) PB

func (p *PluginMemberDesc) PB() *pbplugin.PluginMemberDesc

func (*PluginMemberDesc) UnmarshalJSON

func (m *PluginMemberDesc) UnmarshalJSON(bs []byte) error

type PluginName

type PluginName string

func (PluginName) String

func (n PluginName) String() string

type PluginPB

type PluginPB = pbplugin.Plugin

type PluginSettings

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

func MustPluginSettingsFromProto

func MustPluginSettingsFromProto(pb *pbplugin.PluginSettings) *PluginSettings

func PluginSettingsFromProto

func PluginSettingsFromProto(pb *pbplugin.PluginSettings) (*PluginSettings, error)

func (*PluginSettings) Address

func (p *PluginSettings) Address() string

func (*PluginSettings) Clone

func (d *PluginSettings) Clone() *PluginSettings

func (*PluginSettings) Enabled

func (p *PluginSettings) Enabled() bool

func (*PluginSettings) Exec

func (p *PluginSettings) Exec() *PluginExecSettings

func (*PluginSettings) MarshalJSON

func (m *PluginSettings) MarshalJSON() ([]byte, error)

func (*PluginSettings) PB

func (d *PluginSettings) PB() *pbplugin.PluginSettings

func (*PluginSettings) Port

func (p *PluginSettings) Port() uint16

func (*PluginSettings) SetAddress

func (p *PluginSettings) SetAddress(a string) *PluginSettings

func (*PluginSettings) SetEnabled

func (p *PluginSettings) SetEnabled(e bool) *PluginSettings

func (*PluginSettings) SetExec

func (p *PluginSettings) SetExec(x *PluginExecSettings) *PluginSettings

func (*PluginSettings) SetPort

func (p *PluginSettings) SetPort(port uint16) *PluginSettings

func (*PluginSettings) UnmarshalJSON

func (m *PluginSettings) UnmarshalJSON(bs []byte) error

type PluginSettingsPB

type PluginSettingsPB = pbplugin.PluginSettings