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) OutputDumpExecutionHistory(history []*model.ProcessHistoryEntry)
- func (c *Json) OutputDumpProcessInstance(history []*model.ProcessHistoryEntry)
- 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) OutputServiceTaskUsageReport(res *model.TaskSpecUsageReport)
- 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 ServiceTaskUsageReportOutput
- type StartWorkflowResult
- type StateOutput
- type Text
- func (c *Text) OutputAddTaskResult(taskID string)
- func (c *Text) OutputCancelledProcessInstance(id string)
- func (c *Text) OutputDumpExecutionHistory(history []*model.ProcessHistoryEntry)
- func (c *Text) OutputDumpProcessInstance(history []*model.ProcessHistoryEntry)
- 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) OutputServiceTaskUsageReport(res *model.TaskSpecUsageReport)
- 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
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
Types ¶
type AddTaskOutput ¶ added in v1.1.1331
type AddTaskOutput struct {
ServiceTaskID string
}
AddTaskOutput is the output format for adding a service task to SHAR.
type CancelProcessInstanceOutput ¶ added in v1.1.1331
type CancelProcessInstanceOutput struct {
Cancelled string
}
CancelProcessInstanceOutput is the output format for cancelling a process.
type ExecutionOutput ¶ added in v1.1.1331
type ExecutionOutput struct {
ExecutionId string
Process []ProcessInstanceOutput
}
ExecutionOutput is the output format for an execution.
type Json ¶ added in v1.0.351
Json contains the output methods for returning json CLI responses
func (*Json) OutputAddTaskResult ¶ added in v1.1.1331
OutputAddTaskResult returns a CLI response
func (*Json) OutputCancelledProcessInstance ¶ added in v1.0.645
OutputCancelledProcessInstance returns a CLI response
func (*Json) OutputDumpExecutionHistory ¶ added in v1.1.1772
func (c *Json) OutputDumpExecutionHistory(history []*model.ProcessHistoryEntry)
OutputDumpExecutionHistory outputs an execution's history
func (*Json) OutputDumpProcessInstance ¶ added in v1.1.1772
func (c *Json) OutputDumpProcessInstance(history []*model.ProcessHistoryEntry)
OutputDumpProcessInstance outputs a process instance's history
func (*Json) OutputExecutionStatus ¶ added in v1.0.645
func (c *Json) OutputExecutionStatus(executionID string, processes map[string][]*model.ProcessHistoryEntry)
OutputExecutionStatus outputs an execution status to console
func (*Json) OutputListExecution ¶ added in v1.0.645
func (c *Json) OutputListExecution(res []*model.ListExecutionItem)
OutputListExecution returns a CLI response
func (*Json) OutputLoadResult ¶ added in v1.0.351
OutputLoadResult returns a CLI response
func (*Json) OutputServiceTaskUsageReport ¶ added in v1.1.1744
func (c *Json) OutputServiceTaskUsageReport(res *model.TaskSpecUsageReport)
OutputServiceTaskUsageReport returns a CLI service task usage report response in json format
func (*Json) OutputServiceTasks ¶ added in v1.1.1331
OutputServiceTasks returns a CLI response
func (*Json) OutputStartWorkflowResult ¶ added in v1.0.351
OutputStartWorkflowResult returns a CLI response
func (*Json) OutputUserTaskIDs ¶ added in v1.0.351
func (c *Json) OutputUserTaskIDs(ut []*model.GetUserTaskResponse)
OutputUserTaskIDs returns a CLI response
func (*Json) OutputWorkflow ¶ added in v1.0.351
func (c *Json) OutputWorkflow(res []*model.ListWorkflowResponse)
OutputWorkflow returns a CLI response
type ListExecutionOutput ¶ added in v1.1.1331
type ListExecutionOutput struct {
Execution []*model.ListExecutionItem
}
ListExecutionOutput is the output format for listing executions
type ListServiceTaskOutput ¶ added in v1.1.1331
ListServiceTaskOutput is the output format for listing service tasks.
type LoadWorkflowOutput ¶ added in v1.1.1331
type LoadWorkflowOutput struct {
WorkflowID string
}
LoadWorkflowOutput is the output format for adding a workflow to SHAR.
type Method ¶ added in v1.0.351
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)
OutputServiceTaskUsageReport(res *model.TaskSpecUsageReport)
OutputDumpProcessInstance(history []*model.ProcessHistoryEntry)
OutputDumpExecutionHistory(history []*model.ProcessHistoryEntry)
}
Method represents the output method
var Current Method
Current is the currently selected output method.
type ProcessInstanceOutput ¶ added in v1.1.1349
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 ¶ added in v1.1.1349
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 ServiceTaskUsageReportOutput ¶ added in v1.1.1744
type ServiceTaskUsageReportOutput struct {
UsageReport *model.TaskSpecUsageReport
}
ServiceTaskUsageReportOutput is the output format for service task usage report.
type StartWorkflowResult ¶ added in v1.1.1331
StartWorkflowResult is the output format for starting a workflow.
type StateOutput ¶ added in v1.1.1331
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 ¶ added in v1.0.351
Text provides a client output implementation for console Text provides a client output implementation for console
func (*Text) OutputAddTaskResult ¶ added in v1.1.1331
OutputAddTaskResult returns a CLI response
func (*Text) OutputCancelledProcessInstance ¶ added in v1.0.645
OutputCancelledProcessInstance returns a CLI response
func (*Text) OutputDumpExecutionHistory ¶ added in v1.1.1772
func (c *Text) OutputDumpExecutionHistory(history []*model.ProcessHistoryEntry)
OutputDumpExecutionHistory outputs an execution's history
func (*Text) OutputDumpProcessInstance ¶ added in v1.1.1772
func (c *Text) OutputDumpProcessInstance(history []*model.ProcessHistoryEntry)
OutputDumpProcessInstance outputs a process instance's history
func (*Text) OutputExecutionStatus ¶ added in v1.0.645
func (c *Text) OutputExecutionStatus(executionID string, states map[string][]*model.ProcessHistoryEntry)
OutputExecutionStatus outputs an execution status
func (*Text) OutputListExecution ¶ added in v1.0.645
func (c *Text) OutputListExecution(res []*model.ListExecutionItem)
OutputListExecution returns a CLI response
func (*Text) OutputLoadResult ¶ added in v1.0.351
OutputLoadResult returns a CLI response
func (*Text) OutputServiceTaskUsageReport ¶ added in v1.1.1744
func (c *Text) OutputServiceTaskUsageReport(res *model.TaskSpecUsageReport)
OutputServiceTaskUsageReport formats a CLI service task usage report response as plain text
func (*Text) OutputServiceTasks ¶ added in v1.1.1331
OutputServiceTasks returns a CLI response
func (*Text) OutputStartWorkflowResult ¶ added in v1.0.351
OutputStartWorkflowResult returns a CLI response
func (*Text) OutputUserTaskIDs ¶ added in v1.0.351
func (c *Text) OutputUserTaskIDs(ut []*model.GetUserTaskResponse)
OutputUserTaskIDs returns a CLI response
func (*Text) OutputWorkflow ¶ added in v1.0.351
func (c *Text) OutputWorkflow(res []*model.ListWorkflowResponse)
OutputWorkflow returns a CLI response
type UserTaskIDsOutput ¶ added in v1.1.1331
type UserTaskIDsOutput struct {
UserTasks []*model.GetUserTaskResponse
}
UserTaskIDsOutput is the output format for listing user tasks.
type WorkflowListOutput ¶ added in v1.1.1331
type WorkflowListOutput struct {
Workflow []*model.ListWorkflowResponse
}
WorkflowListOutput is the output format for workflow list.