Documentation
¶
Index ¶
- Constants
- type ApproveStepRequest
- type ApproveStepResponse
- type CancelGroupRequest
- type CancelGroupResponse
- type CancelStepRequest
- type CancelStepResponse
- type CancelWorkflowResponse
- type IsRetryableResponse
- type PollNextStepResponse
- type RetryGroupRequest
- type RetryGroupResponse
- type RetryStepRequest
- type RetryStepResponse
- type Signal
- type SkipStepRequest
- type SkipStepResponse
Constants ¶
const SignalType qsignal.SignalType = "execute-workflow"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ApproveStepRequest ¶
type ApproveStepRequest struct {
StepID string `json:"step_id"`
ApprovalResponseID string `json:"approval_response_id"`
ResponseType string `json:"response_type"`
}
ApproveStepRequest is the input for the "approve-step" update handler.
type ApproveStepResponse ¶
type ApproveStepResponse struct {
WorkflowID string `json:"workflow_id"`
}
ApproveStepResponse is the response from the "approve-step" update handler.
type CancelGroupRequest ¶
type CancelGroupRequest struct {
// StepID is any step in the group to cancel. The handler resolves the
// group from this step's GroupIdx and cancels all in-flight steps.
StepID string `json:"step_id"`
}
CancelGroupRequest is the input for the "cancel-group" update handler.
type CancelGroupResponse ¶
type CancelGroupResponse struct {
WorkflowID string `json:"workflow_id"`
}
CancelGroupResponse is the response from the "cancel-group" update handler.
type CancelStepRequest ¶
type CancelStepRequest struct {
StepID string `json:"step_id"`
}
CancelStepRequest is the input for the "cancel-step" update handler.
type CancelStepResponse ¶
type CancelStepResponse struct {
WorkflowID string `json:"workflow_id"`
}
CancelStepResponse is the response from the "cancel-step" update handler.
type CancelWorkflowResponse ¶
type CancelWorkflowResponse struct {
WorkflowID string `json:"workflow_id"`
}
CancelWorkflowResponse is the response from the "cancel-workflow" update handler.
type IsRetryableResponse ¶
type IsRetryableResponse struct {
Retryable bool `json:"retryable"`
StepID string `json:"step_id"`
}
IsRetryableResponse is the response from the "is-retryable" update handler.
type PollNextStepResponse ¶
type PollNextStepResponse struct {
StepID string `json:"step_id"`
StepIdx int `json:"step_idx"`
Status app.Status `json:"status"`
}
PollNextStepResponse is the response from the "poll-next-step" update handler.
type RetryGroupRequest ¶
type RetryGroupRequest struct {
// StepID is any step in the group to retry. The handler resolves the
// group from this step's GroupIdx.
StepID string `json:"step_id"`
}
RetryGroupRequest is the input for the "retry-group" update handler.
type RetryGroupResponse ¶
type RetryGroupResponse struct {
WorkflowID string `json:"workflow_id"`
Retryable bool `json:"retryable"`
}
RetryGroupResponse is the response from the "retry-group" update handler.
type RetryStepRequest ¶
type RetryStepRequest struct {
StepID string `json:"step_id"`
}
RetryStepRequest is the input for the "retry-step" update handler.
type RetryStepResponse ¶
type RetryStepResponse struct {
WorkflowID string `json:"workflow_id"`
Retryable bool `json:"retryable"`
}
RetryStepResponse is the response from the "retry-step" update handler.
type Signal ¶
type Signal struct {
// WorkflowID is the ID of the workflow to execute.
WorkflowID string `json:"workflow_id"`
// Conductor configuration — set by the creator when enqueuing.
StepGroupQueueName string `json:"step_group_queue_name"`
StepQueueName string `json:"step_queue_name"`
StepTargetQueueName string `json:"step_target_queue_name"`
OwnerID string `json:"owner_id"`
OwnerType string `json:"owner_type"`
// contains filtered or unexported fields
}
func (*Signal) RegisterUpdateHandlers ¶
func (*Signal) SleepAfter ¶
func (*Signal) Type ¶
func (s *Signal) Type() qsignal.SignalType
type SkipStepRequest ¶
type SkipStepRequest struct {
StepID string `json:"step_id"`
}
SkipStepRequest is the input for the "skip-step" update handler.
type SkipStepResponse ¶
type SkipStepResponse struct {
WorkflowID string `json:"workflow_id"`
Skippable bool `json:"skippable"`
}
SkipStepResponse is the response from the "skip-step" update handler.