client

Documentation

Index

• Constants
• func IsPluginError(err error) bool
• func ValidateHandshake(h *plugin_go.Handshake) error
• type Client
  • func NewClient(log logger.Logger, name string, cmd *exec.Cmd, props map[string]interface{}, ...) (*Client, error)
  • func (c *Client) Apply(ctx context.Context, state *types.StateData, apps []*types.AppPlan, ...) (ret *plugin_go.ApplyDoneResponse, err error)
  • func (c *Client) GetState(ctx context.Context, typ string, props map[string]interface{}, lock bool, ...) (ret *plugin_go.GetStateResponse, err error)
  • func (c *Client) Plan(ctx context.Context, state *types.StateData, apps []*types.AppPlan, ...) (ret *plugin_go.PlanResponse, err error)
  • func (c *Client) ProjectInit(ctx context.Context, name string, deployPlugins, runPlugins []string, ...) (*plugin_go.ProjectInitResponse, error)
  • func (c *Client) ReleaseLock(ctx context.Context, typ string, props map[string]interface{}, lockID string) error
  • func (c *Client) Run(ctx context.Context, req *plugin_go.RunRequest, ...) (ret *plugin_go.RunningResponse, err error)
  • func (c *Client) SaveState(ctx context.Context, state *types.StateData, typ string, ...) (ret *plugin_go.SaveStateResponse, err error)
  • func (c *Client) Start(ctx context.Context) error
  • func (c *Client) Stop() error
• type PluginError
  • func NewPluginError(c *Client, msg string, wrapped error) *PluginError
  • func (e *PluginError) Error() string
  • func (e *PluginError) Unwrap() error
• type ResponseWithHeader
• type SenderStream
  • func NewSenderStream(log logger.Logger, c net.Conn) *SenderStream
  • func (s *SenderStream) Close() error
  • func (s *SenderStream) DrainAndClose() error
  • func (s *SenderStream) Recv() (plugin_go.Response, error)
  • func (s *SenderStream) Send(req plugin_go.Request) error
• type YAMLContext
  • func (c *YAMLContext) Error(r *plugin_go.ValidationErrorResponse) error

Constants

const (
	DefaultTimeout = 10 * time.Second
)

Functions

func IsPluginError

func IsPluginError(err error) bool

func ValidateHandshake

func ValidateHandshake(h *plugin_go.Handshake) error

Types

type Client

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

func NewClient

func NewClient(log logger.Logger, name string, cmd *exec.Cmd, props map[string]interface{}, yamlContext YAMLContext) (*Client, error)

func (*Client) Apply

func (c *Client) Apply(ctx context.Context, state *types.StateData, apps []*types.AppPlan, deps []*types.DependencyPlan, targetApps, skipApps []string, args map[string]interface{}, destroy bool, callback func(*types.ApplyAction)) (ret *plugin_go.ApplyDoneResponse, err error)

func (*Client) GetState

func (c *Client) GetState(ctx context.Context, typ string, props map[string]interface{}, lock bool, yamlContext YAMLContext) (ret *plugin_go.GetStateResponse, err error)

func (*Client) Plan

func (c *Client) Plan(ctx context.Context, state *types.StateData, apps []*types.AppPlan, deps []*types.DependencyPlan, targetApps, skipApps []string, args map[string]interface{}, verify, destroy bool) (ret *plugin_go.PlanResponse, err error)

func (*Client) ProjectInit

func (c *Client) ProjectInit(ctx context.Context, name string, deployPlugins, runPlugins []string, args map[string]interface{}) (*plugin_go.ProjectInitResponse, error)

func (*Client) ReleaseLock

func (c *Client) ReleaseLock(ctx context.Context, typ string, props map[string]interface{}, lockID string) error

func (*Client) Run

func (c *Client) Run(ctx context.Context, req *plugin_go.RunRequest,
	outCh chan<- *plugin_go.RunOutputResponse, errCh chan<- error) (ret *plugin_go.RunningResponse, err error)

func (*Client) SaveState

func (c *Client) SaveState(ctx context.Context, state *types.StateData, typ string, props map[string]interface{}) (ret *plugin_go.SaveStateResponse, err error)

func (*Client) Start

func (c *Client) Start(ctx context.Context) error

func (*Client) Stop

func (c *Client) Stop() error

type PluginError

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

func NewPluginError

func NewPluginError(c *Client, msg string, wrapped error) *PluginError

func (*PluginError) Error

func (e *PluginError) Error() string

func (*PluginError) Unwrap

func (e *PluginError) Unwrap() error

type ResponseWithHeader

type ResponseWithHeader struct {
	Header   plugin_go.ResponseHeader
	Response plugin_go.Response
}

type SenderStream

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

func NewSenderStream

func NewSenderStream(log logger.Logger, c net.Conn) *SenderStream

func (*SenderStream) Close

func (s *SenderStream) Close() error

func (*SenderStream) DrainAndClose

func (s *SenderStream) DrainAndClose() error

func (*SenderStream) Recv

func (s *SenderStream) Recv() (plugin_go.Response, error)

func (*SenderStream) Send

func (s *SenderStream) Send(req plugin_go.Request) error

type YAMLContext

type YAMLContext struct {
	Prefix string
	Data   []byte
}

func (*YAMLContext) Error

func (c *YAMLContext) Error(r *plugin_go.ValidationErrorResponse) error