output

Documentation

Index

• Variables
• type Json
  • func (c *Json) OutputCancelledProcessInstance(id string)
  • func (c *Json) OutputExecutionStatus(executionID string, states map[string][]*model.WorkflowState)
  • func (c *Json) OutputListExecution(res []*model.ListExecutionItem)
  • func (c *Json) OutputLoadResult(workflowID string)
  • func (c *Json) OutputStartWorkflowResult(executionID string, wfID string)
  • func (c *Json) OutputUserTaskIDs(ut []*model.GetUserTaskResponse)
  • func (c *Json) OutputWorkflow(res []*model.ListWorkflowResponse)
• type Method
• type Text
  • func (c *Text) OutputCancelledProcessInstance(id string)
  • func (c *Text) OutputExecutionStatus(executionID string, states map[string][]*model.WorkflowState)
  • func (c *Text) OutputListExecution(res []*model.ListExecutionItem)
  • func (c *Text) OutputLoadResult(workflowID string)
  • func (c *Text) OutputStartWorkflowResult(executionID string, wfID string)
  • func (c *Text) OutputUserTaskIDs(ut []*model.GetUserTaskResponse)
  • func (c *Text) OutputWorkflow(res []*model.ListWorkflowResponse)

Variables

var Logger *slog.Logger

Logger is the global logger for the SHAR CLI.

var Stream io.Writer = os.Stdout

Stream contains the output stream. By default this os.Stdout, however, for testing it can be set to a byte buffer for instance.

Types

type Json

type Json struct {
}

Json contains the output methods for returning json CLI responses

func (*Json) OutputCancelledProcessInstance

func (c *Json) OutputCancelledProcessInstance(id string)

OutputCancelledProcessInstance returns a CLI response

func (*Json) OutputExecutionStatus

func (c *Json) OutputExecutionStatus(executionID string, states map[string][]*model.WorkflowState)

OutputExecutionStatus outputs an execution status to console

func (*Json) OutputListExecution

func (c *Json) OutputListExecution(res []*model.ListExecutionItem)

OutputListExecution returns a CLI response

func (*Json) OutputLoadResult

func (c *Json) OutputLoadResult(workflowID string)

OutputLoadResult returns a CLI response

func (*Json) OutputStartWorkflowResult

func (c *Json) OutputStartWorkflowResult(executionID string, wfID string)

OutputStartWorkflowResult returns a CLI response

func (*Json) OutputUserTaskIDs

func (c *Json) OutputUserTaskIDs(ut []*model.GetUserTaskResponse)

OutputUserTaskIDs returns a CLI response

func (*Json) OutputWorkflow

func (c *Json) OutputWorkflow(res []*model.ListWorkflowResponse)

OutputWorkflow returns a CLI response

type Method

type Method interface {
	OutputExecutionStatus(executionID string, states map[string][]*model.WorkflowState)
	OutputLoadResult(executionID string)
	OutputListExecution(res []*model.ListExecutionItem)
	OutputCancelledProcessInstance(id string)
	OutputUserTaskIDs(ut []*model.GetUserTaskResponse)
	OutputWorkflow(res []*model.ListWorkflowResponse)
	OutputStartWorkflowResult(wfiID string, wfID string)
}

Method represents the output method

var Current Method

Current is the currently selected output method.

type Text

type Text struct {
}

Text provides a client output implementation for console

func (*Text) OutputCancelledProcessInstance

func (c *Text) OutputCancelledProcessInstance(id string)

OutputCancelledProcessInstance returns a CLI response

func (*Text) OutputExecutionStatus

func (c *Text) OutputExecutionStatus(executionID string, states map[string][]*model.WorkflowState)

OutputExecutionStatus outputs an execution status

func (*Text) OutputListExecution

func (c *Text) OutputListExecution(res []*model.ListExecutionItem)

OutputListExecution returns a CLI response

func (*Text) OutputLoadResult

func (c *Text) OutputLoadResult(workflowID string)

OutputLoadResult returns a CLI response

func (*Text) OutputStartWorkflowResult

func (c *Text) OutputStartWorkflowResult(executionID string, wfID string)

OutputStartWorkflowResult returns a CLI response

func (*Text) OutputUserTaskIDs

func (c *Text) OutputUserTaskIDs(ut []*model.GetUserTaskResponse)

OutputUserTaskIDs returns a CLI response

func (*Text) OutputWorkflow

func (c *Text) OutputWorkflow(res []*model.ListWorkflowResponse)

OutputWorkflow returns a CLI response