api

package

v1.19.3 Latest Latest Go to latest Published: Jan 9, 2026 License: MIT Imports: 23 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/indeedeng/iwf

Links

Documentation ¶

Index ¶

Constants
func NewService(config config.Config, client uclient.UnifiedClient, logger log.Logger, ...) *gin.Engine
type ApiService
- func NewApiService(cfg config.Config, client uclient.UnifiedClient, taskQueue string, ...) (ApiService, error)

Constants ¶

View Source

const InfoHealthCheck = "/info/healthcheck"

View Source

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

View Source

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

View Source

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

View Source

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

View Source

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

View Source

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

View Source

const WorkflowPublishToInternalChannelApiPath = "/api/v1/workflow/publishToInternalChannel"

View Source

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

View Source

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

View Source

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

View Source

const WorkflowSetDataAttributesApiPath = "/api/v1/workflow/dataobjects/set"

View Source

const WorkflowSetSearchAttributesApiPath = "/api/v1/workflow/searchattributes/set"

View Source

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

View Source

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

View Source

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

View Source

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

View Source

const WorkflowTriggerContinueAsNewApiPath = "/api/v1/workflow/triggerContinueAsNew"

View Source

const WorkflowWaitForStateCompletionApiPath = "/api/v1/workflow/waitForStateCompletion"

Variables ¶

This section is empty.

Functions ¶

func NewService ¶

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

NewService returns a new router.

Types ¶

type ApiService ¶

type ApiService interface {
	ApiV1WorkflowStartPost(
		ctx context.Context, request iwfidl.WorkflowStartRequest,
	) (*iwfidl.WorkflowStartResponse, *errors.ErrorAndStatus)
	ApiV1WorkflowWaitForStateCompletion(
		ctx context.Context, request iwfidl.WorkflowWaitForStateCompletionRequest,
	) (*iwfidl.WorkflowWaitForStateCompletionResponse, *errors.ErrorAndStatus)
	ApiV1WorkflowSignalPost(ctx context.Context, request iwfidl.WorkflowSignalRequest) *errors.ErrorAndStatus
	ApiV1WorkflowPublishToInternalChannelPost(ctx context.Context, request iwfidl.PublishToInternalChannelRequest) *errors.ErrorAndStatus
	ApiV1WorkflowStopPost(ctx context.Context, request iwfidl.WorkflowStopRequest) *errors.ErrorAndStatus
	ApiV1WorkflowConfigUpdate(ctx context.Context, request iwfidl.WorkflowConfigUpdateRequest) *errors.ErrorAndStatus
	ApiV1WorkflowTriggerContinueAsNew(
		ctx context.Context, req iwfidl.TriggerContinueAsNewRequest,
	) (retError *errors.ErrorAndStatus)
	ApiV1WorkflowGetQueryAttributesPost(
		ctx context.Context, request iwfidl.WorkflowGetDataObjectsRequest,
	) (*iwfidl.WorkflowGetDataObjectsResponse, *errors.ErrorAndStatus)
	ApiV1WorkflowSetQueryAttributesPost(
		ctx context.Context, request iwfidl.WorkflowSetDataObjectsRequest) *errors.ErrorAndStatus
	ApiV1WorkflowGetSearchAttributesPost(
		ctx context.Context, request iwfidl.WorkflowGetSearchAttributesRequest,
	) (*iwfidl.WorkflowGetSearchAttributesResponse, *errors.ErrorAndStatus)
	ApiV1WorkflowSetSearchAttributesPost(
		ctx context.Context, request iwfidl.WorkflowSetSearchAttributesRequest) *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)
	ApiInfoHealth(ctx context.Context) *iwfidl.HealthInfo
	Close()
}

func NewApiService ¶

func NewApiService(
	cfg config.Config, client uclient.UnifiedClient, taskQueue string, logger log.Logger, store blobstore.BlobStore,
) (ApiService, error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL