Documentation ¶
Index ¶
- Constants
- Variables
- type CaseDefinition
- func (c *CaseDefinition) GetCategory() string
- func (c *CaseDefinition) GetDeploymentId() string
- func (c *CaseDefinition) GetHistoryTimeToLive() int
- func (c *CaseDefinition) GetId() string
- func (c *CaseDefinition) GetKey() string
- func (c *CaseDefinition) GetName() string
- func (c *CaseDefinition) GetResource() string
- func (c *CaseDefinition) GetTenantId() string
- func (c *CaseDefinition) GetVersion() int
- func (c CaseDefinition) String() string
- type Client
- type ClientOption
- type CountResult
- type DecisionDefinition
- func (d *DecisionDefinition) GetCategory() string
- func (d *DecisionDefinition) GetDecisionRequirementsDefinitionId() string
- func (d *DecisionDefinition) GetDecisionRequirementsDefinitionKey() string
- func (d *DecisionDefinition) GetDeploymentId() string
- func (d *DecisionDefinition) GetHistoryTimeToLive() int
- func (d *DecisionDefinition) GetId() string
- func (d *DecisionDefinition) GetKey() string
- func (d *DecisionDefinition) GetName() string
- func (d *DecisionDefinition) GetResource() string
- func (d *DecisionDefinition) GetTenantId() string
- func (d *DecisionDefinition) GetVersion() int
- func (d *DecisionDefinition) GetVersionTag() string
- func (d DecisionDefinition) String() string
- type DecisionRequirementsDefinition
- func (d *DecisionRequirementsDefinition) GetCategory() string
- func (d *DecisionRequirementsDefinition) GetDeploymentId() string
- func (d *DecisionRequirementsDefinition) GetId() string
- func (d *DecisionRequirementsDefinition) GetKey() string
- func (d *DecisionRequirementsDefinition) GetName() string
- func (d *DecisionRequirementsDefinition) GetResource() string
- func (d *DecisionRequirementsDefinition) GetTenantId() string
- func (d *DecisionRequirementsDefinition) GetVersion() int
- func (d DecisionRequirementsDefinition) String() string
- type Deployment
- type DeploymentCreateRequest
- func (d *DeploymentCreateRequest) GetDeployChangedOnly() bool
- func (d *DeploymentCreateRequest) GetDeploymentName() string
- func (d *DeploymentCreateRequest) GetDeploymentSource() string
- func (d *DeploymentCreateRequest) GetEnableDuplicateFiltering() bool
- func (d *DeploymentCreateRequest) GetTenantId() string
- type DeploymentGetRequest
- func (d *DeploymentGetRequest) GetAfter() time.Time
- func (d *DeploymentGetRequest) GetBefore() time.Time
- func (d *DeploymentGetRequest) GetFirstResult() int
- func (d *DeploymentGetRequest) GetId() string
- func (d *DeploymentGetRequest) GetIncludeDeploymentsWithoutTenantId() bool
- func (d *DeploymentGetRequest) GetMaxResults() int
- func (d *DeploymentGetRequest) GetName() string
- func (d *DeploymentGetRequest) GetNameLike() string
- func (d *DeploymentGetRequest) GetSortBy() string
- func (d *DeploymentGetRequest) GetSortOrder() string
- func (d *DeploymentGetRequest) GetSource() string
- func (d *DeploymentGetRequest) GetWithoutSource() string
- func (d *DeploymentGetRequest) GetWithoutTentantId() bool
- type DeploymentService
- type Engine
- type EngineService
- type ExternalTaskClientError
- type GetMetricsRequestDto
- type HttpConfiguration
- type Incident
- func (i *Incident) GetActivityId() string
- func (i *Incident) GetCauseIncidentId() string
- func (i *Incident) GetConfiguration() string
- func (i *Incident) GetExecutionId() string
- func (i *Incident) GetId() string
- func (i *Incident) GetIncidentMessage() string
- func (i *Incident) GetIncidentTimestamp() time.Time
- func (i *Incident) GetIncidentType() string
- func (i *Incident) GetJobDefinitionId() string
- func (i *Incident) GetProcessDefinitionId() string
- func (i *Incident) GetProcessInstanceId() string
- func (i *Incident) GetRootCauseIncidentId() string
- func (i *Incident) GetTenantId() string
- func (i Incident) String() string
- type IncidentService
- type Link
- type Metrics
- type MetricsService
- type PaginationQueryParams
- type ProcessDefinition
- func (p *ProcessDefinition) GetCategory() string
- func (p *ProcessDefinition) GetDeploymentId() string
- func (p *ProcessDefinition) GetDescription() string
- func (p *ProcessDefinition) GetDiagram() string
- func (p *ProcessDefinition) GetHistoryTimeToLive() int
- func (p *ProcessDefinition) GetId() string
- func (p *ProcessDefinition) GetKey() string
- func (p *ProcessDefinition) GetName() string
- func (p *ProcessDefinition) GetResource() string
- func (p *ProcessDefinition) GetSuspended() bool
- func (p *ProcessDefinition) GetTenantId() string
- func (p *ProcessDefinition) GetVersion() int
- func (p *ProcessDefinition) GetVersionTag() string
- func (p ProcessDefinition) String() string
- type ProcessDefinitionService
- func (pdc *ProcessDefinitionService) Delete(id string) error
- func (pdc ProcessDefinitionService) GetList() ([]*ProcessDefinition, error)
- func (pdc ProcessDefinitionService) Start() *StartProcessDefinitionBuilder
- func (pdc ProcessDefinitionService) StartProcessInstanceById(id string) *ProcessDefinition
- func (pdc ProcessDefinitionService) StartProcessInstanceByKey(key string) *ProcessDefinition
- type ProcessInstance
- func (p *ProcessInstance) GetBusinessKey() string
- func (p *ProcessInstance) GetCaseInstanceId() string
- func (p *ProcessInstance) GetDefinitionId() string
- func (p *ProcessInstance) GetEnded() bool
- func (p *ProcessInstance) GetId() string
- func (p *ProcessInstance) GetSuspended() bool
- func (p *ProcessInstance) GetTenantId() string
- func (pi ProcessInstance) String() string
- type ProcessInstanceQueryBuilder
- func (pdb *ProcessInstanceQueryBuilder) ById(id string) *ProcessInstanceQueryBuilder
- func (pdb *ProcessInstanceQueryBuilder) ByKey(id string) *ProcessInstanceQueryBuilder
- func (pdb *ProcessInstanceQueryBuilder) ByMessage(messageName string) *ProcessInstanceQueryBuilder
- func (pdb *ProcessInstanceQueryBuilder) WithBusinessKey(businessKey string) *ProcessInstanceQueryBuilder
- func (pdb *ProcessInstanceQueryBuilder) WithVariables(variables *Variables) *ProcessInstanceQueryBuilder
- type ProcessInstanceService
- type ProcessInstanceSort
- type ProcessInstanceSortOption
- type ProcessInstanceVariableQuery
- type ProcessInstanceVariableQueryOperator
- type RequestInterceptor
- type SortOption
- type SortOrder
- type StartProcessDefinitionBuilder
- func (pdb *StartProcessDefinitionBuilder) ById(id string) *StartProcessDefinitionBuilder
- func (pdb *StartProcessDefinitionBuilder) ByKey(id string) *StartProcessDefinitionBuilder
- func (pdb *StartProcessDefinitionBuilder) ByMessage(messageName string) *StartProcessDefinitionBuilder
- func (pdb *StartProcessDefinitionBuilder) Now() *ProcessInstance
- func (pdb *StartProcessDefinitionBuilder) WithBusinessKey(businessKey string) *StartProcessDefinitionBuilder
- func (pdb *StartProcessDefinitionBuilder) WithVariables(variables *Variables) *StartProcessDefinitionBuilder
- type ValueInfo
- type Variable
- type VariableBuilder
- type Variables
Constants ¶
const ( Version = "0.1.0-dev" ContentTypeJson = "application/json" DefaultUserAgent = "camunda-rest-httpClient-go/" + Version DefaultBaseEndpoint = "http://localhost:8080/engine-rest" // DefaultDateTimeFormat: see https://docs.camunda.org/manual/7.8/reference/rest/overview/date-format/ DefaultDateTimeFormat = "2006-01-02T15:04:05.000-0700" DefaultMaxTasks = 10 DefaultPollingDelay = 30 * time.Second DefaultPollingDuration = 60 * time.Second DefaultRetryAttempts = 3 DefaultRetryDuration = 30 * time.Second )
const ( MetricActivityInstanceStart = "activity-instance-start" MetricActivityInstanceEnd = "activity-instance-end" MetricJobAcquisitionAttempt = "job-acquisition-attempt" MetricJobAcquiredSuccess = "job-acquired-success" MetricJobAcquiredFailure = "job-acquired-failure" MetricJobExecutionRejected = "job-execution-rejected" MetricJobSuccessful = "job-successful" MetricJobFailed = "job-failed" MetricJobLockedExclusive = "job-locked-exclusive" MetricExecutedDecisionElements = "executed-decision-elements" MetricHistoryCleanupRemovedProcessInstances = "history-cleanup-removed-process-instances" MetricHistoryCleanupRemovedCaseInstances = "history-cleanup-removed-case-instances" MetricHistoryCleanupRemovedDecisionInstances = "history-cleanup-removed-decision-instances" MetricHistoryCleanupRemovedBatchOperations = "history-cleanup-removed-batch-operations" )
Variables ¶
var ExternalTaskConnectionLostError = newExternalTaskClientError("", 0, nil)
var ExternalTaskNotAcquiredError = newExternalTaskClientError("", 0, nil)
var ExternalTaskNotFoundError = newExternalTaskClientError("External task with id '%s' could not be found.", 404, nil)
ExternalTaskNotFoundError is used when the Camunda REST API returns with 404 TODO: incorporate TaskId or something from query into it
Functions ¶
This section is empty.
Types ¶
type CaseDefinition ¶
type CaseDefinition struct { Id *string `json:"id,omitempty"` Key *string `json:"key,omitempty"` Category *string `json:"category,omitempty"` Name *string `json:"name,omitempty"` Version *int `json:"Version,omitempty"` Resource *string `json:"resource,omitempty"` DeploymentId *string `json:"deploymentId,omitempty"` TenantId *string `json:"tenantId,omitempty"` HistoryTimeToLive *int `json:"historyTimeToLive,omitempty"` // days }
https://docs.camunda.org/manual/7.8/reference/rest/case-definition/get/#result https://github.com/camunda/camunda-bpm-platform/blob/master/engine-rest/engine-rest/src/main/java/org/camunda/bpm/engine/rest/dto/repository/CaseDefinitionDto.java
func (*CaseDefinition) GetCategory ¶
func (c *CaseDefinition) GetCategory() string
GetCategory returns the Category field if it's non-nil, zero value otherwise.
func (*CaseDefinition) GetDeploymentId ¶
func (c *CaseDefinition) GetDeploymentId() string
GetDeploymentId returns the DeploymentId field if it's non-nil, zero value otherwise.
func (*CaseDefinition) GetHistoryTimeToLive ¶
func (c *CaseDefinition) GetHistoryTimeToLive() int
GetHistoryTimeToLive returns the HistoryTimeToLive field if it's non-nil, zero value otherwise.
func (*CaseDefinition) GetId ¶
func (c *CaseDefinition) GetId() string
GetId returns the Id field if it's non-nil, zero value otherwise.
func (*CaseDefinition) GetKey ¶
func (c *CaseDefinition) GetKey() string
GetKey returns the Key field if it's non-nil, zero value otherwise.
func (*CaseDefinition) GetName ¶
func (c *CaseDefinition) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*CaseDefinition) GetResource ¶
func (c *CaseDefinition) GetResource() string
GetResource returns the Resource field if it's non-nil, zero value otherwise.
func (*CaseDefinition) GetTenantId ¶
func (c *CaseDefinition) GetTenantId() string
GetTenantId returns the TenantId field if it's non-nil, zero value otherwise.
func (*CaseDefinition) GetVersion ¶
func (c *CaseDefinition) GetVersion() int
GetVersion returns the Version field if it's non-nil, zero value otherwise.
func (CaseDefinition) String ¶
func (c CaseDefinition) String() string
type Client ¶
type Client struct { Deployments *DeploymentService ExternalTasks *api.ExternalTaskService Incidents *IncidentService Metrics *MetricsService ProcessDefinitions *ProcessDefinitionService ProcessInstances *ProcessInstanceService // contains filtered or unexported fields }
type ClientOption ¶
type ClientOption interface {
Apply(configuration *HttpConfiguration)
}
type DecisionDefinition ¶
type DecisionDefinition struct { Id *string `json:"id,omitempty"` Key *string `json:"key,omitempty"` Category *string `json:"category,omitempty"` Name *string `json:"name,omitempty"` Version *int `json:"Version,omitempty"` Resource *string `json:"resource,omitempty"` DeploymentId *string `json:"deploymentId,omitempty"` TenantId *string `json:"tenantId,omitempty"` DecisionRequirementsDefinitionId *string `json:"decisionRequirementsDefinitionId,omitempty"` DecisionRequirementsDefinitionKey *string `json:"decisionRequirementsDefinitionKey,omitempty"` VersionTag *string `json:"versionTag,omitempty"` HistoryTimeToLive *int `json:"historyTimeToLive,omitempty"` // days }
https://docs.camunda.org/manual/7.8/reference/rest/decision-definition/get/#result https://github.com/camunda/camunda-bpm-platform/blob/master/engine-rest/engine-rest/src/main/java/org/camunda/bpm/engine/rest/dto/repository/DecisionDefinitionDto.java
func (*DecisionDefinition) GetCategory ¶
func (d *DecisionDefinition) GetCategory() string
GetCategory returns the Category field if it's non-nil, zero value otherwise.
func (*DecisionDefinition) GetDecisionRequirementsDefinitionId ¶
func (d *DecisionDefinition) GetDecisionRequirementsDefinitionId() string
GetDecisionRequirementsDefinitionId returns the DecisionRequirementsDefinitionId field if it's non-nil, zero value otherwise.
func (*DecisionDefinition) GetDecisionRequirementsDefinitionKey ¶
func (d *DecisionDefinition) GetDecisionRequirementsDefinitionKey() string
GetDecisionRequirementsDefinitionKey returns the DecisionRequirementsDefinitionKey field if it's non-nil, zero value otherwise.
func (*DecisionDefinition) GetDeploymentId ¶
func (d *DecisionDefinition) GetDeploymentId() string
GetDeploymentId returns the DeploymentId field if it's non-nil, zero value otherwise.
func (*DecisionDefinition) GetHistoryTimeToLive ¶
func (d *DecisionDefinition) GetHistoryTimeToLive() int
GetHistoryTimeToLive returns the HistoryTimeToLive field if it's non-nil, zero value otherwise.
func (*DecisionDefinition) GetId ¶
func (d *DecisionDefinition) GetId() string
GetId returns the Id field if it's non-nil, zero value otherwise.
func (*DecisionDefinition) GetKey ¶
func (d *DecisionDefinition) GetKey() string
GetKey returns the Key field if it's non-nil, zero value otherwise.
func (*DecisionDefinition) GetName ¶
func (d *DecisionDefinition) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*DecisionDefinition) GetResource ¶
func (d *DecisionDefinition) GetResource() string
GetResource returns the Resource field if it's non-nil, zero value otherwise.
func (*DecisionDefinition) GetTenantId ¶
func (d *DecisionDefinition) GetTenantId() string
GetTenantId returns the TenantId field if it's non-nil, zero value otherwise.
func (*DecisionDefinition) GetVersion ¶
func (d *DecisionDefinition) GetVersion() int
GetVersion returns the Version field if it's non-nil, zero value otherwise.
func (*DecisionDefinition) GetVersionTag ¶
func (d *DecisionDefinition) GetVersionTag() string
GetVersionTag returns the VersionTag field if it's non-nil, zero value otherwise.
func (DecisionDefinition) String ¶
func (d DecisionDefinition) String() string
type DecisionRequirementsDefinition ¶
type DecisionRequirementsDefinition struct { Id *string `json:"id,omitempty"` Key *string `json:"key,omitempty"` Category *string `json:"category,omitempty"` Name *string `json:"name,omitempty"` Version *int `json:"Version,omitempty"` Resource *string `json:"resource,omitempty"` DeploymentId *string `json:"deploymentId,omitempty"` TenantId *string `json:"tenantId,omitempty"` }
https://docs.camunda.org/manual/7.8/reference/rest/decision-requirements-definition/get/#result https://github.com/camunda/camunda-bpm-platform/blob/master/engine-rest/engine-rest/src/main/java/org/camunda/bpm/engine/rest/dto/repository/DecisionRequirementsDefinitionDto.java
func (*DecisionRequirementsDefinition) GetCategory ¶
func (d *DecisionRequirementsDefinition) GetCategory() string
GetCategory returns the Category field if it's non-nil, zero value otherwise.
func (*DecisionRequirementsDefinition) GetDeploymentId ¶
func (d *DecisionRequirementsDefinition) GetDeploymentId() string
GetDeploymentId returns the DeploymentId field if it's non-nil, zero value otherwise.
func (*DecisionRequirementsDefinition) GetId ¶
func (d *DecisionRequirementsDefinition) GetId() string
GetId returns the Id field if it's non-nil, zero value otherwise.
func (*DecisionRequirementsDefinition) GetKey ¶
func (d *DecisionRequirementsDefinition) GetKey() string
GetKey returns the Key field if it's non-nil, zero value otherwise.
func (*DecisionRequirementsDefinition) GetName ¶
func (d *DecisionRequirementsDefinition) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*DecisionRequirementsDefinition) GetResource ¶
func (d *DecisionRequirementsDefinition) GetResource() string
GetResource returns the Resource field if it's non-nil, zero value otherwise.
func (*DecisionRequirementsDefinition) GetTenantId ¶
func (d *DecisionRequirementsDefinition) GetTenantId() string
GetTenantId returns the TenantId field if it's non-nil, zero value otherwise.
func (*DecisionRequirementsDefinition) GetVersion ¶
func (d *DecisionRequirementsDefinition) GetVersion() int
GetVersion returns the Version field if it's non-nil, zero value otherwise.
func (DecisionRequirementsDefinition) String ¶
func (d DecisionRequirementsDefinition) String() string
type Deployment ¶
type Deployment struct { Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Source *string `json:"source,omitempty"` TenantId *string `json:"tenant_id,omitempty"` DeploymentTime *time.Time `json:"deployment_time,omitempty"` Links []*Link `json:"links,omitempty"` DeployedProcessDefinitions map[string]*ProcessDefinition `json:"deployedProcessDefinitions,omitempty"` DeployedCaseDefinitions map[string]*CaseDefinition `json:"deployedCaseDefinitions,omitempty"` DeployedDecisionDefinitions map[string]*DecisionDefinition `json:"deployedDecisionDefinitions,omitempty"` DeployedDecisionRequirementsDefinitions map[string]*DecisionRequirementsDefinition `json:"deployedDecisionRequirementsDefinitions,omitempty"` }
func (*Deployment) GetDeploymentTime ¶
func (d *Deployment) GetDeploymentTime() time.Time
GetDeploymentTime returns the DeploymentTime field if it's non-nil, zero value otherwise.
func (*Deployment) GetId ¶
func (d *Deployment) GetId() string
GetId returns the Id field if it's non-nil, zero value otherwise.
func (*Deployment) GetName ¶
func (d *Deployment) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*Deployment) GetSource ¶
func (d *Deployment) GetSource() string
GetSource returns the Source field if it's non-nil, zero value otherwise.
func (*Deployment) GetTenantId ¶
func (d *Deployment) GetTenantId() string
GetTenantId returns the TenantId field if it's non-nil, zero value otherwise.
func (Deployment) String ¶
func (d Deployment) String() string
type DeploymentCreateRequest ¶
type DeploymentCreateRequest struct { DeploymentName *string EnableDuplicateFiltering *bool DeployChangedOnly *bool DeploymentSource *string TenantId *string Resources map[string]interface{} }
func (*DeploymentCreateRequest) GetDeployChangedOnly ¶
func (d *DeploymentCreateRequest) GetDeployChangedOnly() bool
GetDeployChangedOnly returns the DeployChangedOnly field if it's non-nil, zero value otherwise.
func (*DeploymentCreateRequest) GetDeploymentName ¶
func (d *DeploymentCreateRequest) GetDeploymentName() string
GetDeploymentName returns the DeploymentName field if it's non-nil, zero value otherwise.
func (*DeploymentCreateRequest) GetDeploymentSource ¶
func (d *DeploymentCreateRequest) GetDeploymentSource() string
GetDeploymentSource returns the DeploymentSource field if it's non-nil, zero value otherwise.
func (*DeploymentCreateRequest) GetEnableDuplicateFiltering ¶
func (d *DeploymentCreateRequest) GetEnableDuplicateFiltering() bool
GetEnableDuplicateFiltering returns the EnableDuplicateFiltering field if it's non-nil, zero value otherwise.
func (*DeploymentCreateRequest) GetTenantId ¶
func (d *DeploymentCreateRequest) GetTenantId() string
GetTenantId returns the TenantId field if it's non-nil, zero value otherwise.
type DeploymentGetRequest ¶
type DeploymentGetRequest struct { Id *string Name *string NameLike *string Source *string WithoutSource *string TenantIdIn []*string WithoutTentantId *bool IncludeDeploymentsWithoutTenantId *bool After *time.Time Before *time.Time SortBy *string // id / name / deploymentTime / tenantId SortOrder *string // asc / desc FirstResult *int MaxResults *int }
func (*DeploymentGetRequest) GetAfter ¶
func (d *DeploymentGetRequest) GetAfter() time.Time
GetAfter returns the After field if it's non-nil, zero value otherwise.
func (*DeploymentGetRequest) GetBefore ¶
func (d *DeploymentGetRequest) GetBefore() time.Time
GetBefore returns the Before field if it's non-nil, zero value otherwise.
func (*DeploymentGetRequest) GetFirstResult ¶
func (d *DeploymentGetRequest) GetFirstResult() int
GetFirstResult returns the FirstResult field if it's non-nil, zero value otherwise.
func (*DeploymentGetRequest) GetId ¶
func (d *DeploymentGetRequest) GetId() string
GetId returns the Id field if it's non-nil, zero value otherwise.
func (*DeploymentGetRequest) GetIncludeDeploymentsWithoutTenantId ¶
func (d *DeploymentGetRequest) GetIncludeDeploymentsWithoutTenantId() bool
GetIncludeDeploymentsWithoutTenantId returns the IncludeDeploymentsWithoutTenantId field if it's non-nil, zero value otherwise.
func (*DeploymentGetRequest) GetMaxResults ¶
func (d *DeploymentGetRequest) GetMaxResults() int
GetMaxResults returns the MaxResults field if it's non-nil, zero value otherwise.
func (*DeploymentGetRequest) GetName ¶
func (d *DeploymentGetRequest) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*DeploymentGetRequest) GetNameLike ¶
func (d *DeploymentGetRequest) GetNameLike() string
GetNameLike returns the NameLike field if it's non-nil, zero value otherwise.
func (*DeploymentGetRequest) GetSortBy ¶
func (d *DeploymentGetRequest) GetSortBy() string
GetSortBy returns the SortBy field if it's non-nil, zero value otherwise.
func (*DeploymentGetRequest) GetSortOrder ¶
func (d *DeploymentGetRequest) GetSortOrder() string
GetSortOrder returns the SortOrder field if it's non-nil, zero value otherwise.
func (*DeploymentGetRequest) GetSource ¶
func (d *DeploymentGetRequest) GetSource() string
GetSource returns the Source field if it's non-nil, zero value otherwise.
func (*DeploymentGetRequest) GetWithoutSource ¶
func (d *DeploymentGetRequest) GetWithoutSource() string
GetWithoutSource returns the WithoutSource field if it's non-nil, zero value otherwise.
func (*DeploymentGetRequest) GetWithoutTentantId ¶
func (d *DeploymentGetRequest) GetWithoutTentantId() bool
GetWithoutTentantId returns the WithoutTentantId field if it's non-nil, zero value otherwise.
type DeploymentService ¶
type DeploymentService service
func (*DeploymentService) Create ¶
func (dc *DeploymentService) Create(createDeployment *DeploymentCreateRequest) (*Deployment, error)
func (*DeploymentService) Delete ¶
func (dc *DeploymentService) Delete(id string, optional map[string]interface{}) error
* Deletes Deployment with ID * @param id * @param optional (nil or map[string]interface{}) with one or more of: * @param "cascade" (bool) * @param "skipCustomListeners" (bool) * @param "skipIoMappings" (bool) * @return error (nil or error)
func (*DeploymentService) GetList ¶
func (dc *DeploymentService) GetList(queryParams *DeploymentGetRequest) ([]*Deployment, error)
type Engine ¶
type Engine struct {
Name *string `json:"name,omitempty"`
}
type EngineService ¶
type EngineService service
func (*EngineService) GetList ¶
func (ec *EngineService) GetList() ([]*Engine, error)
type ExternalTaskClientError ¶
type ExternalTaskClientError struct {
// contains filtered or unexported fields
}
func (*ExternalTaskClientError) Error ¶
func (e *ExternalTaskClientError) Error() string
type GetMetricsRequestDto ¶
type GetMetricsRequestDto struct { Id string Name string NameLike string Source string WithoutSource string TenantIdIn []string WithoutTentantId bool IncludeDeploymentsWithoutTenantId bool After time.Time Before time.Time SortBy string // id / name / deploymentTime / tenantId SortOrder string // asc / desc FirstResult int MaxResults int }
type HttpConfiguration ¶
type Incident ¶
type Incident struct { Id *string `json:"id,omitempty"` ProcessDefinitionId *string `json:"processDefinitionId,omitempty"` ProcessInstanceId *string `json:"processInstanceId,omitempty"` ExecutionId *string `json:"executionId,omitempty"` IncidentTimestamp *time.Time `json:"incidentTimestamp,omitempty"` IncidentType *string `json:"incidentType,omitempty"` // https://docs.camunda.org/manual/7.8/user-guide/process-engine/incidents/#incident-types ActivityId *string `json:"activityId,omitempty"` CauseIncidentId *string `json:"causeIncidentId,omitempty"` RootCauseIncidentId *string `json:"rootCauseIncidentId,omitempty"` Configuration *string `json:"configuration,omitempty"` TenantId *string `json:"tenantId,omitempty"` IncidentMessage *string `json:"incidentMessage,omitempty"` JobDefinitionId *string `json:"jobDefinitionId,omitempty"` }
func (*Incident) GetActivityId ¶
GetActivityId returns the ActivityId field if it's non-nil, zero value otherwise.
func (*Incident) GetCauseIncidentId ¶
GetCauseIncidentId returns the CauseIncidentId field if it's non-nil, zero value otherwise.
func (*Incident) GetConfiguration ¶
GetConfiguration returns the Configuration field if it's non-nil, zero value otherwise.
func (*Incident) GetExecutionId ¶
GetExecutionId returns the ExecutionId field if it's non-nil, zero value otherwise.
func (*Incident) GetIncidentMessage ¶
GetIncidentMessage returns the IncidentMessage field if it's non-nil, zero value otherwise.
func (*Incident) GetIncidentTimestamp ¶
GetIncidentTimestamp returns the IncidentTimestamp field if it's non-nil, zero value otherwise.
func (*Incident) GetIncidentType ¶
GetIncidentType returns the IncidentType field if it's non-nil, zero value otherwise.
func (*Incident) GetJobDefinitionId ¶
GetJobDefinitionId returns the JobDefinitionId field if it's non-nil, zero value otherwise.
func (*Incident) GetProcessDefinitionId ¶
GetProcessDefinitionId returns the ProcessDefinitionId field if it's non-nil, zero value otherwise.
func (*Incident) GetProcessInstanceId ¶
GetProcessInstanceId returns the ProcessInstanceId field if it's non-nil, zero value otherwise.
func (*Incident) GetRootCauseIncidentId ¶
GetRootCauseIncidentId returns the RootCauseIncidentId field if it's non-nil, zero value otherwise.
func (*Incident) GetTenantId ¶
GetTenantId returns the TenantId field if it's non-nil, zero value otherwise.
type IncidentService ¶
type IncidentService service
func (*IncidentService) Delete ¶
func (ic *IncidentService) Delete(id string) error
func (*IncidentService) GetCount ¶
func (ic *IncidentService) GetCount() (int, error)
func (*IncidentService) GetList ¶
func (ic *IncidentService) GetList() ([]*Incident, error)
type Link ¶
type Link struct { Method *string `json:"method,omitempty"` Href *string `json:"href,omitempty"` Rel *string `json:"rel,omitempty"` }
type Metrics ¶
type Metrics struct { Timestamp *time.Time `json:"timestamp,omitempty"` Name *string `json:"name,omitempty"` Reporter *string `json:"reporter,omitempty"` Value *int `json:"value,omitempty"` }
func (*Metrics) GetReporter ¶
GetReporter returns the Reporter field if it's non-nil, zero value otherwise.
func (*Metrics) GetTimestamp ¶
GetTimestamp returns the Timestamp field if it's non-nil, zero value otherwise.
type MetricsService ¶
type MetricsService service
type PaginationQueryParams ¶
type PaginationQueryParams struct {
// contains filtered or unexported fields
}
type ProcessDefinition ¶
type ProcessDefinition struct { Id *string `json:"id,omitempty"` Key *string `json:"key,omitempty"` Category *string `json:"category,omitempty"` Description *string `json:"description,omitempty"` Name *string `json:"name,omitempty"` Version *int `json:"Version,omitempty"` Resource *string `json:"resource,omitempty"` DeploymentId *string `json:"deploymentId,omitempty"` Diagram *string `json:"diagram,omitempty"` Suspended *bool `json:"suspended,omitempty"` TenantId *string `json:"tenantId,omitempty"` VersionTag *string `json:"versionTag,omitempty"` HistoryTimeToLive *int `json:"historyTimeToLive,omitempty"` // days }
func (*ProcessDefinition) GetCategory ¶
func (p *ProcessDefinition) GetCategory() string
GetCategory returns the Category field if it's non-nil, zero value otherwise.
func (*ProcessDefinition) GetDeploymentId ¶
func (p *ProcessDefinition) GetDeploymentId() string
GetDeploymentId returns the DeploymentId field if it's non-nil, zero value otherwise.
func (*ProcessDefinition) GetDescription ¶
func (p *ProcessDefinition) GetDescription() string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (*ProcessDefinition) GetDiagram ¶
func (p *ProcessDefinition) GetDiagram() string
GetDiagram returns the Diagram field if it's non-nil, zero value otherwise.
func (*ProcessDefinition) GetHistoryTimeToLive ¶
func (p *ProcessDefinition) GetHistoryTimeToLive() int
GetHistoryTimeToLive returns the HistoryTimeToLive field if it's non-nil, zero value otherwise.
func (*ProcessDefinition) GetId ¶
func (p *ProcessDefinition) GetId() string
GetId returns the Id field if it's non-nil, zero value otherwise.
func (*ProcessDefinition) GetKey ¶
func (p *ProcessDefinition) GetKey() string
GetKey returns the Key field if it's non-nil, zero value otherwise.
func (*ProcessDefinition) GetName ¶
func (p *ProcessDefinition) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*ProcessDefinition) GetResource ¶
func (p *ProcessDefinition) GetResource() string
GetResource returns the Resource field if it's non-nil, zero value otherwise.
func (*ProcessDefinition) GetSuspended ¶
func (p *ProcessDefinition) GetSuspended() bool
GetSuspended returns the Suspended field if it's non-nil, zero value otherwise.
func (*ProcessDefinition) GetTenantId ¶
func (p *ProcessDefinition) GetTenantId() string
GetTenantId returns the TenantId field if it's non-nil, zero value otherwise.
func (*ProcessDefinition) GetVersion ¶
func (p *ProcessDefinition) GetVersion() int
GetVersion returns the Version field if it's non-nil, zero value otherwise.
func (*ProcessDefinition) GetVersionTag ¶
func (p *ProcessDefinition) GetVersionTag() string
GetVersionTag returns the VersionTag field if it's non-nil, zero value otherwise.
func (ProcessDefinition) String ¶
func (p ProcessDefinition) String() string
type ProcessDefinitionService ¶
type ProcessDefinitionService service
func (*ProcessDefinitionService) Delete ¶
func (pdc *ProcessDefinitionService) Delete(id string) error
func (ProcessDefinitionService) GetList ¶
func (pdc ProcessDefinitionService) GetList() ([]*ProcessDefinition, error)
func (ProcessDefinitionService) Start ¶
func (pdc ProcessDefinitionService) Start() *StartProcessDefinitionBuilder
func (ProcessDefinitionService) StartProcessInstanceById ¶
func (pdc ProcessDefinitionService) StartProcessInstanceById(id string) *ProcessDefinition
func (ProcessDefinitionService) StartProcessInstanceByKey ¶
func (pdc ProcessDefinitionService) StartProcessInstanceByKey(key string) *ProcessDefinition
type ProcessInstance ¶
type ProcessInstance struct { Id *string `json:"id,omitempty"` DefinitionId *string `json:"definitionId,omitempty"` BusinessKey *string `json:"businessKey,omitempty"` CaseInstanceId *string `json:"caseInstanceId,omitempty"` Ended *bool `json:"ended,omitempty"` Suspended *bool `json:"suspended,omitempty"` TenantId *string `json:"tenantId,omitempty"` Links []*Link `json:"links,omitempty"` }
func (*ProcessInstance) GetBusinessKey ¶
func (p *ProcessInstance) GetBusinessKey() string
GetBusinessKey returns the BusinessKey field if it's non-nil, zero value otherwise.
func (*ProcessInstance) GetCaseInstanceId ¶
func (p *ProcessInstance) GetCaseInstanceId() string
GetCaseInstanceId returns the CaseInstanceId field if it's non-nil, zero value otherwise.
func (*ProcessInstance) GetDefinitionId ¶
func (p *ProcessInstance) GetDefinitionId() string
GetDefinitionId returns the DefinitionId field if it's non-nil, zero value otherwise.
func (*ProcessInstance) GetEnded ¶
func (p *ProcessInstance) GetEnded() bool
GetEnded returns the Ended field if it's non-nil, zero value otherwise.
func (*ProcessInstance) GetId ¶
func (p *ProcessInstance) GetId() string
GetId returns the Id field if it's non-nil, zero value otherwise.
func (*ProcessInstance) GetSuspended ¶
func (p *ProcessInstance) GetSuspended() bool
GetSuspended returns the Suspended field if it's non-nil, zero value otherwise.
func (*ProcessInstance) GetTenantId ¶
func (p *ProcessInstance) GetTenantId() string
GetTenantId returns the TenantId field if it's non-nil, zero value otherwise.
func (ProcessInstance) String ¶
func (pi ProcessInstance) String() string
type ProcessInstanceQueryBuilder ¶
type ProcessInstanceQueryBuilder struct {
// contains filtered or unexported fields
}
func (*ProcessInstanceQueryBuilder) ById ¶
func (pdb *ProcessInstanceQueryBuilder) ById(id string) *ProcessInstanceQueryBuilder
func (*ProcessInstanceQueryBuilder) ByKey ¶
func (pdb *ProcessInstanceQueryBuilder) ByKey(id string) *ProcessInstanceQueryBuilder
func (*ProcessInstanceQueryBuilder) ByMessage ¶
func (pdb *ProcessInstanceQueryBuilder) ByMessage(messageName string) *ProcessInstanceQueryBuilder
func (*ProcessInstanceQueryBuilder) WithBusinessKey ¶
func (pdb *ProcessInstanceQueryBuilder) WithBusinessKey(businessKey string) *ProcessInstanceQueryBuilder
func (*ProcessInstanceQueryBuilder) WithVariables ¶
func (pdb *ProcessInstanceQueryBuilder) WithVariables(variables *Variables) *ProcessInstanceQueryBuilder
type ProcessInstanceService ¶
type ProcessInstanceService service
func (*ProcessInstanceService) Delete ¶
func (pdc *ProcessInstanceService) Delete(id string) error
func (ProcessInstanceService) GetList ¶
func (pdc ProcessInstanceService) GetList() ([]*ProcessInstance, error)
func (ProcessInstanceService) GetListByQuery ¶
func (pdc ProcessInstanceService) GetListByQuery() *ProcessInstanceQueryBuilder
type ProcessInstanceSort ¶
type ProcessInstanceSort struct {
// contains filtered or unexported fields
}
type ProcessInstanceSortOption ¶
type ProcessInstanceSortOption SortOption
const ( BusinessKey ProcessInstanceSortOption = "businessKey" InstanceId ProcessInstanceSortOption = "instanceId" DefinitionId ProcessInstanceSortOption = "definitionId" DefinitionKey ProcessInstanceSortOption = "definitionKey" TenantId ProcessInstanceSortOption = "tenantId" )
type ProcessInstanceVariableQuery ¶
type ProcessInstanceVariableQuery struct {
// contains filtered or unexported fields
}
type ProcessInstanceVariableQueryOperator ¶
type ProcessInstanceVariableQueryOperator string
const ( EqualTo ProcessInstanceVariableQueryOperator = "eq" NotEqualTo ProcessInstanceVariableQueryOperator = "neq" GreaterThan ProcessInstanceVariableQueryOperator = "gt" GreaterThanOrEqualTo ProcessInstanceVariableQueryOperator = "gteq" LowerThan ProcessInstanceVariableQueryOperator = "lt" LowerThanOrEqualTo ProcessInstanceVariableQueryOperator = "lteq" Like ProcessInstanceVariableQueryOperator = "like" )
type RequestInterceptor ¶
type SortOption ¶
type SortOption string
type SortOrder ¶
type SortOrder string
SortOrder defines sorting order for queries which allow to sort by columns
type StartProcessDefinitionBuilder ¶
type StartProcessDefinitionBuilder struct {
// contains filtered or unexported fields
}
func (*StartProcessDefinitionBuilder) ById ¶
func (pdb *StartProcessDefinitionBuilder) ById(id string) *StartProcessDefinitionBuilder
func (*StartProcessDefinitionBuilder) ByKey ¶
func (pdb *StartProcessDefinitionBuilder) ByKey(id string) *StartProcessDefinitionBuilder
func (*StartProcessDefinitionBuilder) ByMessage ¶
func (pdb *StartProcessDefinitionBuilder) ByMessage(messageName string) *StartProcessDefinitionBuilder
func (*StartProcessDefinitionBuilder) Now ¶
func (pdb *StartProcessDefinitionBuilder) Now() *ProcessInstance
func (*StartProcessDefinitionBuilder) WithBusinessKey ¶
func (pdb *StartProcessDefinitionBuilder) WithBusinessKey(businessKey string) *StartProcessDefinitionBuilder
func (*StartProcessDefinitionBuilder) WithVariables ¶
func (pdb *StartProcessDefinitionBuilder) WithVariables(variables *Variables) *StartProcessDefinitionBuilder
type ValueInfo ¶
type ValueInfo struct { // file Filename *string `json:"filename,omitempty"` MimeType *string `json:"mimetype,omitempty"` Encoding *string `json:"encoding,omitempty"` // object ObjectTypeName *string `json:"objectTypeName,omitempty"` SerializationDataFormat *string `json:"serializationDataFormat,omitempty"` }
A JSON object containing additional, value-type-dependent properties. For serialized variables of type Object, the following properties can be provided:
objectTypeName: A string representation of the object's type name. serializationDataFormat: The serialization format used to store the variable. For serialized variables of type File, the following properties can be provided:
filename: The name of the file. This is not the variable name but the name that will be used when downloading the file again. mimetype: The MIME type of the file that is being uploaded. encoding: The encoding of the file that is being uploaded.
func (*ValueInfo) GetEncoding ¶
GetEncoding returns the Encoding field if it's non-nil, zero value otherwise.
func (*ValueInfo) GetFilename ¶
GetFilename returns the Filename field if it's non-nil, zero value otherwise.
func (*ValueInfo) GetMimeType ¶
GetMimeType returns the MimeType field if it's non-nil, zero value otherwise.
func (*ValueInfo) GetObjectTypeName ¶
GetObjectTypeName returns the ObjectTypeName field if it's non-nil, zero value otherwise.
func (*ValueInfo) GetSerializationDataFormat ¶
GetSerializationDataFormat returns the SerializationDataFormat field if it's non-nil, zero value otherwise.
type VariableBuilder ¶
type VariableBuilder struct {
// contains filtered or unexported fields
}
func NewVariableBuilder ¶
func NewVariableBuilder() *VariableBuilder
func (*VariableBuilder) Build ¶
func (vb *VariableBuilder) Build() *Variables