api

package
v2.44.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 18, 2025 License: MIT Imports: 19 Imported by: 5

Documentation

Index

Constants

View Source
const WorkflowRawHistoryUrl = "/namespaces/:namespace/workflows/:workflow/run/:runid/history.json"

Variables

This section is empty.

Functions

func CreateGRPCConnection added in v2.29.0

func CreateGRPCConnection(cfgProvider *config.ConfigProviderWithRefresh) (*grpc.ClientConn, error)

func GetSettings

func GetSettings(cfgProvider *config.ConfigProviderWithRefresh) func(echo.Context) error

func TemporalAPIHandler

func TemporalAPIHandler(cfgProvider *config.ConfigProviderWithRefresh, apiMiddleware []Middleware, conn *grpc.ClientConn) echo.HandlerFunc

func WorkflowRawHistoryHandler added in v2.36.2

func WorkflowRawHistoryHandler(service IWorkflowService) echo.HandlerFunc

Types

type Auth

type Auth struct {
	Enabled bool
	Options []string
}

type CodecResponse

type CodecResponse struct {
	Endpoint            string
	PassAccessToken     bool
	IncludeCredentials  bool
	DefaultErrorMessage string
	DefaultErrorLink    string
}

type IWorkflowService added in v2.36.2

type IWorkflowService interface {
	GetWorkflowExecutionHistory(
		ctx context.Context,
		in *workflowservice.GetWorkflowExecutionHistoryRequest,
		opts ...grpc.CallOption,
	) (*workflowservice.GetWorkflowExecutionHistoryResponse, error)
}

type Middleware

type Middleware func(c echo.Context) runtime.ServeMuxOption

type RawHistory added in v2.36.2

type RawHistory struct {
	// contains filtered or unexported fields
}

func NewRawHistory added in v2.36.2

func NewRawHistory() *RawHistory

func (*RawHistory) SetContext added in v2.36.2

func (rh *RawHistory) SetContext(c context.Context) *RawHistory

func (*RawHistory) SetIDs added in v2.36.2

func (rh *RawHistory) SetIDs(
	namespace string,
	workflowID string,
	runID string,
) *RawHistory

func (*RawHistory) SetWorkflowService added in v2.36.2

func (rh *RawHistory) SetWorkflowService(service IWorkflowService) *RawHistory

func (*RawHistory) SetWriter added in v2.36.2

func (rh *RawHistory) SetWriter(w http.ResponseWriter) *RawHistory

func (*RawHistory) StreamEvents added in v2.36.2

func (rh *RawHistory) StreamEvents() error

type SettingsResponse

type SettingsResponse struct {
	Auth                          *Auth
	BannerText                    string
	DefaultNamespace              string
	ShowTemporalSystemNamespace   bool
	FeedbackURL                   string
	NotifyOnNewVersion            bool
	Codec                         *CodecResponse
	Version                       string
	DisableWriteActions           bool
	WorkflowTerminateDisabled     bool
	WorkflowCancelDisabled        bool
	WorkflowSignalDisabled        bool
	WorkflowUpdateDisabled        bool
	WorkflowResetDisabled         bool
	BatchActionsDisabled          bool
	StartWorkflowDisabled         bool
	HideWorkflowQueryErrors       bool
	RefreshWorkflowCountsDisabled bool
	ActivityCommandsDisabled      bool
}

Jump to

Keyboard shortcuts

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