api

Documentation

Index

• Constants
• func NewService(client UnifiedClient) *gin.Engine
• type ApiService
  • func NewApiService(client UnifiedClient) (ApiService, error)
• type DescribeWorkflowExecutionResponse
• type ErrorAndStatus
• type ListWorkflowExecutionsRequest
• type ListWorkflowExecutionsResponse
• type StartWorkflowOptions
• type UnifiedClient

Constants

const WorkflowCancelApiPath = "/api/v1/workflow/cancel"

const WorkflowGetApiPath = "/api/v1/workflow/get"

const WorkflowGetQueryAttributesApiPath = "/api/v1/workflow/queryattributes/get"

const WorkflowGetSearchAttributesApiPath = "/api/v1/workflow/searchattributes/get"

const WorkflowGetWithWaitApiPath = "/api/v1/workflow/getWithWait"

const WorkflowResetApiPath = "/api/v1/workflow/reset"

const WorkflowSearchApiPath = "/api/v1/workflow/search"

const WorkflowSignalApiPath = "/api/v1/workflow/signal"

const WorkflowStartApiPath = "/api/v1/workflow/start"

Functions

func NewService

func NewService(client UnifiedClient) *gin.Engine

NewService returns a new router.

Types

type ApiService

type ApiService interface {
	ApiV1WorkflowStartPost(request iwfidl.WorkflowStartRequest) (*iwfidl.WorkflowStartResponse, *ErrorAndStatus)
	ApiV1WorkflowSignalPost(request iwfidl.WorkflowSignalRequest) *ErrorAndStatus
	ApiV1WorkflowCancelPost(request iwfidl.WorkflowCancelRequest) *ErrorAndStatus
	ApiV1WorkflowGetQueryAttributesPost(request iwfidl.WorkflowGetQueryAttributesRequest) (*iwfidl.WorkflowGetQueryAttributesResponse, *ErrorAndStatus)
	ApiV1WorkflowGetSearchAttributesPost(request iwfidl.WorkflowGetSearchAttributesRequest) (*iwfidl.WorkflowGetSearchAttributesResponse, *ErrorAndStatus)
	ApiV1WorkflowGetPost(request iwfidl.WorkflowGetRequest) (*iwfidl.WorkflowGetResponse, *ErrorAndStatus)
	ApiV1WorkflowGetWithWaitPost(request iwfidl.WorkflowGetRequest) (*iwfidl.WorkflowGetResponse, *ErrorAndStatus)
	ApiV1WorkflowSearchPost(request iwfidl.WorkflowSearchRequest) (*iwfidl.WorkflowSearchResponse, *ErrorAndStatus)
	ApiV1WorkflowResetPost(request iwfidl.WorkflowResetRequest) (*iwfidl.WorkflowResetResponse, *ErrorAndStatus)
	Close()
}

func NewApiService

func NewApiService(client UnifiedClient) (ApiService, error)

type DescribeWorkflowExecutionResponse

type DescribeWorkflowExecutionResponse struct {
	Status           string
	RunId            string
	SearchAttributes map[string]iwfidl.SearchAttribute
}

type ErrorAndStatus

type ErrorAndStatus struct {
	StatusCode int
	Error      iwfidl.ErrorResponse
}

type ListWorkflowExecutionsRequest

type ListWorkflowExecutionsRequest struct {
	PageSize int32
	Query    string
}

type ListWorkflowExecutionsResponse

type ListWorkflowExecutionsResponse struct {
	Executions []iwfidl.WorkflowSearchResponseEntry
}

type StartWorkflowOptions

type StartWorkflowOptions struct {
	ID                 string
	TaskQueue          string
	WorkflowRunTimeout time.Duration
}

type UnifiedClient

type UnifiedClient interface {
	Close()
	StartInterpreterWorkflow(ctx context.Context, options StartWorkflowOptions, args ...interface{}) (runId string, err error)
	SignalWorkflow(ctx context.Context, workflowID string, runID string, signalName string, arg interface{}) error
	CancelWorkflow(ctx context.Context, workflowID string, runID string) error
	ListWorkflow(ctx context.Context, request *ListWorkflowExecutionsRequest) (*ListWorkflowExecutionsResponse, error)
	QueryWorkflow(ctx context.Context, valuePtr interface{}, workflowID string, runID string, queryType string, args ...interface{}) error
	DescribeWorkflowExecution(ctx context.Context, workflowID, runID string) (*DescribeWorkflowExecutionResponse, error)
	GetWorkflowResult(ctx context.Context, valuePtr interface{}, workflowID string, runID string) error
	ResetWorkflow(ctx context.Context, request iwfidl.WorkflowResetRequest) (runId string, err error)
}