model

Documentation

Index

• type WfhTemporalCancelRequest
• type WfhTemporalCancelRequestSpec
• type WorkerIntent
• type WorkerKey
• type WorkerSpec
• type WorkflowHookIntent
• type WorkflowHookKey
• type WorkflowHookSpec

Types

type WfhTemporalCancelRequest

type WfhTemporalCancelRequest struct {
	Metadata mtypes.Metadata              `json:"metadata,omitempty"`
	Spec     WfhTemporalCancelRequestSpec `json:"spec"`
}

type WfhTemporalCancelRequestSpec

type WfhTemporalCancelRequestSpec struct {
	// The Temporal server's endpoint. E.g. "temporal.foo.com:7233". Required.
	TemporalServer string `json:"temporalServer"`
	// If WfID is specified, that overrides the one in the workflow intent.
	WfID  string `json:"workflowID,omitempty"`
	RunID string `json:"runID,omitempty"`
	// If Terminate == true, TerminateWorkflow() is called, else CancelWorkflow().
	Terminate bool          `json:"terminate,omitempty"`
	Reason    string        `json:"reason,omitempty"`
	Details   []interface{} `json:"details,omitempty"`
}

type WorkerIntent

type WorkerIntent struct {
	// Worker Metadata
	Metadata mtypes.Metadata `json:"metadata"`

	// Worker Spec
	Spec WorkerSpec `json:"spec"`
}

type WorkerKey

type WorkerKey struct {
	WorkerName          string `json:"workerIntent"`
	WorkflowHook        string `json:"workflowHookIntent"`
	Project             string `json:"project"`
	CompositeApp        string `json:"compositeApp"`
	CompositeAppVersion string `json:"compositeAppVersion"`
	DigName             string `json:"deploymentIntentGroup"`
}

type WorkerSpec

type WorkerSpec struct {
	StartToCloseTimeout int    `json:"startToCloseTimeout"`
	DIG                 string `json:"deploymentIntentGroup"`
	CApp                string `json:"compositeApp"`
	CAppVersion         string `json:"compositeAppVersion"`
}

type WorkflowHookIntent

type WorkflowHookIntent struct {
	// Intent Metadata
	Metadata mtypes.Metadata `json:"metadata,omitempty"`

	// Workflow Hook Type
	Spec WorkflowHookSpec `json:"spec"`
}

WorkflowHookIntent contains the parameters needed to create a workflow hook

type WorkflowHookKey

type WorkflowHookKey struct {
	WorkflowHook        string `json:"workflowHookIntent"`
	Project             string `json:"project"`
	CompositeApp        string `json:"compositeApp"`
	CompositeAppVersion string `json:"compositeAppVersion"`
	DigName             string `json:"deploymentIntentGroup"`
}

WorkflowHookKey is the key structure that is used in the database

type WorkflowHookSpec

type WorkflowHookSpec struct {
	// What kind of hook that this is.
	HookType string `json:"hookType"` // (pre/post)-(install/update/terminate)
	// Network endpoint at which the workflow client resides.
	WfClientSpec wfMod.WfClientSpec `json:"workflowClient"`
	// See emcotemporalapi package.
	WfTemporalSpec tmpl.WfTemporalSpec `json:"temporal"`
}

Workflow Hook specs have the specifications needed to create a hook