output

Documentation

Index

• Variables
• type AddTaskOutput
• type CancelProcessInstanceOutput
• type ExecutionOutput
• type Json
  • func (c *Json) OutputAddTaskResult(taskID string)
  • func (c *Json) OutputCancelledProcessInstance(id string)
  • func (c *Json) OutputExecutionStatus(executionID string, processes map[string][]*model.ProcessHistoryEntry)
  • func (c *Json) OutputListExecution(res []*model.ListExecutionItem)
  • func (c *Json) OutputLoadResult(workflowID string)
  • func (c *Json) OutputServiceTasks(res []*model.TaskSpec)
  • func (c *Json) OutputStartWorkflowResult(executionID string, wfID string)
  • func (c *Json) OutputUserTaskIDs(ut []*model.GetUserTaskResponse)
  • func (c *Json) OutputWorkflow(res []*model.ListWorkflowResponse)
  • func (c *Json) SetCmd(command *cobra.Command)
• type ListExecutionOutput
• type ListServiceTaskOutput
• type LoadWorkflowOutput
• type Method
• type ProcessInstanceOutput
• type ProcessStatusListOutput
• type StartWorkflowResult
• type StateOutput
• type Text
  • func (c *Text) OutputAddTaskResult(taskID string)
  • func (c *Text) OutputCancelledProcessInstance(id string)
  • func (c *Text) OutputExecutionStatus(executionID string, states map[string][]*model.ProcessHistoryEntry)
  • func (c *Text) OutputListExecution(res []*model.ListExecutionItem)
  • func (c *Text) OutputLoadResult(workflowID string)
  • func (c *Text) OutputServiceTasks(res []*model.TaskSpec)
  • func (c *Text) OutputStartWorkflowResult(executionID string, wfID string)
  • func (c *Text) OutputUserTaskIDs(ut []*model.GetUserTaskResponse)
  • func (c *Text) OutputWorkflow(res []*model.ListWorkflowResponse)
  • func (c *Text) SetCmd(command *cobra.Command)
• type UserTaskIDsOutput
• type WorkflowListOutput

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 AddTaskOutput

type AddTaskOutput struct {
	ServiceTaskID string
}

AddTaskOutput is the output format for adding a service task to SHAR.

type CancelProcessInstanceOutput

type CancelProcessInstanceOutput struct {
	Cancelled string
}

CancelProcessInstanceOutput is the output format for cancelling a process.

type ExecutionOutput

type ExecutionOutput struct {
	ExecutionId string
	Process     []ProcessInstanceOutput
}

ExecutionOutput is the output format for an execution.

type Json

type Json struct {
	Cmd *cobra.Command
}

Json contains the output methods for returning json CLI responses

func (*Json) OutputAddTaskResult

func (c *Json) OutputAddTaskResult(taskID string)

OutputAddTaskResult returns a CLI response

func (*Json) OutputCancelledProcessInstance

func (c *Json) OutputCancelledProcessInstance(id string)

OutputCancelledProcessInstance returns a CLI response

func (*Json) OutputExecutionStatus

func (c *Json) OutputExecutionStatus(executionID string, processes map[string][]*model.ProcessHistoryEntry)

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) OutputServiceTasks

func (c *Json) OutputServiceTasks(res []*model.TaskSpec)

OutputServiceTasks 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

func (*Json) SetCmd

func (c *Json) SetCmd(command *cobra.Command)

SetCmd sets the active command on the output processor

type ListExecutionOutput

type ListExecutionOutput struct {
	Execution []*model.ListExecutionItem
}

ListExecutionOutput is the output format for listing executions

type ListServiceTaskOutput

type ListServiceTaskOutput struct {
	Tasks []*model.TaskSpec
}

ListServiceTaskOutput is the output format for listing service tasks.

type LoadWorkflowOutput

type LoadWorkflowOutput struct {
	WorkflowID string
}

LoadWorkflowOutput is the output format for adding a workflow to SHAR.

type Method

type Method interface {
	OutputExecutionStatus(executionID string, states map[string][]*model.ProcessHistoryEntry)
	OutputLoadResult(executionID string)
	OutputListExecution(res []*model.ListExecutionItem)
	OutputCancelledProcessInstance(id string)
	OutputUserTaskIDs(ut []*model.GetUserTaskResponse)
	OutputWorkflow(res []*model.ListWorkflowResponse)
	OutputStartWorkflowResult(wfiID string, wfID string)
	SetCmd(command *cobra.Command)
	OutputAddTaskResult(taskID string)
	OutputServiceTasks(res []*model.TaskSpec)
}

Method represents the output method

var Current Method

Current is the currently selected output method.

type ProcessInstanceOutput

type ProcessInstanceOutput struct {
	ProcessId         string                    `json:"processId,omitempty"`
	ProcessInstanceId string                    `json:"processInstanceId,omitempty"`
	WorkflowName      string                    `json:"workflowName,omitempty"`
	WorkflowId        string                    `json:"workflowId,omitempty"`
	ExecutionId       string                    `json:"executionId,omitempty"`
	State             []ProcessStatusListOutput `json:"state,omitempty"`
}

ProcessInstanceOutput is the output format for displaying processes

type ProcessStatusListOutput

type ProcessStatusListOutput struct {
	ItemType          string   `json:"itemType,omitempty"`
	ElementId         string   `json:"elementId,omitempty"`
	ElementName       string   `json:"elementName,omitempty"`
	CancellationState string   `json:"cancellationState,omitempty"`
	UnixTimeNano      int64    `json:"unixTimeNano,omitempty"`
	Execute           string   `json:"execute,omitempty"`
	Id                []string `json:"id,omitempty"`
	Compensating      bool     `json:"compensating,omitempty"`
	PreviousActivity  string   `json:"previousActivity,omitempty"` // PreviousActivity - the ID of the last activity
	PreviousElement   string   `json:"previousElement,omitempty"`  // PreviousElement - the ID of the last element.
}

ProcessStatusListOutput is the output format for displaying activities and tasks in a process.

type StartWorkflowResult

type StartWorkflowResult struct {
	ExecutionID string
	WorkflowID  string
}

StartWorkflowResult is the output format for starting a workflow.

type StateOutput

type StateOutput struct {
	TrackingId string
	ID         string
	Type       string
	State      string
	Executing  string
	Since      int64
}

StateOutput is the output format for a workflow state.

type Text

type Text struct {
	Cmd *cobra.Command
}

Text provides a client output implementation for console Text provides a client output implementation for console

func (*Text) OutputAddTaskResult

func (c *Text) OutputAddTaskResult(taskID string)

OutputAddTaskResult returns a CLI response

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.ProcessHistoryEntry)

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) OutputServiceTasks

func (c *Text) OutputServiceTasks(res []*model.TaskSpec)

OutputServiceTasks 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

func (*Text) SetCmd

func (c *Text) SetCmd(command *cobra.Command)

SetCmd sets the active command on the output processor

type UserTaskIDsOutput

type UserTaskIDsOutput struct {
	UserTasks []*model.GetUserTaskResponse
}

UserTaskIDsOutput is the output format for listing user tasks.

type WorkflowListOutput

type WorkflowListOutput struct {
	Workflow []*model.ListWorkflowResponse
}

WorkflowListOutput is the output format for workflow list.