Documentation
¶
Index ¶
- type Activities
- func (a *Activities) CheckNoopPlan(ctx context.Context, req *CheckNoopPlanRequest) (bool, error)
- func (a *Activities) CheckWorkflowRetryable(ctx context.Context, req CheckWorkflowRetryableRequest) (*CheckWorkflowRetryableResponse, error)
- func (a *Activities) CreateApprovalResponse(ctx context.Context, req CreateStepApprovalResponseRequest) (*app.WorkflowStepApprovalResponse, error)
- func (a *Activities) EvaluateSinglePolicy(ctx context.Context, req *EvaluateSinglePolicyRequest) (*EvaluateSinglePolicyResult, error)
- func (a *Activities) ForwardApprovePlan(ctx context.Context, req ForwardApprovePlanRequest) (*ForwardApprovePlanResponse, error)
- func (a *Activities) ForwardApproveStepToGroup(ctx context.Context, req ForwardApproveStepToGroupRequest) (*ForwardApproveStepToGroupResponse, error)
- func (a *Activities) ForwardCancelStep(ctx context.Context, req ForwardCancelStepRequest) (*ForwardCancelStepResponse, error)
- func (a *Activities) ForwardCancelStepToGroup(ctx context.Context, req ForwardCancelStepToGroupRequest) (*ForwardCancelStepToGroupResponse, error)
- func (a *Activities) ForwardCreateStepRetry(ctx context.Context, req ForwardCreateStepRetryRequest) (*ForwardCreateStepRetryResponse, error)
- func (a *Activities) ForwardGroupFinished(ctx context.Context, req ForwardGroupFinishedRequest) (*GroupFinishedResponse, error)
- func (a *Activities) ForwardIsRetryable(ctx context.Context, req ForwardIsRetryableRequest) (*ForwardIsRetryableResponse, error)
- func (a *Activities) ForwardRetryStepToGroup(ctx context.Context, req ForwardRetryStepToGroupRequest) (*ForwardRetryStepToGroupResponse, error)
- func (a *Activities) ForwardSkipStepToGroup(ctx context.Context, req ForwardSkipStepToGroupRequest) (*ForwardSkipStepToGroupResponse, error)
- func (a *Activities) ForwardStepFinished(ctx context.Context, req ForwardStepFinishedRequest) (*StepFinishedResponse, error)
- func (a *Activities) GetApprovalPlan(ctx context.Context, req GetApprovalPlanRequest) (*ApprovalPlan, error)
- func (a *Activities) PersistPolicyReport(ctx context.Context, req *PersistPolicyReportRequest) (*PersistPolicyReportResult, error)
- func (a *Activities) PkgWorkflowsFlowCreateFlowStepGroups(ctx context.Context, reqs CreateFlowStepGroupsRequest) ([]*app.WorkflowStepGroup, error)
- func (a *Activities) PkgWorkflowsFlowCreateFlowSteps(ctx context.Context, reqs CreateFlowStepsRequest) ([]*app.WorkflowStep, error)
- func (a *Activities) PkgWorkflowsFlowCreateWorkflowRun(ctx context.Context, req CreateWorkflowRunRequest) (*app.WorkflowRun, error)
- func (a *Activities) PkgWorkflowsFlowGetFlow(ctx context.Context, req GetFlowRequest) (*app.Workflow, error)
- func (a *Activities) PkgWorkflowsFlowGetFlowStepGroupByID(ctx context.Context, stepGroupID string) (*app.WorkflowStepGroup, error)
- func (a *Activities) PkgWorkflowsFlowGetFlowStepGroups(ctx context.Context, workflowID string) ([]app.WorkflowStepGroup, error)
- func (a *Activities) PkgWorkflowsFlowGetFlowSteps(ctx context.Context, req GetFlowStepsRequest) ([]app.WorkflowStep, error)
- func (a *Activities) PkgWorkflowsFlowGetFlowsStep(ctx context.Context, req GetFlowStepRequest) (*app.WorkflowStep, error)
- func (a *Activities) PkgWorkflowsFlowResetFlowFinishedAt(ctx context.Context, req ResetFlowFinishedAtRequest) error
- func (a *Activities) PkgWorkflowsFlowUpdateFlowFinishedAt(ctx context.Context, req UpdateFlowFinishedAtRequest) error
- func (a *Activities) PkgWorkflowsFlowUpdateFlowResultDirective(ctx context.Context, req UpdateFlowResultDirectiveRequest) error
- func (a *Activities) PkgWorkflowsFlowUpdateFlowStartedAt(ctx context.Context, req UpdateFlowStartedAtRequest) error
- func (a *Activities) PkgWorkflowsFlowUpdateFlowStepFinishedAt(ctx context.Context, req UpdateFlowStepFinishedAtRequest) error
- func (a *Activities) PkgWorkflowsFlowUpdateFlowStepGroupResultDirective(ctx context.Context, req UpdateFlowStepGroupResultDirectiveRequest) error
- func (a *Activities) PkgWorkflowsFlowUpdateFlowStepResultDirective(ctx context.Context, req UpdateFlowStepResultDirectiveRequest) error
- func (a *Activities) PkgWorkflowsFlowUpdateFlowStepRetried(ctx context.Context, req UpdateFlowStepRetriedRequest) error
- func (a *Activities) PkgWorkflowsFlowUpdateFlowStepStartedAt(ctx context.Context, req UpdateFlowStepStartedAtRequest) error
- func (a *Activities) PkgWorkflowsFlowUpdateFlowStepTargetStatus(ctx context.Context, req UpdateFlowStepTargetStatusRequest) error
- func (a *Activities) PkgWorkflowsFlowUpdateWorkflowRunStatus(ctx context.Context, req UpdateWorkflowRunStatusRequest) error
- func (a *Activities) PrepPolicyEvaluation(ctx context.Context, req *PrepPolicyEvaluationRequest) (*PrepPolicyEvaluationResult, error)
- func (a *Activities) SyncNoopDeployOutputs(ctx context.Context, req *SyncNoopDeployOutputsRequest) error
- type ApprovalPlan
- type CheckNoopPlanRequest
- type CheckWorkflowRetryableRequest
- type CheckWorkflowRetryableResponse
- type CreateFlowStep
- type CreateFlowStepGroup
- type CreateFlowStepGroupsRequest
- type CreateFlowStepsRequest
- type CreateStepApprovalResponseRequest
- type CreateWorkflowRunRequest
- type EvaluateSinglePolicyRequest
- type EvaluateSinglePolicyResult
- type ForwardApprovePlanRequest
- type ForwardApprovePlanResponse
- type ForwardApproveStepToGroupRequest
- type ForwardApproveStepToGroupResponse
- type ForwardCancelStepRequest
- type ForwardCancelStepResponse
- type ForwardCancelStepToGroupRequest
- type ForwardCancelStepToGroupResponse
- type ForwardCreateStepRetryRequest
- type ForwardCreateStepRetryResponse
- type ForwardGroupFinishedRequest
- type ForwardIsRetryableRequest
- type ForwardIsRetryableResponse
- type ForwardRetryStepToGroupRequest
- type ForwardRetryStepToGroupResponse
- type ForwardSkipStepToGroupRequest
- type ForwardSkipStepToGroupResponse
- type ForwardStepFinishedRequest
- type GetApprovalPlanRequest
- type GetFlowRequest
- type GetFlowStepRequest
- type GetFlowStepsRequest
- type GetRunnerJobExecutionRequest
- type GetRunnerJobExecutionResultRequest
- type GetRunnerJobRequest
- type GroupFinishedResponse
- type Params
- type PersistPolicyReportRequest
- type PersistPolicyReportResult
- type PolicyToEvaluate
- type PolicyViolation
- type PrepPolicyEvaluationRequest
- type PrepPolicyEvaluationResult
- type ResetFlowFinishedAtRequest
- type StepFinishedResponse
- type SyncNoopDeployOutputsRequest
- type UpdateFlowFinishedAtRequest
- type UpdateFlowResultDirectiveRequest
- type UpdateFlowStartedAtRequest
- type UpdateFlowStepFinishedAtRequest
- type UpdateFlowStepGroupResultDirectiveRequest
- type UpdateFlowStepResultDirectiveRequest
- type UpdateFlowStepRetriedRequest
- type UpdateFlowStepStartedAtRequest
- type UpdateFlowStepTargetStatusRequest
- type UpdateWorkflowRunStatusRequest
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Activities ¶
type Activities struct {
// contains filtered or unexported fields
}
func New ¶
func New(params Params) *Activities
func (*Activities) CheckNoopPlan ¶
func (a *Activities) CheckNoopPlan(ctx context.Context, req *CheckNoopPlanRequest) (bool, error)
@temporal-gen-v2 activity @max-retries 5
func (*Activities) CheckWorkflowRetryable ¶ added in v0.19.894
func (a *Activities) CheckWorkflowRetryable(ctx context.Context, req CheckWorkflowRetryableRequest) (*CheckWorkflowRetryableResponse, error)
@temporal-gen-v2 activity @start-to-close-timeout 30s
func (*Activities) CreateApprovalResponse ¶
func (a *Activities) CreateApprovalResponse(ctx context.Context, req CreateStepApprovalResponseRequest) (*app.WorkflowStepApprovalResponse, error)
@temporal-gen-v2 activity @schedule-to-close-timeout 1m @start-to-close-timeout 10s
func (*Activities) EvaluateSinglePolicy ¶
func (a *Activities) EvaluateSinglePolicy(ctx context.Context, req *EvaluateSinglePolicyRequest) (*EvaluateSinglePolicyResult, error)
@temporal-gen-v2 activity @max-retries 1 @schedule-to-close-timeout 2m @start-to-close-timeout 1m30s
func (*Activities) ForwardApprovePlan ¶ added in v0.19.894
func (a *Activities) ForwardApprovePlan(ctx context.Context, req ForwardApprovePlanRequest) (*ForwardApprovePlanResponse, error)
@temporal-gen-v2 activity @start-to-close-timeout 30s
func (*Activities) ForwardApproveStepToGroup ¶ added in v0.19.894
func (a *Activities) ForwardApproveStepToGroup(ctx context.Context, req ForwardApproveStepToGroupRequest) (*ForwardApproveStepToGroupResponse, error)
@temporal-gen-v2 activity @start-to-close-timeout 30s
func (*Activities) ForwardCancelStep ¶ added in v0.19.894
func (a *Activities) ForwardCancelStep(ctx context.Context, req ForwardCancelStepRequest) (*ForwardCancelStepResponse, error)
@temporal-gen-v2 activity @start-to-close-timeout 30s
func (*Activities) ForwardCancelStepToGroup ¶ added in v0.19.894
func (a *Activities) ForwardCancelStepToGroup(ctx context.Context, req ForwardCancelStepToGroupRequest) (*ForwardCancelStepToGroupResponse, error)
@temporal-gen-v2 activity @start-to-close-timeout 30s
func (*Activities) ForwardCreateStepRetry ¶ added in v0.19.894
func (a *Activities) ForwardCreateStepRetry(ctx context.Context, req ForwardCreateStepRetryRequest) (*ForwardCreateStepRetryResponse, error)
@temporal-gen-v2 activity @start-to-close-timeout 30s
func (*Activities) ForwardGroupFinished ¶ added in v0.19.894
func (a *Activities) ForwardGroupFinished(ctx context.Context, req ForwardGroupFinishedRequest) (*GroupFinishedResponse, error)
@temporal-gen-v2 activity @start-to-close-timeout 5m @schedule-to-close-timeout 2h @heartbeat-timeout 60s
func (*Activities) ForwardIsRetryable ¶ added in v0.19.894
func (a *Activities) ForwardIsRetryable(ctx context.Context, req ForwardIsRetryableRequest) (*ForwardIsRetryableResponse, error)
@temporal-gen-v2 activity @start-to-close-timeout 30s
func (*Activities) ForwardRetryStepToGroup ¶ added in v0.19.894
func (a *Activities) ForwardRetryStepToGroup(ctx context.Context, req ForwardRetryStepToGroupRequest) (*ForwardRetryStepToGroupResponse, error)
@temporal-gen-v2 activity @start-to-close-timeout 30s
func (*Activities) ForwardSkipStepToGroup ¶ added in v0.19.894
func (a *Activities) ForwardSkipStepToGroup(ctx context.Context, req ForwardSkipStepToGroupRequest) (*ForwardSkipStepToGroupResponse, error)
@temporal-gen-v2 activity @start-to-close-timeout 30s
func (*Activities) ForwardStepFinished ¶ added in v0.19.894
func (a *Activities) ForwardStepFinished(ctx context.Context, req ForwardStepFinishedRequest) (*StepFinishedResponse, error)
@temporal-gen-v2 activity @start-to-close-timeout 5m @schedule-to-close-timeout 2h @heartbeat-timeout 60s
func (*Activities) GetApprovalPlan ¶
func (a *Activities) GetApprovalPlan(ctx context.Context, req GetApprovalPlanRequest) (*ApprovalPlan, error)
@temporal-gen-v2 activity @max-retries 1
func (*Activities) PersistPolicyReport ¶ added in v0.19.771
func (a *Activities) PersistPolicyReport(ctx context.Context, req *PersistPolicyReportRequest) (*PersistPolicyReportResult, error)
@temporal-gen-v2 activity @max-retries 3 @schedule-to-close-timeout 2m @start-to-close-timeout 1m30s
func (*Activities) PkgWorkflowsFlowCreateFlowStepGroups ¶ added in v0.19.894
func (a *Activities) PkgWorkflowsFlowCreateFlowStepGroups(ctx context.Context, reqs CreateFlowStepGroupsRequest) ([]*app.WorkflowStepGroup, error)
@temporal-gen-v2 activity
func (*Activities) PkgWorkflowsFlowCreateFlowSteps ¶
func (a *Activities) PkgWorkflowsFlowCreateFlowSteps(ctx context.Context, reqs CreateFlowStepsRequest) ([]*app.WorkflowStep, error)
@temporal-gen-v2 activity
func (*Activities) PkgWorkflowsFlowCreateWorkflowRun ¶ added in v0.19.894
func (a *Activities) PkgWorkflowsFlowCreateWorkflowRun(ctx context.Context, req CreateWorkflowRunRequest) (*app.WorkflowRun, error)
@temporal-gen-v2 activity
func (*Activities) PkgWorkflowsFlowGetFlow ¶
func (a *Activities) PkgWorkflowsFlowGetFlow(ctx context.Context, req GetFlowRequest) (*app.Workflow, error)
@temporal-gen-v2 activity @by-field ID
func (*Activities) PkgWorkflowsFlowGetFlowStepGroupByID ¶ added in v0.19.894
func (a *Activities) PkgWorkflowsFlowGetFlowStepGroupByID(ctx context.Context, stepGroupID string) (*app.WorkflowStepGroup, error)
@temporal-gen-v2 activity
func (*Activities) PkgWorkflowsFlowGetFlowStepGroups ¶ added in v0.19.894
func (a *Activities) PkgWorkflowsFlowGetFlowStepGroups(ctx context.Context, workflowID string) ([]app.WorkflowStepGroup, error)
@temporal-gen-v2 activity
func (*Activities) PkgWorkflowsFlowGetFlowSteps ¶
func (a *Activities) PkgWorkflowsFlowGetFlowSteps(ctx context.Context, req GetFlowStepsRequest) ([]app.WorkflowStep, error)
@temporal-gen-v2 activity @by-field FlowID
func (*Activities) PkgWorkflowsFlowGetFlowsStep ¶
func (a *Activities) PkgWorkflowsFlowGetFlowsStep(ctx context.Context, req GetFlowStepRequest) (*app.WorkflowStep, error)
@temporal-gen-v2 activity @by-field FlowStepID
func (*Activities) PkgWorkflowsFlowResetFlowFinishedAt ¶
func (a *Activities) PkgWorkflowsFlowResetFlowFinishedAt(ctx context.Context, req ResetFlowFinishedAtRequest) error
@temporal-gen-v2 activity @by-field ID
func (*Activities) PkgWorkflowsFlowUpdateFlowFinishedAt ¶
func (a *Activities) PkgWorkflowsFlowUpdateFlowFinishedAt(ctx context.Context, req UpdateFlowFinishedAtRequest) error
@temporal-gen-v2 activity @by-field ID
func (*Activities) PkgWorkflowsFlowUpdateFlowResultDirective ¶ added in v0.19.894
func (a *Activities) PkgWorkflowsFlowUpdateFlowResultDirective(ctx context.Context, req UpdateFlowResultDirectiveRequest) error
@temporal-gen-v2 activity
func (*Activities) PkgWorkflowsFlowUpdateFlowStartedAt ¶
func (a *Activities) PkgWorkflowsFlowUpdateFlowStartedAt(ctx context.Context, req UpdateFlowStartedAtRequest) error
@temporal-gen-v2 activity @by-field ID
func (*Activities) PkgWorkflowsFlowUpdateFlowStepFinishedAt ¶
func (a *Activities) PkgWorkflowsFlowUpdateFlowStepFinishedAt(ctx context.Context, req UpdateFlowStepFinishedAtRequest) error
@temporal-gen-v2 activity @by-field ID
func (*Activities) PkgWorkflowsFlowUpdateFlowStepGroupResultDirective ¶ added in v0.19.894
func (a *Activities) PkgWorkflowsFlowUpdateFlowStepGroupResultDirective(ctx context.Context, req UpdateFlowStepGroupResultDirectiveRequest) error
@temporal-gen-v2 activity
func (*Activities) PkgWorkflowsFlowUpdateFlowStepResultDirective ¶ added in v0.19.894
func (a *Activities) PkgWorkflowsFlowUpdateFlowStepResultDirective(ctx context.Context, req UpdateFlowStepResultDirectiveRequest) error
@temporal-gen-v2 activity
func (*Activities) PkgWorkflowsFlowUpdateFlowStepRetried ¶ added in v0.19.894
func (a *Activities) PkgWorkflowsFlowUpdateFlowStepRetried(ctx context.Context, req UpdateFlowStepRetriedRequest) error
@temporal-gen-v2 activity
func (*Activities) PkgWorkflowsFlowUpdateFlowStepStartedAt ¶
func (a *Activities) PkgWorkflowsFlowUpdateFlowStepStartedAt(ctx context.Context, req UpdateFlowStepStartedAtRequest) error
@temporal-gen-v2 activity @by-field ID
func (*Activities) PkgWorkflowsFlowUpdateFlowStepTargetStatus ¶
func (a *Activities) PkgWorkflowsFlowUpdateFlowStepTargetStatus(ctx context.Context, req UpdateFlowStepTargetStatusRequest) error
@temporal-gen-v2 activity
func (*Activities) PkgWorkflowsFlowUpdateWorkflowRunStatus ¶ added in v0.19.894
func (a *Activities) PkgWorkflowsFlowUpdateWorkflowRunStatus(ctx context.Context, req UpdateWorkflowRunStatusRequest) error
@temporal-gen-v2 activity
func (*Activities) PrepPolicyEvaluation ¶
func (a *Activities) PrepPolicyEvaluation(ctx context.Context, req *PrepPolicyEvaluationRequest) (*PrepPolicyEvaluationResult, error)
@temporal-gen-v2 activity @max-retries 1 @schedule-to-close-timeout 5m @start-to-close-timeout 4m
func (*Activities) SyncNoopDeployOutputs ¶ added in v0.19.850
func (a *Activities) SyncNoopDeployOutputs(ctx context.Context, req *SyncNoopDeployOutputsRequest) error
SyncNoopDeployOutputs copies outputs from the latest plan job to a new finished apply job on the deploy. This is called when a deploy plan is noop (infrastructure matches desired state) so that the deploy has outputs just like a normal apply would produce. The plan job already collected outputs via terraform output / helm get values.
@temporal-gen-v2 activity @max-retries 1
type ApprovalPlan ¶
type ApprovalPlan struct {
RunnerJobType app.RunnerJobType `json:"runner_job_type" temporaljson:"runner_job_type,omitempty"`
PlanContents []byte `json:"plan_contents" temporaljson:"plan_contents,omitempty"`
}
func (*ApprovalPlan) IsNoopPlan ¶
func (p *ApprovalPlan) IsNoopPlan() (bool, error)
type CheckNoopPlanRequest ¶
type CheckNoopPlanRequest struct {
StepTargetID string `validate:"required"`
}
type CheckWorkflowRetryableRequest ¶ added in v0.19.894
type CheckWorkflowRetryableRequest struct {
WorkflowID string `json:"workflow_id" validate:"required"`
}
CheckWorkflowRetryableRequest is the input for checking if a workflow is retryable.
type CheckWorkflowRetryableResponse ¶ added in v0.19.894
type CheckWorkflowRetryableResponse struct {
Retryable bool `json:"retryable"`
}
CheckWorkflowRetryableResponse is the output indicating retryability.
type CreateFlowStep ¶
type CreateFlowStep struct {
ID string `json:"id"`
FlowID string `json:"flow_id" validate:"required"`
OwnerID string `json:"owner_id" validate:"required"`
OwnerType string `json:"owner_type" validate:"required"`
Status app.CompositeStatus `json:"status"`
Name string `json:"name"`
Idx int `json:"idx"`
ExecutionType app.WorkflowStepExecutionType `json:"execution_type"`
Metadata pgtype.Hstore `json:"metadata"`
Retryable bool `json:"retryable"`
Skippable bool `json:"skippable"`
GroupIdx int `json:"group_idx"`
GroupRetryIdx int `json:"group_retry_idx"`
WorkflowStepGroupID string `json:"workflow_step_group_id"`
StepTargetType string `json:"step_target_type"`
StepTargetID string `json:"step_target_id"`
RetryIndex int `json:"retry_index"`
StepQueueID string `json:"step_queue_id"`
TargetQueueID string `json:"target_queue_id"`
// TODO(jm): this is being deprecated
Signal *app.Signal `json:"signal"`
QueueSignal *signaldb.SignalData `json:"queue_signal"`
}
type CreateFlowStepGroup ¶ added in v0.19.894
type CreateFlowStepGroupsRequest ¶ added in v0.19.894
type CreateFlowStepGroupsRequest struct {
Groups []CreateFlowStepGroup `json:"groups" validate:"required"`
}
type CreateFlowStepsRequest ¶
type CreateFlowStepsRequest struct {
Steps []CreateFlowStep `json:"steps" validate:"required"`
}
type CreateStepApprovalResponseRequest ¶
type CreateStepApprovalResponseRequest struct {
StepApprovalID string `json:"step_approval_id" validate:"required"`
Type app.WorkflowStepResponseType `json:"type" validate:"required"`
Note string `json:"note" validate:"required"`
}
type CreateWorkflowRunRequest ¶ added in v0.19.894
type CreateWorkflowRunRequest struct {
WorkflowID string `json:"workflow_id" validate:"required"`
Type app.WorkflowRunType `json:"type" validate:"required"`
TriggerStepID string `json:"trigger_step_id,omitempty"`
StartFromIdx int `json:"start_from_idx"`
}
type EvaluateSinglePolicyRequest ¶
type EvaluateSinglePolicyRequest struct {
PolicyID string `json:"policy_id" validate:"required"`
PolicyName string `json:"policy_name"`
Contents string `json:"contents" validate:"required"`
InputJSON []byte `json:"input_json" validate:"required"`
InputIndex int `json:"input_index"` // Index of the input document being evaluated
InputIdentity string `json:"input_identity" validate:""` // Human-readable input reference
}
type EvaluateSinglePolicyResult ¶
type EvaluateSinglePolicyResult struct {
Violations []PolicyViolation `json:"violations" temporaljson:"violations,omitempty"`
}
type ForwardApprovePlanRequest ¶ added in v0.19.894
type ForwardApprovePlanRequest struct {
StepID string `json:"step_id" validate:"required"`
ApprovalResponseID string `json:"approval_response_id"`
ResponseType string `json:"response_type"`
}
ForwardApprovePlanRequest is the input for forwarding an approval to a step handler workflow.
type ForwardApprovePlanResponse ¶ added in v0.19.894
type ForwardApprovePlanResponse struct {
StepID string `json:"step_id"`
}
ForwardApprovePlanResponse is the output from forwarding an approval.
type ForwardApproveStepToGroupRequest ¶ added in v0.19.894
type ForwardApproveStepToGroupRequest struct {
StepID string `json:"step_id" validate:"required"`
StepGroupID string `json:"step_group_id" validate:"required"`
ApprovalResponseID string `json:"approval_response_id"`
ResponseType string `json:"response_type"`
}
ForwardApproveStepToGroupRequest is the input for forwarding an approve-step to the group.
type ForwardApproveStepToGroupResponse ¶ added in v0.19.894
type ForwardApproveStepToGroupResponse struct{}
ForwardApproveStepToGroupResponse wraps the group's approve-step response.
type ForwardCancelStepRequest ¶ added in v0.19.894
type ForwardCancelStepRequest struct {
StepID string `json:"step_id" validate:"required"`
}
ForwardCancelStepRequest is the input for forwarding a cancellation to a step handler workflow.
type ForwardCancelStepResponse ¶ added in v0.19.894
type ForwardCancelStepResponse struct {
StepID string `json:"step_id"`
}
ForwardCancelStepResponse is the output from forwarding a cancellation.
type ForwardCancelStepToGroupRequest ¶ added in v0.19.894
type ForwardCancelStepToGroupRequest struct {
StepID string `json:"step_id" validate:"required"`
StepGroupID string `json:"step_group_id" validate:"required"`
}
ForwardCancelStepToGroupRequest is the input for forwarding a cancel-step to the group.
type ForwardCancelStepToGroupResponse ¶ added in v0.19.894
type ForwardCancelStepToGroupResponse struct{}
ForwardCancelStepToGroupResponse wraps the group's cancel-step response.
type ForwardCreateStepRetryRequest ¶ added in v0.19.894
type ForwardCreateStepRetryRequest struct {
StepID string `json:"step_id" validate:"required"`
}
ForwardCreateStepRetryRequest is the input for forwarding a create-step-retry to a step handler workflow.
type ForwardCreateStepRetryResponse ¶ added in v0.19.894
type ForwardCreateStepRetryResponse struct {
StepID string `json:"step_id"`
NewStepID string `json:"new_step_id"`
Directive string `json:"directive"`
}
ForwardCreateStepRetryResponse is the output from forwarding a create-step-retry.
type ForwardGroupFinishedRequest ¶ added in v0.19.894
type ForwardGroupFinishedRequest struct {
StepGroupID string `json:"step_group_id" validate:"required"`
}
ForwardGroupFinishedRequest is the input for forwarding a group-finished update to a group handler workflow.
type ForwardIsRetryableRequest ¶ added in v0.19.894
type ForwardIsRetryableRequest struct {
StepID string `json:"step_id" validate:"required"`
}
ForwardIsRetryableRequest is the input for forwarding an is-retryable query to a step handler workflow.
type ForwardIsRetryableResponse ¶ added in v0.19.894
type ForwardIsRetryableResponse struct {
Retryable bool `json:"retryable"`
Skippable bool `json:"skippable"`
AutoRetry bool `json:"auto_retry"`
MaxRetries int `json:"max_retries"`
RetryGroup bool `json:"retry_group"`
RetryIndex int `json:"retry_index"`
StepID string `json:"step_id"`
}
ForwardIsRetryableResponse is the output from the is-retryable update.
type ForwardRetryStepToGroupRequest ¶ added in v0.19.894
type ForwardRetryStepToGroupRequest struct {
StepID string `json:"step_id" validate:"required"`
StepGroupID string `json:"step_group_id" validate:"required"`
}
ForwardRetryStepToGroupRequest is the input for forwarding a retry-step to the group.
type ForwardRetryStepToGroupResponse ¶ added in v0.19.894
type ForwardRetryStepToGroupResponse struct {
Retryable bool `json:"retryable"`
}
ForwardRetryStepToGroupResponse wraps the group's retry-step response.
type ForwardSkipStepToGroupRequest ¶ added in v0.19.894
type ForwardSkipStepToGroupRequest struct {
StepID string `json:"step_id" validate:"required"`
StepGroupID string `json:"step_group_id" validate:"required"`
}
ForwardSkipStepToGroupRequest is the input for forwarding a skip-step to the group.
type ForwardSkipStepToGroupResponse ¶ added in v0.19.894
type ForwardSkipStepToGroupResponse struct {
Skippable bool `json:"skippable"`
}
ForwardSkipStepToGroupResponse wraps the group's skip-step response.
type ForwardStepFinishedRequest ¶ added in v0.19.894
type ForwardStepFinishedRequest struct {
StepID string `json:"step_id" validate:"required"`
}
ForwardStepFinishedRequest is the input for forwarding a step-finished update to a step handler workflow.
type GetApprovalPlanRequest ¶
type GetApprovalPlanRequest struct {
StepTargetID string `validate:"required"`
}
type GetFlowRequest ¶
type GetFlowRequest struct {
ID string `validate:"required"`
}
type GetFlowStepRequest ¶
type GetFlowStepRequest struct {
FlowStepID string `json:"flow_step_id" validate:"required"`
}
type GetFlowStepsRequest ¶
type GetFlowStepsRequest struct {
FlowID string `json:"flow_id" validate:"required"`
}
type GetRunnerJobExecutionRequest ¶
type GetRunnerJobExecutionRequest struct {
RunnerJobID string `validate:"required"`
}
type GetRunnerJobExecutionResultRequest ¶
type GetRunnerJobExecutionResultRequest struct {
RunnerJobExecutionID string `validate:"required"`
}
type GetRunnerJobRequest ¶
type GetRunnerJobRequest struct {
RunnerJobOwnerID string `validate:"required"`
}
type GroupFinishedResponse ¶ added in v0.19.894
type GroupFinishedResponse struct {
Directive string `json:"directive"`
}
GroupFinishedResponse is the typed response from the group-finished update handler. It contains the group's final directive so callers don't need to re-fetch the workflow's ResultDirective from the database.
type Params ¶
type Params struct {
fx.In
DB *gorm.DB `name:"psql"`
CHDB *gorm.DB `name:"ch"`
AppsHelpers *appshelpers.Helpers
TClient temporalclient.Client
}
type PersistPolicyReportRequest ¶ added in v0.19.771
type PersistPolicyReportRequest struct {
OrgID string `json:"org_id" validate:"required"`
AppID string `json:"app_id" validate:"required"`
InstallID *string `json:"install_id"`
InstallSandboxID *string `json:"install_sandbox_id"`
ComponentID *string `json:"component_id"`
ComponentBuildID *string `json:"component_build_id"`
WorkflowStepPolicyValidationID *string `json:"workflow_step_policy_validation_id"`
RunnerJobID *string `json:"runner_job_id"`
OwnerID string `json:"owner_id" validate:"required"`
OwnerType string `json:"owner_type" validate:"required"`
Violations []PolicyViolation `json:"violations"`
PolicyIDs []string `json:"policy_ids"`
PolicyInputCounts map[string]int `json:"policy_input_counts"`
DenyCount int `json:"deny_count"`
WarnCount int `json:"warn_count"`
PassCount int `json:"pass_count"`
// Human-readable names for display in reports
OrgName string `json:"org_name"`
AppName string `json:"app_name"`
InstallName string `json:"install_name"`
ComponentName string `json:"component_name"`
}
type PersistPolicyReportResult ¶ added in v0.19.771
type PersistPolicyReportResult struct {
ReportID string `json:"report_id" temporaljson:"report_id,omitempty"`
DenyCount int `json:"deny_count" temporaljson:"deny_count,omitempty"`
WarnCount int `json:"warn_count" temporaljson:"warn_count,omitempty"`
PassCount int `json:"pass_count" temporaljson:"pass_count,omitempty"`
PassedPolicyIDs []string `json:"passed_policy_ids" temporaljson:"passed_policy_ids,omitempty"`
}
type PolicyToEvaluate ¶
type PolicyToEvaluate struct {
PolicyID string `json:"policy_id" temporaljson:"policy_id,omitempty"`
PolicyName string `json:"policy_name" temporaljson:"policy_name,omitempty"`
Contents string `json:"contents" temporaljson:"contents,omitempty"`
InputJSON []byte `json:"input_json" temporaljson:"input_json,omitempty"`
InputIndex int `json:"input_index" temporaljson:"input_index,omitempty"` // Index of the input document
InputIdentity string `json:"input_identity" temporaljson:"input_identity,omitempty"` // Human-readable input reference
}
type PolicyViolation ¶
type PolicyViolation = app.PolicyViolation
PolicyViolation is an alias to app.PolicyViolation for use in activity requests/responses.
type PrepPolicyEvaluationResult ¶
type PrepPolicyEvaluationResult struct {
Policies []PolicyToEvaluate `json:"policies" temporaljson:"policies,omitempty"`
HasPolicies bool `json:"has_policies" temporaljson:"has_policies,omitempty"`
OrgID string `json:"org_id" temporaljson:"org_id,omitempty"`
AppID string `json:"app_id" temporaljson:"app_id,omitempty"`
InstallID *string `json:"install_id" temporaljson:"install_id,omitempty"`
InstallSandboxID *string `json:"install_sandbox_id" temporaljson:"install_sandbox_id,omitempty"`
ComponentID *string `json:"component_id" temporaljson:"component_id,omitempty"`
ComponentBuildID *string `json:"component_build_id" temporaljson:"component_build_id,omitempty"`
PolicyIDs []string `json:"policy_ids" temporaljson:"policy_ids,omitempty"`
InputCount int `json:"input_count" temporaljson:"input_count,omitempty"`
// Human-readable names for display in reports
OrgName string `json:"org_name" temporaljson:"org_name,omitempty"`
AppName string `json:"app_name" temporaljson:"app_name,omitempty"`
InstallName string `json:"install_name" temporaljson:"install_name,omitempty"`
ComponentName string `json:"component_name" temporaljson:"component_name,omitempty"`
}
type ResetFlowFinishedAtRequest ¶
type ResetFlowFinishedAtRequest struct {
ID string `validate:"required"`
}
type StepFinishedResponse ¶ added in v0.19.894
type StepFinishedResponse struct {
StepID string `json:"step_id"`
Status app.Status `json:"status"`
Directive string `json:"directive"`
}
StepFinishedResponse is the typed response from the step-finished update handler. It contains the step's final status and directive so callers don't need to re-fetch the step from the database.
type SyncNoopDeployOutputsRequest ¶ added in v0.19.850
type SyncNoopDeployOutputsRequest struct {
StepID string `validate:"required"`
}
type UpdateFlowFinishedAtRequest ¶
type UpdateFlowFinishedAtRequest struct {
ID string `validate:"required"`
}
type UpdateFlowResultDirectiveRequest ¶ added in v0.19.894
type UpdateFlowStartedAtRequest ¶
type UpdateFlowStartedAtRequest struct {
ID string `validate:"required"`
}
type UpdateFlowStepFinishedAtRequest ¶
type UpdateFlowStepFinishedAtRequest struct {
ID string `validate:"required"`
}
type UpdateFlowStepGroupResultDirectiveRequest ¶ added in v0.19.894
type UpdateFlowStepResultDirectiveRequest ¶ added in v0.19.894
type UpdateFlowStepRetriedRequest ¶ added in v0.19.894
type UpdateFlowStepRetriedRequest struct {
StepID string `validate:"required"`
}
type UpdateFlowStepStartedAtRequest ¶
type UpdateFlowStepStartedAtRequest struct {
ID string `validate:"required"`
}
type UpdateFlowStepTargetStatusRequest ¶
type UpdateFlowStepTargetStatusRequest struct {
StepID string `validate:"required"`
Status app.Status `validate:"required"`
StatusDescription string
}
NOTE(jm): once install-deploys and sandbox-runs objects are updated to the composite status type, we will not need to use this type of update flow
type UpdateWorkflowRunStatusRequest ¶ added in v0.19.894
type UpdateWorkflowRunStatusRequest struct {
RunID string `json:"run_id" validate:"required"`
Status app.CompositeStatus `json:"status" validate:"required"`
}
Source Files
¶
- activities.go
- approvals.go
- check_noop_plan.go
- check_workflow_retryable.go
- create_flow_step_groups.go
- create_flow_steps.go
- evaluate_single_policy.go
- forward_approve_plan.go
- forward_cancel_step.go
- forward_create_step_retry.go
- forward_group_finished.go
- forward_is_retryable.go
- forward_step_finished.go
- forward_to_group.go
- get_flow.go
- get_flow_step.go
- get_flow_step_group_by_id.go
- get_flow_step_groups.go
- get_flow_steps.go
- get_runner_job.go
- persist_policy_report.go
- prep_policy_evaluation.go
- reset_flow_finished_at.go
- sync_noop_deploy_outputs.go
- update_flow_finished_at.go
- update_flow_result_directive.go
- update_flow_started_at.go
- update_flow_step_finished_at.go
- update_flow_step_group_result_directive.go
- update_flow_step_result_directive.go
- update_flow_step_retried.go
- update_flow_step_started_at.go
- update_flow_step_target_status.go
- workflow_run.go