api

Documentation

Index

• type Client
  • func NewClient(endpoint, authToken string) Client
  • func (c *Client) Diff(ctx context.Context, input TargetOperationInput) (responses.Diff, error)
  • func (c *Client) Exec(ctx context.Context, input TargetOperationInput) (responses.Exec, error)
  • func (c *Client) ExecuteWorkflow(ctx context.Context, input requests.CreateWorkflow) (responses.ExecuteWorkflow, error)
  • func (c *Client) GetLogs(ctx context.Context, workflowName string) (responses.GetLogs, error)
  • func (c *Client) GetWorkflowStatus(ctx context.Context, workflowName string) (responses.GetWorkflowStatus, error)
  • func (c *Client) GetWorkflows(ctx context.Context, project, target string) (responses.GetWorkflows, error)
  • func (c *Client) StreamLogs(ctx context.Context, w io.Writer, workflowName string) error
  • func (c *Client) Sync(ctx context.Context, input TargetOperationInput) (responses.Sync, error)
• type TargetOperationInput

Types

type Client

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

Client represents an API client.

func NewClient

func NewClient(endpoint, authToken string) Client

NewClient returns a new API client.

func (*Client) Diff

func (c *Client) Diff(ctx context.Context, input TargetOperationInput) (responses.Diff, error)

Diff submits a "diff" for the provided project target.

func (*Client) Exec

func (c *Client) Exec(ctx context.Context, input TargetOperationInput) (responses.Exec, error)

Exec submits an "exec" for the provided project target.

func (*Client) ExecuteWorkflow

func (c *Client) ExecuteWorkflow(ctx context.Context, input requests.CreateWorkflow) (responses.ExecuteWorkflow, error)

ExecuteWorkflow submits a workflow execution request.

func (*Client) GetLogs

func (c *Client) GetLogs(ctx context.Context, workflowName string) (responses.GetLogs, error)

GetLogs gets the logs of a workflow.

func (*Client) GetWorkflowStatus

func (c *Client) GetWorkflowStatus(ctx context.Context, workflowName string) (responses.GetWorkflowStatus, error)

GetWorkflowStatus gets the status of a workflow.

func (*Client) GetWorkflows

func (c *Client) GetWorkflows(ctx context.Context, project, target string) (responses.GetWorkflows, error)

GetWorkflows gets the list of workflows for a project and target.

func (*Client) StreamLogs

func (c *Client) StreamLogs(ctx context.Context, w io.Writer, workflowName string) error

StreamLogs streams the logs of a workflow starting after loggedBytes.

func (*Client) Sync

func (c *Client) Sync(ctx context.Context, input TargetOperationInput) (responses.Sync, error)

Sync submits a "sync" for the provided project target.

type TargetOperationInput

type TargetOperationInput struct {
	Path        string
	ProjectName string
	SHA         string
	TargetName  string
}

TargetOperationInput represents the input to a targetOperation.