api

Documentation

Index

• type ExternalTask
  • func (et ExternalTask) String() string
• type ExternalTaskHandler
• type ExternalTaskQueryRequest
• type ExternalTaskService
  • func (etc *ExternalTaskService) Complete(taskId string, variables map[string]interface{}) error
  • func (etc *ExternalTaskService) ErrorDetails(externalTask *ExternalTask) (string, error)
  • func (etc *ExternalTaskService) ExtendLock(externalTask *ExternalTask, newDuration time.Time) error
  • func (etc *ExternalTaskService) FetchAndLock(numOfTasks int, workerId string, topics []*Topic) error
  • func (etc *ExternalTaskService) Get(taskId string) (*ExternalTask, error)
  • func (etc *ExternalTaskService) GetList(query ExternalTaskQueryRequest) ([]*ExternalTask, error)
  • func (etc *ExternalTaskService) HandleBpmnError(externalTask *ExternalTask, errorCode string) error
  • func (etc *ExternalTaskService) HandleFailure(externalTask *ExternalTask, errorMessage string, errorDetails string, ...) error
  • func (etc *ExternalTaskService) Subscribe(topic string, customOptions map[string]interface{}, ...) (*TopicSubscription, error)
  • func (etc *ExternalTaskService) Unlock(externalTask *ExternalTask) error
  • func (etc *ExternalTaskService) Unsubscribe(topicSubscription *TopicSubscription) error
• type Topic
• type TopicSubscription

Types

type ExternalTask

type ExternalTask struct {
	Id                   *string `json:"id,omitempty"`
	ActivityId           *string `json:"activityId,omitempty"`
	ActivityInstanceId   *string `json:"activityInstanceId,omitempty"`
	ErrorMessage         *string `json:"errorMessage,omitempty"`
	ExecutionId          *string `json:"executionId,omitempty"`
	LockExpirationTime   *string `json:"lockExpirationTime,omitempty"`
	ProcessDefinitionId  *string `json:"processDefinitionId,omitempty"`
	ProcessDefinitionKey *string `json:"processDefinitionKey,omitempty"`
	ProcessInstanceId    *string `json:"processInstanceId,omitempty"`
	TenantId             *string `json:"tenantId,omitempty"`
	Retries              *int    `json:"retries,omitempty"`
	Suspended            *bool   `json:"suspended,omitempty"`
	WorkerId             *string `json:"workerId,omitempty"`
	Priority             *int    `json:"priority,omitempty"`
	TopicName            *string `json:"topicName,omitempty"`
}

func (ExternalTask) String

func (et ExternalTask) String() string

type ExternalTaskHandler

type ExternalTaskHandler func(externalTask ExternalTask, externalTaskService ExternalTaskService)

type ExternalTaskQueryRequest

type ExternalTaskQueryRequest struct {
	// contains filtered or unexported fields
}

ExternalTaskQueryRequest request DTO see https://docs.camunda.org/manual/develop/reference/rest/external-task/post-query/#request-body

type ExternalTaskService

type ExternalTaskService service

func (*ExternalTaskService) Complete

func (etc *ExternalTaskService) Complete(taskId string, variables map[string]interface{}) error

func (*ExternalTaskService) ErrorDetails

func (etc *ExternalTaskService) ErrorDetails(externalTask *ExternalTask) (string, error)

func (*ExternalTaskService) ExtendLock

func (etc *ExternalTaskService) ExtendLock(externalTask *ExternalTask, newDuration time.Time) error

func (*ExternalTaskService) FetchAndLock

func (etc *ExternalTaskService) FetchAndLock(numOfTasks int, workerId string, topics []*Topic) error

func (*ExternalTaskService) Get

func (etc *ExternalTaskService) Get(taskId string) (*ExternalTask, error)

func (*ExternalTaskService) GetList

func (etc *ExternalTaskService) GetList(query ExternalTaskQueryRequest) ([]*ExternalTask, error)

func (*ExternalTaskService) HandleBpmnError

func (etc *ExternalTaskService) HandleBpmnError(externalTask *ExternalTask, errorCode string) error

func (*ExternalTaskService) HandleFailure

func (etc *ExternalTaskService) HandleFailure(externalTask *ExternalTask, errorMessage string, errorDetails string, retries int, retryTimeout time.Time) error

func (*ExternalTaskService) Subscribe

func (etc *ExternalTaskService) Subscribe(topic string, customOptions map[string]interface{}, taskHandler ExternalTaskHandler) (*TopicSubscription, error)

func (*ExternalTaskService) Unlock

func (etc *ExternalTaskService) Unlock(externalTask *ExternalTask) error

func (*ExternalTaskService) Unsubscribe

func (etc *ExternalTaskService) Unsubscribe(topicSubscription *TopicSubscription) error

type Topic

type Topic struct {
	// contains filtered or unexported fields
}

type TopicSubscription

type TopicSubscription struct {
	TopicName    string
	WorkerId     string
	LockDuration time.Time
	TaskHandler  *ExternalTaskHandler
}