Documentation
¶
Index ¶
- type CreateAndWaitRequest
- type CreateWorkflowRequest
- type NextState
- type RetryConfig
- type SearchWorkflowRequest
- type SearchWorkflowResponse
- type StateType
- type UpdateStateVarRequest
- type UpdateStateVarResponse
- type UpdateWorkflowStateAndWaitRequest
- type UpdateWorkflowStateRequest
- type UpdateWorkflowStateResponse
- type WorkflowApiResponse
- type WorkflowState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CreateAndWaitRequest ¶ added in v1.0.11
type CreateAndWaitRequest struct { CreateWorkflowRequest CreateWorkflowRequest `json:"createWorkflowRequest"` WaitSeconds int `json:"waitSeconds"` CheckSeconds int `json:"checkSeconds"` WaitForStates []string `json:"waitForStates"` }
CreateAndWaitRequest is the payload for creating a workflow then waiting the number of seconds for the workflow to reach the given states. otherwise it times out
type CreateWorkflowRequest ¶ added in v1.0.11
type CreateWorkflowRequest struct { ExternalID string `json:"externalId"` ExecutorGroup string `json:"executorGroup"` WorkflowType string `json:"workflowType"` BusinessKey string `json:"businessKey"` StateVars map[string]string `json:"stateVars"` // Optional scheduling inputs NextActivation *time.Time `json:"nextActivation,omitempty"` NextActivationOffset string `json:"nextActivationOffset,omitempty"` }
CreateWorkflowRequest is the payload for creating a workflow.
type RetryConfig ¶
type RetryConfig struct { MaxRetryCount int RetryIntervalMin time.Duration RetryIntervalMax time.Duration }
func (*RetryConfig) SlidingInterval ¶
func (rc *RetryConfig) SlidingInterval(retryNum int) time.Duration
create a function that is a sliding scale between the min and max based on the number of retries SlidingInterval returns a retry interval between min and max based on the current retry attempt.
type SearchWorkflowRequest ¶
type SearchWorkflowRequest struct { ID int64 `json:"id"` ExternalID string `json:"externalId"` ExecutorGroup string `json:"executorGroup"` WorkflowType string `json:"workflowType"` BusinessKey string `json:"businessKey"` State string `json:"state"` Status string `json:"status"` Limit int64 `json:"limit"` Offset int64 `json:"offset"` }
type SearchWorkflowResponse ¶
type UpdateStateVarRequest ¶ added in v1.0.11
type UpdateStateVarResponse ¶ added in v1.0.11
type UpdateStateVarResponse struct {
OK bool `json:"ok"`
}
type UpdateWorkflowStateAndWaitRequest ¶ added in v1.0.11
type UpdateWorkflowStateAndWaitRequest struct { UpdateWorkflowStateRequest UpdateWorkflowStateRequest `json:"updateWorkflowStateRequest"` UpdateStateVarRequest UpdateStateVarRequest `json:"updateStateVarRequest"` WaitSeconds int `json:"waitSeconds"` CheckSeconds int `json:"checkSeconds"` FromStates []string `json:"fromStates"` WaitForStates []string `json:"waitForStates"` }
type UpdateWorkflowStateRequest ¶ added in v1.0.11
type UpdateWorkflowStateResponse ¶ added in v1.0.11
type UpdateWorkflowStateResponse struct {
OK bool `json:"ok"`
}
type WorkflowApiResponse ¶ added in v1.0.11
type WorkflowApiResponse struct { ID int64 `json:"id"` Status string `json:"status"` ExecutionCount int `json:"executionCount"` RetryCount int `json:"retryCount"` Created time.Time `json:"created"` Modified time.Time `json:"modified"` NextActivation time.Time `json:"nextActivation,omitempty"` Started time.Time `json:"started,omitempty"` ExecutorID string `json:"executorId,omitempty"` ExecutorGroup string `json:"executorGroup"` WorkflowType string `json:"workflowType"` ExternalID string `json:"externalId"` BusinessKey string `json:"businessKey"` State string `json:"state"` StateVars map[string]string `json:"stateVars,omitempty"` }
WorkflowApiResponse represents the API response for a workflow.
type WorkflowState ¶
Click to show internal directories.
Click to hide internal directories.