api

Documentation

Index

• Constants
• func NewService(config config.Config, client UnifiedClient, logger log.Logger) *gin.Engine
• type ApiService
  • func NewApiService(config config.Config, client UnifiedClient, taskQueue string, ...) (ApiService, error)
• type DescribeWorkflowExecutionResponse
• type ListWorkflowExecutionsRequest
• type ListWorkflowExecutionsResponse
• type StartWorkflowOptions
• type UnifiedClient

Constants

const WorkflowConfigUpdateApiPath = "/api/v1/workflow/config/update"

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

const WorkflowGetDataObjectsApiPath = "/api/v1/workflow/dataobjects/get"

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

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

const WorkflowInternalDumpApiPath = "/api/v1/workflow/internal/dump"

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

const WorkflowRpcApiPath = "/api/v1/workflow/rpc"

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

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

const WorkflowSkipTimerApiPath = "/api/v1/workflow/timer/skip"

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

const WorkflowStopApiPath = "/api/v1/workflow/stop"

Functions

func NewService

func NewService(config config.Config, client UnifiedClient, logger log.Logger) *gin.Engine

NewService returns a new router.

Types

type ApiService

type ApiService interface {
	ApiV1WorkflowStartPost(ctx context.Context, request iwfidl.WorkflowStartRequest) (*iwfidl.WorkflowStartResponse, *errors.ErrorAndStatus)
	ApiV1WorkflowSignalPost(ctx context.Context, request iwfidl.WorkflowSignalRequest) *errors.ErrorAndStatus
	ApiV1WorkflowStopPost(ctx context.Context, request iwfidl.WorkflowStopRequest) *errors.ErrorAndStatus
	ApiV1WorkflowConfigUpdate(ctx context.Context, request iwfidl.WorkflowConfigUpdateRequest) *errors.ErrorAndStatus
	ApiV1WorkflowGetQueryAttributesPost(ctx context.Context, request iwfidl.WorkflowGetDataObjectsRequest) (*iwfidl.WorkflowGetDataObjectsResponse, *errors.ErrorAndStatus)
	ApiV1WorkflowGetSearchAttributesPost(ctx context.Context, request iwfidl.WorkflowGetSearchAttributesRequest) (*iwfidl.WorkflowGetSearchAttributesResponse, *errors.ErrorAndStatus)
	ApiV1WorkflowGetPost(ctx context.Context, request iwfidl.WorkflowGetRequest) (*iwfidl.WorkflowGetResponse, *errors.ErrorAndStatus)
	ApiV1WorkflowGetWithWaitPost(ctx context.Context, request iwfidl.WorkflowGetRequest) (*iwfidl.WorkflowGetResponse, *errors.ErrorAndStatus)
	ApiV1WorkflowSearchPost(ctx context.Context, request iwfidl.WorkflowSearchRequest) (*iwfidl.WorkflowSearchResponse, *errors.ErrorAndStatus)
	ApiV1WorkflowRpcPost(ctx context.Context, request iwfidl.WorkflowRpcRequest) (*iwfidl.WorkflowRpcResponse, *errors.ErrorAndStatus)
	ApiV1WorkflowResetPost(ctx context.Context, request iwfidl.WorkflowResetRequest) (*iwfidl.WorkflowResetResponse, *errors.ErrorAndStatus)
	ApiV1WorkflowSkipTimerPost(ctx context.Context, request iwfidl.WorkflowSkipTimerRequest) *errors.ErrorAndStatus
	ApiV1WorkflowDumpPost(ctx context.Context, request iwfidl.WorkflowDumpRequest) (*iwfidl.WorkflowDumpResponse, *errors.ErrorAndStatus)
	Close()
}

func NewApiService

func NewApiService(config config.Config, client UnifiedClient, taskQueue string, logger log.Logger) (ApiService, error)

type DescribeWorkflowExecutionResponse

type DescribeWorkflowExecutionResponse struct {
	Status                   iwfidl.WorkflowStatus
	RunId                    string
	SearchAttributes         map[string]iwfidl.SearchAttribute
	Memos                    map[string]iwfidl.EncodedObject
	WorkflowStartedTimestamp int64
}

type ListWorkflowExecutionsRequest

type ListWorkflowExecutionsRequest struct {
	PageSize      int32
	Query         string
	NextPageToken []byte
}

type ListWorkflowExecutionsResponse

type ListWorkflowExecutionsResponse struct {
	Executions    []iwfidl.WorkflowSearchResponseEntry
	NextPageToken []byte
}

type StartWorkflowOptions

type StartWorkflowOptions struct {
	ID                       string
	TaskQueue                string
	WorkflowExecutionTimeout time.Duration
	WorkflowIDReusePolicy    *iwfidl.WorkflowIDReusePolicy
	CronSchedule             *string
	RetryPolicy              *iwfidl.WorkflowRetryPolicy
	SearchAttributes         map[string]interface{}
	Memo                     map[string]interface{}
}

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
	TerminateWorkflow(ctx context.Context, workflowID string, runID string, reason 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 // TODO it doesn't return error correctly... the error is nil when query handler is not implemented
	DescribeWorkflowExecution(ctx context.Context, workflowID, runID string, requestedSearchAttributes []iwfidl.SearchAttributeKeyAndType) (*DescribeWorkflowExecutionResponse, error)
	GetWorkflowResult(ctx context.Context, valuePtr interface{}, workflowID string, runID string) error
	ResetWorkflow(ctx context.Context, request iwfidl.WorkflowResetRequest) (runId string, err error)
	// contains filtered or unexported methods
}