Documentation
¶
Index ¶
- Constants
- func CreateGRPCConnection(cfgProvider *config.ConfigProviderWithRefresh) (*grpc.ClientConn, error)
- func GetLatestReleases(cfgProvider *config.ConfigProviderWithRefresh, checker *ReleaseChecker) func(echo.Context) error
- func GetSettings(cfgProvider *config.ConfigProviderWithRefresh) func(echo.Context) error
- func GetUIExtensions(cfgProvider *config.ConfigProviderWithRefresh, accessCheck AccessCheck) func(echo.Context) error
- func ReleaseForDistribution(distribution string) string
- func TemporalAPIHandler(cfgProvider *config.ConfigProviderWithRefresh, apiMiddleware []Middleware, ...) echo.HandlerFunc
- func WorkflowRawHistoryHandler(service IWorkflowService) echo.HandlerFunc
- type AccessCheck
- type Auth
- type BannerResponse
- type CodecResponse
- type CustomUIResponse
- type CustomUISettingsResponse
- type IWorkflowService
- type IframeExtensionResponse
- type IframeExtensionSizingResponse
- type IframeSandboxResponse
- type LatestReleasesResponse
- type Middleware
- type RawHistory
- func (rh *RawHistory) SetContext(c context.Context) *RawHistory
- func (rh *RawHistory) SetIDs(namespace string, workflowID string, runID string) *RawHistory
- func (rh *RawHistory) SetWorkflowService(service IWorkflowService) *RawHistory
- func (rh *RawHistory) SetWriter(w http.ResponseWriter) *RawHistory
- func (rh *RawHistory) StreamEvents() error
- type ReleaseChecker
- type SettingsResponse
Constants ¶
const ( ReleaseCLI = "cli" ReleaseImage = "image" ReleaseUI = "ui" )
Release components that an install can be asked to upgrade.
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 GetLatestReleases ¶ added in v2.55.0
func GetLatestReleases(cfgProvider *config.ConfigProviderWithRefresh, checker *ReleaseChecker) func(echo.Context) error
GetLatestReleases returns the latest release of the configured distribution. A failed lookup returns no releases.
func GetSettings ¶
func GetSettings(cfgProvider *config.ConfigProviderWithRefresh) func(echo.Context) error
func GetUIExtensions ¶ added in v2.55.0
func GetUIExtensions(cfgProvider *config.ConfigProviderWithRefresh, accessCheck AccessCheck) func(echo.Context) error
GetUIExtensions returns the effective inline extension registry. Unlike the public bootstrap settings, this endpoint verifies access through the same Temporal API authority when authentication is enabled.
func ReleaseForDistribution ¶ added in v2.55.0
ReleaseForDistribution returns the release checked for a distribution. Unknown distributions are treated as a server built from source.
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 AccessCheck ¶ added in v2.55.0
func TemporalAccessCheck ¶ added in v2.55.0
func TemporalAccessCheck(conn *grpc.ClientConn, apiMiddleware []Middleware) AccessCheck
TemporalAccessCheck verifies the request against the same Temporal API authority used by the rest of the application. This is required in addition to the local header/JWT check because supported custom-auth deployments rely on Temporal's claim mapper and authorizer to validate access tokens.
type BannerResponse ¶ added in v2.57.0
type CodecResponse ¶
type CustomUIResponse ¶ added in v2.55.0
type CustomUIResponse struct {
Enabled bool
IframeExtensions []IframeExtensionResponse
}
type CustomUISettingsResponse ¶ added in v2.55.0
type CustomUISettingsResponse struct {
Enabled bool
}
type IWorkflowService ¶ added in v2.36.2
type IWorkflowService interface {
GetWorkflowExecutionHistory(
ctx context.Context,
in *workflowservice.GetWorkflowExecutionHistoryRequest,
opts ...grpc.CallOption,
) (*workflowservice.GetWorkflowExecutionHistoryResponse, error)
}
type IframeExtensionResponse ¶ added in v2.55.0
type IframeExtensionResponse struct {
ID string
Title string
Slot string
Src string
AllowedOrigin string
RoutePatterns []string
Sandbox IframeSandboxResponse
Sizing IframeExtensionSizingResponse
Permissions []string
}
type IframeExtensionSizingResponse ¶ added in v2.55.0
type IframeSandboxResponse ¶ added in v2.55.0
type LatestReleasesResponse ¶ added in v2.55.0
LatestReleasesResponse lists the latest published version of the release that this install's distribution is upgraded to.
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 ReleaseChecker ¶ added in v2.55.0
type ReleaseChecker struct {
// contains filtered or unexported fields
}
ReleaseChecker looks up the latest GitHub release of Temporal components and caches the results.
func NewReleaseChecker ¶ added in v2.55.0
func NewReleaseChecker() *ReleaseChecker
NewReleaseChecker creates a ReleaseChecker that queries the GitHub API.
type SettingsResponse ¶
type SettingsResponse struct {
Auth *Auth
Banner *BannerResponse
DefaultNamespace string
ShowTemporalSystemNamespace bool
FeedbackURL string
DisableNewsFetch bool
NotifyOnNewVersion bool
Distribution string
DistributionVersion string
Codec *CodecResponse
CustomUI *CustomUISettingsResponse
Version string
DisableWriteActions bool
WorkflowTerminateDisabled bool
WorkflowCancelDisabled bool
WorkflowSignalDisabled bool
WorkflowUpdateDisabled bool
WorkflowResetDisabled bool
WorkflowPauseDisabled bool
BatchActionsDisabled bool
StartWorkflowDisabled bool
HideWorkflowQueryErrors bool
RefreshWorkflowCountsDisabled bool
ActivityCommandsDisabled bool
}