CamundaClient

Technical Preview

The Go SDK is a technical preview. Its API surface may still evolve and changes may not follow semantic versioning. Pin an exact version if you need stability.

CamundaClient is the ergonomic entry point to the Camunda 8 Orchestration Cluster API. It wraps the generated REST client with configuration, authentication, adaptive backpressure, and transient retry. Its per-operation methods are generated in facade_generated.go.

CamundaClient exposes 251 methods covering the full Orchestration Cluster REST API surface, with authentication, retries, and backpressure applied automatically.

import camunda "github.com/camunda/orchestration-cluster-api-go"

Constructors

New

func New(opts ...Option) (*CamundaClient, error)

New resolves configuration from environment variables and options, then builds a ready-to-use client. Options take precedence over the environment.

Methods

Method	Description
ActivateAdHocSubProcessActivities	ActivateAdHocSubProcessActivities calls the ActivateAdHocSubProcessActivities operation.
ActivateJobs	ActivateJobs calls the ActivateJobs operation.
AssignClientToGroup	AssignClientToGroup calls the AssignClientToGroup operation.
AssignClientToTenant	AssignClientToTenant calls the AssignClientToTenant operation.
AssignGroupToTenant	AssignGroupToTenant calls the AssignGroupToTenant operation.
AssignMappingRuleToGroup	AssignMappingRuleToGroup calls the AssignMappingRuleToGroup operation.
AssignMappingRuleToTenant	AssignMappingRuleToTenant calls the AssignMappingRuleToTenant operation.
AssignProcessInstanceBusinessId	AssignProcessInstanceBusinessId calls the AssignProcessInstanceBusinessId operation.
AssignRoleToClient	AssignRoleToClient calls the AssignRoleToClient operation.
AssignRoleToGroup	AssignRoleToGroup calls the AssignRoleToGroup operation.
AssignRoleToMappingRule	AssignRoleToMappingRule calls the AssignRoleToMappingRule operation.
AssignRoleToTenant	AssignRoleToTenant calls the AssignRoleToTenant operation.
AssignRoleToUser	AssignRoleToUser calls the AssignRoleToUser operation.
AssignUserTask	AssignUserTask calls the AssignUserTask operation.
AssignUserToGroup	AssignUserToGroup calls the AssignUserToGroup operation.
AssignUserToTenant	AssignUserToTenant calls the AssignUserToTenant operation.
BroadcastSignal	BroadcastSignal calls the BroadcastSignal operation.
CancelBatchOperation	CancelBatchOperation calls the CancelBatchOperation operation.
CancelClusterRebalance	CancelClusterRebalance calls the CancelClusterRebalance operation.
CancelProcessInstance	CancelProcessInstance calls the CancelProcessInstance operation.
CancelProcessInstancesBatchOperation	CancelProcessInstancesBatchOperation calls the CancelProcessInstancesBatchOperation operation.
ChangeClusterMode	ChangeClusterMode calls the ChangeClusterMode operation.
ChangeClusterModeAsClusterAdmin	ChangeClusterModeAsClusterAdmin calls the ChangeClusterModeAsClusterAdmin operation.
Clock	Clock returns the clock this client resolves cadence through.
CompleteJob	CompleteJob calls the CompleteJob operation.
CompleteUserTask	CompleteUserTask calls the CompleteUserTask operation.
Config	Config returns the resolved configuration.
CorrelateMessage	CorrelateMessage calls the CorrelateMessage operation.
CreateAdminUser	CreateAdminUser calls the CreateAdminUser operation.
CreateAgentInstance	CreateAgentInstance calls the CreateAgentInstance operation.
CreateAuthorization	CreateAuthorization calls the CreateAuthorization operation.
CreateDeployment	CreateDeployment calls the CreateDeployment operation.
CreateDocument	CreateDocument calls the CreateDocument operation.
CreateDocumentLink	CreateDocumentLink calls the CreateDocumentLink operation.
CreateDocuments	CreateDocuments calls the CreateDocuments operation.
CreateElementInstanceVariables	CreateElementInstanceVariables calls the CreateElementInstanceVariables operation.
CreateGlobalClusterVariable	CreateGlobalClusterVariable calls the CreateGlobalClusterVariable operation.
CreateGlobalTaskListener	CreateGlobalTaskListener calls the CreateGlobalTaskListener operation.
CreateGroup	CreateGroup calls the CreateGroup operation.
CreateMappingRule	CreateMappingRule calls the CreateMappingRule operation.
CreateProcessInstance	CreateProcessInstance creates (starts) a process instance.
CreateRole	CreateRole calls the CreateRole operation.
CreateTenant	CreateTenant calls the CreateTenant operation.
CreateTenantClusterVariable	CreateTenantClusterVariable calls the CreateTenantClusterVariable operation.
CreateUser	CreateUser calls the CreateUser operation.
DeleteAuthorization	DeleteAuthorization calls the DeleteAuthorization operation.
DeleteDecisionInstance	DeleteDecisionInstance calls the DeleteDecisionInstance operation.
DeleteDecisionInstancesBatchOperation	DeleteDecisionInstancesBatchOperation calls the DeleteDecisionInstancesBatchOperation operation.
DeleteDocument	DeleteDocument calls the DeleteDocument operation.
DeleteGlobalClusterVariable	DeleteGlobalClusterVariable calls the DeleteGlobalClusterVariable operation.
DeleteGlobalTaskListener	DeleteGlobalTaskListener calls the DeleteGlobalTaskListener operation.
DeleteGroup	DeleteGroup calls the DeleteGroup operation.
DeleteHistoryBackup	DeleteHistoryBackup calls the DeleteHistoryBackup operation.
DeleteHistoryBackupAsClusterAdmin	DeleteHistoryBackupAsClusterAdmin calls the DeleteHistoryBackupAsClusterAdmin operation.
DeleteMappingRule	DeleteMappingRule calls the DeleteMappingRule operation.
DeleteProcessInstance	DeleteProcessInstance calls the DeleteProcessInstance operation.
DeleteProcessInstancesBatchOperation	DeleteProcessInstancesBatchOperation calls the DeleteProcessInstancesBatchOperation operation.
DeleteResource	DeleteResource calls the DeleteResource operation.
DeleteRole	DeleteRole calls the DeleteRole operation.
DeleteRuntimeBackup	DeleteRuntimeBackup calls the DeleteRuntimeBackup operation.
DeleteRuntimeBackupAsClusterAdmin	DeleteRuntimeBackupAsClusterAdmin calls the DeleteRuntimeBackupAsClusterAdmin operation.
DeleteRuntimeBackupState	DeleteRuntimeBackupState calls the DeleteRuntimeBackupState operation.
DeleteRuntimeBackupStateAsClusterAdmin	DeleteRuntimeBackupStateAsClusterAdmin calls the DeleteRuntimeBackupStateAsClusterAdmin operation.
DeleteTenant	DeleteTenant calls the DeleteTenant operation.
DeleteTenantClusterVariable	DeleteTenantClusterVariable calls the DeleteTenantClusterVariable operation.
DeleteUser	DeleteUser calls the DeleteUser operation.
EvaluateConditionals	EvaluateConditionals calls the EvaluateConditionals operation.
EvaluateDecision	EvaluateDecision calls the EvaluateDecision operation.
EvaluateExpression	EvaluateExpression calls the EvaluateExpression operation.
FailJob	FailJob calls the FailJob operation.
GetAgentDefinition	GetAgentDefinition calls the GetAgentDefinition operation.
GetAgentInstance	GetAgentInstance calls the GetAgentInstance operation.
GetAuditLog	GetAuditLog calls the GetAuditLog operation.
GetAuthentication	GetAuthentication calls the GetAuthentication operation.
GetAuthorization	GetAuthorization calls the GetAuthorization operation.
GetBatchOperation	GetBatchOperation calls the GetBatchOperation operation.
GetClusterExportingStatus	GetClusterExportingStatus calls the GetClusterExportingStatus operation.
GetClusterRebalance	GetClusterRebalance calls the GetClusterRebalance operation.
GetClusterStatus	GetClusterStatus calls the GetClusterStatus operation.
GetClusterTopology	GetClusterTopology calls the GetClusterTopology operation.
GetClusterUpgradeStatus	GetClusterUpgradeStatus calls the GetClusterUpgradeStatus operation.
GetDecisionDefinition	GetDecisionDefinition calls the GetDecisionDefinition operation.
GetDecisionDefinitionXML	GetDecisionDefinitionXML calls the GetDecisionDefinitionXML operation.
GetDecisionInstance	GetDecisionInstance calls the GetDecisionInstance operation.
GetDecisionRequirements	GetDecisionRequirements calls the GetDecisionRequirements operation.
GetDecisionRequirementsXML	GetDecisionRequirementsXML calls the GetDecisionRequirementsXML operation.
GetDocument	GetDocument calls the GetDocument operation.
GetElementInstance	GetElementInstance calls the GetElementInstance operation.
GetExportingStatus	GetExportingStatus calls the GetExportingStatus operation.
GetFormByKey	GetFormByKey calls the GetFormByKey operation.
GetGlobalClusterVariable	GetGlobalClusterVariable calls the GetGlobalClusterVariable operation.
GetGlobalJobStatistics	GetGlobalJobStatistics calls the GetGlobalJobStatistics operation.
GetGlobalTaskListener	GetGlobalTaskListener calls the GetGlobalTaskListener operation.
GetGroup	GetGroup calls the GetGroup operation.
GetHistoryBackup	GetHistoryBackup calls the GetHistoryBackup operation.
GetHistoryBackupAsClusterAdmin	GetHistoryBackupAsClusterAdmin calls the GetHistoryBackupAsClusterAdmin operation.
GetIncident	GetIncident calls the GetIncident operation.
GetJobErrorStatistics	GetJobErrorStatistics calls the GetJobErrorStatistics operation.
GetJobTimeSeriesStatistics	GetJobTimeSeriesStatistics calls the GetJobTimeSeriesStatistics operation.
GetJobTypeStatistics	GetJobTypeStatistics calls the GetJobTypeStatistics operation.
GetJobWorkerStatistics	GetJobWorkerStatistics calls the GetJobWorkerStatistics operation.
GetLicense	GetLicense calls the GetLicense operation.
GetMappingRule	GetMappingRule calls the GetMappingRule operation.
GetProcessDefinition	GetProcessDefinition calls the GetProcessDefinition operation.
GetProcessDefinitionInstanceStatistics	GetProcessDefinitionInstanceStatistics calls the GetProcessDefinitionInstanceStatistics operation.
GetProcessDefinitionInstanceVersionStatistics	GetProcessDefinitionInstanceVersionStatistics calls the GetProcessDefinitionInstanceVersionStatistics operation.
GetProcessDefinitionMessageSubscriptionStatistics	GetProcessDefinitionMessageSubscriptionStatistics calls the GetProcessDefinitionMessageSubscriptionStatistics operation.
GetProcessDefinitionStatistics	GetProcessDefinitionStatistics calls the GetProcessDefinitionStatistics operation.
GetProcessDefinitionXML	GetProcessDefinitionXML calls the GetProcessDefinitionXML operation.
GetProcessInstance	GetProcessInstance calls the GetProcessInstance operation.
GetProcessInstanceCallHierarchy	GetProcessInstanceCallHierarchy calls the GetProcessInstanceCallHierarchy operation.
GetProcessInstanceSequenceFlows	GetProcessInstanceSequenceFlows calls the GetProcessInstanceSequenceFlows operation.
GetProcessInstanceStatistics	GetProcessInstanceStatistics calls the GetProcessInstanceStatistics operation.
GetProcessInstanceStatisticsByDefinition	GetProcessInstanceStatisticsByDefinition calls the GetProcessInstanceStatisticsByDefinition operation.
GetProcessInstanceStatisticsByError	GetProcessInstanceStatisticsByError calls the GetProcessInstanceStatisticsByError operation.
GetProcessInstanceWaitStateStatistics	GetProcessInstanceWaitStateStatistics calls the GetProcessInstanceWaitStateStatistics operation.
GetResource	GetResource calls the GetResource operation.
GetResourceContent	GetResourceContent calls the GetResourceContent operation.
GetResourceContentBinary	GetResourceContentBinary calls the GetResourceContentBinary operation.
GetRestoreStatus	GetRestoreStatus calls the GetRestoreStatus operation.
GetRole	GetRole calls the GetRole operation.
GetRuntimeBackup	GetRuntimeBackup calls the GetRuntimeBackup operation.
GetRuntimeBackupAsClusterAdmin	GetRuntimeBackupAsClusterAdmin calls the GetRuntimeBackupAsClusterAdmin operation.
GetRuntimeBackupState	GetRuntimeBackupState calls the GetRuntimeBackupState operation.
GetRuntimeBackupStateAsClusterAdmin	GetRuntimeBackupStateAsClusterAdmin calls the GetRuntimeBackupStateAsClusterAdmin operation.
GetStartProcessForm	GetStartProcessForm calls the GetStartProcessForm operation.
GetStatus	GetStatus calls the GetStatus operation.
GetSystemConfiguration	GetSystemConfiguration calls the GetSystemConfiguration operation.
GetTenant	GetTenant calls the GetTenant operation.
GetTenantClusterVariable	GetTenantClusterVariable calls the GetTenantClusterVariable operation.
GetTopology	GetTopology calls the GetTopology operation.
GetUsageMetrics	GetUsageMetrics calls the GetUsageMetrics operation.
GetUser	GetUser calls the GetUser operation.
GetUserTask	GetUserTask calls the GetUserTask operation.
GetUserTaskForm	GetUserTaskForm calls the GetUserTaskForm operation.
GetVariable	GetVariable calls the GetVariable operation.
ListHistoryBackups	ListHistoryBackups calls the ListHistoryBackups operation.
ListHistoryBackupsAsClusterAdmin	ListHistoryBackupsAsClusterAdmin calls the ListHistoryBackupsAsClusterAdmin operation.
ListRuntimeBackups	ListRuntimeBackups calls the ListRuntimeBackups operation.
ListRuntimeBackupsAsClusterAdmin	ListRuntimeBackupsAsClusterAdmin calls the ListRuntimeBackupsAsClusterAdmin operation.
ListSecrets	ListSecrets calls the ListSecrets operation.
MigrateProcessInstance	MigrateProcessInstance calls the MigrateProcessInstance operation.
MigrateProcessInstancesBatchOperation	MigrateProcessInstancesBatchOperation calls the MigrateProcessInstancesBatchOperation operation.
ModifyProcessInstance	ModifyProcessInstance calls the ModifyProcessInstance operation.
ModifyProcessInstancesBatchOperation	ModifyProcessInstancesBatchOperation calls the ModifyProcessInstancesBatchOperation operation.
NewJobWorker	NewJobWorker creates a worker for jobType. Defaults are seeded from the client's CAMUNDA_WORKER_* configuration and can be overridden with options.
NewStreamJobWorker	NewStreamJobWorker creates a gRPC streaming worker for jobType. Defaults are seeded from the client's CAMUNDA_WORKER_* configuration and can be overridden with options.
PauseClusterExporting	PauseClusterExporting calls the PauseClusterExporting operation.
PauseExporting	PauseExporting calls the PauseExporting operation.
PinAt	PinAt moves the engine clock to t.
PinClock	PinClock calls the PinClock operation.
PublishMessage	PublishMessage calls the PublishMessage operation.
Raw	Raw returns the underlying generated client for operations or options not yet surfaced on the ergonomic facade.
ResetClock	ResetClock calls the ResetClock operation.
ResetToLive	ResetToLive returns the engine clock to real time.
ResolveIncident	ResolveIncident calls the ResolveIncident operation.
ResolveIncidentsBatchOperation	ResolveIncidentsBatchOperation calls the ResolveIncidentsBatchOperation operation.
ResolveProcessInstanceIncidents	ResolveProcessInstanceIncidents calls the ResolveProcessInstanceIncidents operation.
ResolveSecrets	ResolveSecrets calls the ResolveSecrets operation.
Restore	Restore calls the Restore operation.
RestoreAsClusterAdmin	RestoreAsClusterAdmin calls the RestoreAsClusterAdmin operation.
ResumeBatchOperation	ResumeBatchOperation calls the ResumeBatchOperation operation.
ResumeClusterExporting	ResumeClusterExporting calls the ResumeClusterExporting operation.
ResumeExporting	ResumeExporting calls the ResumeExporting operation.
ResumeProcessInstance	ResumeProcessInstance calls the ResumeProcessInstance operation.
ResumeProcessInstancesBatchOperation	ResumeProcessInstancesBatchOperation calls the ResumeProcessInstancesBatchOperation operation.
SearchAgentDefinitions	SearchAgentDefinitions calls the SearchAgentDefinitions operation.
SearchAgentInstanceHistory	SearchAgentInstanceHistory calls the SearchAgentInstanceHistory operation.
SearchAgentInstances	SearchAgentInstances calls the SearchAgentInstances operation.
SearchAuditLogs	SearchAuditLogs calls the SearchAuditLogs operation.
SearchAuthorizations	SearchAuthorizations calls the SearchAuthorizations operation.
SearchBatchOperationItems	SearchBatchOperationItems calls the SearchBatchOperationItems operation.
SearchBatchOperations	SearchBatchOperations calls the SearchBatchOperations operation.
SearchClientsForGroup	SearchClientsForGroup calls the SearchClientsForGroup operation.
SearchClientsForRole	SearchClientsForRole calls the SearchClientsForRole operation.
SearchClientsForTenant	SearchClientsForTenant calls the SearchClientsForTenant operation.
SearchClusterVariables	SearchClusterVariables calls the SearchClusterVariables operation.
SearchCorrelatedMessageSubscriptions	SearchCorrelatedMessageSubscriptions calls the SearchCorrelatedMessageSubscriptions operation.
SearchDecisionDefinitions	SearchDecisionDefinitions calls the SearchDecisionDefinitions operation.
SearchDecisionInstances	SearchDecisionInstances calls the SearchDecisionInstances operation.
SearchDecisionRequirements	SearchDecisionRequirements calls the SearchDecisionRequirements operation.
SearchElementInstanceIncidents	SearchElementInstanceIncidents calls the SearchElementInstanceIncidents operation.
SearchElementInstanceWaitStates	SearchElementInstanceWaitStates calls the SearchElementInstanceWaitStates operation.
SearchElementInstances	SearchElementInstances calls the SearchElementInstances operation.
SearchGlobalTaskListeners	SearchGlobalTaskListeners calls the SearchGlobalTaskListeners operation.
SearchGroupIdsForTenant	SearchGroupIdsForTenant calls the SearchGroupIdsForTenant operation.
SearchGroups	SearchGroups calls the SearchGroups operation.
SearchGroupsForRole	SearchGroupsForRole calls the SearchGroupsForRole operation.
SearchIncidents	SearchIncidents calls the SearchIncidents operation.
SearchJobs	SearchJobs calls the SearchJobs operation.
SearchMappingRule	SearchMappingRule calls the SearchMappingRule operation.
SearchMappingRulesForGroup	SearchMappingRulesForGroup calls the SearchMappingRulesForGroup operation.
SearchMappingRulesForRole	SearchMappingRulesForRole calls the SearchMappingRulesForRole operation.
SearchMappingRulesForTenant	SearchMappingRulesForTenant calls the SearchMappingRulesForTenant operation.
SearchMessageSubscriptions	SearchMessageSubscriptions calls the SearchMessageSubscriptions operation.
SearchOwnAuthorizations	SearchOwnAuthorizations calls the SearchOwnAuthorizations operation.
SearchProcessDefinitionVariableNames	SearchProcessDefinitionVariableNames calls the SearchProcessDefinitionVariableNames operation.
SearchProcessDefinitions	SearchProcessDefinitions calls the SearchProcessDefinitions operation.
SearchProcessInstanceIncidents	SearchProcessInstanceIncidents calls the SearchProcessInstanceIncidents operation.
SearchProcessInstances	SearchProcessInstances calls the SearchProcessInstances operation.
SearchResources	SearchResources calls the SearchResources operation.
SearchRoles	SearchRoles calls the SearchRoles operation.
SearchRolesForGroup	SearchRolesForGroup calls the SearchRolesForGroup operation.
SearchRolesForTenant	SearchRolesForTenant calls the SearchRolesForTenant operation.
SearchTenants	SearchTenants calls the SearchTenants operation.
SearchUserTaskAuditLogs	SearchUserTaskAuditLogs calls the SearchUserTaskAuditLogs operation.
SearchUserTaskEffectiveVariables	SearchUserTaskEffectiveVariables calls the SearchUserTaskEffectiveVariables operation.
SearchUserTaskVariables	SearchUserTaskVariables calls the SearchUserTaskVariables operation.
SearchUserTasks	SearchUserTasks calls the SearchUserTasks operation.
SearchUsers	SearchUsers calls the SearchUsers operation.
SearchUsersForGroup	SearchUsersForGroup calls the SearchUsersForGroup operation.
SearchUsersForRole	SearchUsersForRole calls the SearchUsersForRole operation.
SearchUsersForTenant	SearchUsersForTenant calls the SearchUsersForTenant operation.
SearchVariables	SearchVariables calls the SearchVariables operation.
SuspendBatchOperation	SuspendBatchOperation calls the SuspendBatchOperation operation.
SuspendProcessInstance	SuspendProcessInstance calls the SuspendProcessInstance operation.
SuspendProcessInstancesBatchOperation	SuspendProcessInstancesBatchOperation calls the SuspendProcessInstancesBatchOperation operation.
SyncRuntimeBackupState	SyncRuntimeBackupState calls the SyncRuntimeBackupState operation.
SyncRuntimeBackupStateAsClusterAdmin	SyncRuntimeBackupStateAsClusterAdmin calls the SyncRuntimeBackupStateAsClusterAdmin operation.
TakeHistoryBackup	TakeHistoryBackup calls the TakeHistoryBackup operation.
TakeHistoryBackupAsClusterAdmin	TakeHistoryBackupAsClusterAdmin calls the TakeHistoryBackupAsClusterAdmin operation.
TakeRuntimeBackup	TakeRuntimeBackup calls the TakeRuntimeBackup operation.
TakeRuntimeBackupAsClusterAdmin	TakeRuntimeBackupAsClusterAdmin calls the TakeRuntimeBackupAsClusterAdmin operation.
ThrowJobError	ThrowJobError calls the ThrowJobError operation.
TriggerClusterRebalance	TriggerClusterRebalance calls the TriggerClusterRebalance operation.
UnassignClientFromGroup	UnassignClientFromGroup calls the UnassignClientFromGroup operation.
UnassignClientFromTenant	UnassignClientFromTenant calls the UnassignClientFromTenant operation.
UnassignGroupFromTenant	UnassignGroupFromTenant calls the UnassignGroupFromTenant operation.
UnassignMappingRuleFromGroup	UnassignMappingRuleFromGroup calls the UnassignMappingRuleFromGroup operation.
UnassignMappingRuleFromTenant	UnassignMappingRuleFromTenant calls the UnassignMappingRuleFromTenant operation.
UnassignRoleFromClient	UnassignRoleFromClient calls the UnassignRoleFromClient operation.
UnassignRoleFromGroup	UnassignRoleFromGroup calls the UnassignRoleFromGroup operation.
UnassignRoleFromMappingRule	UnassignRoleFromMappingRule calls the UnassignRoleFromMappingRule operation.
UnassignRoleFromTenant	UnassignRoleFromTenant calls the UnassignRoleFromTenant operation.
UnassignRoleFromUser	UnassignRoleFromUser calls the UnassignRoleFromUser operation.
UnassignUserFromGroup	UnassignUserFromGroup calls the UnassignUserFromGroup operation.
UnassignUserFromTenant	UnassignUserFromTenant calls the UnassignUserFromTenant operation.
UnassignUserTask	UnassignUserTask calls the UnassignUserTask operation.
UpdateAgentInstance	UpdateAgentInstance calls the UpdateAgentInstance operation.
UpdateAuthorization	UpdateAuthorization calls the UpdateAuthorization operation.
UpdateGlobalClusterVariable	UpdateGlobalClusterVariable calls the UpdateGlobalClusterVariable operation.
UpdateGlobalTaskListener	UpdateGlobalTaskListener calls the UpdateGlobalTaskListener operation.
UpdateGroup	UpdateGroup calls the UpdateGroup operation.
UpdateJob	UpdateJob calls the UpdateJob operation.
UpdateJobsBatchOperation	UpdateJobsBatchOperation calls the UpdateJobsBatchOperation operation.
UpdateMappingRule	UpdateMappingRule calls the UpdateMappingRule operation.
UpdateRole	UpdateRole calls the UpdateRole operation.
UpdateTenant	UpdateTenant calls the UpdateTenant operation.
UpdateTenantClusterVariable	UpdateTenantClusterVariable calls the UpdateTenantClusterVariable operation.
UpdateUser	UpdateUser calls the UpdateUser operation.
UpdateUserTask	UpdateUserTask calls the UpdateUserTask operation.

Method details

ActivateAdHocSubProcessActivities

func (c *CamundaClient) ActivateAdHocSubProcessActivities(ctx context.Context, adHocSubProcessInstanceKey ElementInstanceKey, body AdHocSubProcessActivateActivitiesInstruction, opts ...func(ApiActivateAdHocSubProcessActivitiesRequest) ApiActivateAdHocSubProcessActivitiesRequest) error

Types: ElementInstanceKey, AdHocSubProcessActivateActivitiesInstruction, ApiActivateAdHocSubProcessActivitiesRequest

ActivateAdHocSubProcessActivities calls the ActivateAdHocSubProcessActivities operation.

Example:

instruction := camunda.NewAdHocSubProcessActivateActivitiesInstruction(
	[]camunda.AdHocSubProcessActivateActivityReference{
		*camunda.NewAdHocSubProcessActivateActivityReference("review-task"),
	})

return client.ActivateAdHocSubProcessActivities(ctx,
	camunda.MustElementInstanceKey("2251799813685360"), *instruction)

ActivateJobs

func (c *CamundaClient) ActivateJobs(ctx context.Context, body JobActivationRequest, opts ...func(ApiActivateJobsRequest) ApiActivateJobsRequest) (*JobActivationResult, error)

Types: JobActivationRequest, ApiActivateJobsRequest, JobActivationResult

ActivateJobs calls the ActivateJobs operation.

Example:

// Activate up to 10 "greet" jobs with a 60s activation timeout.
req := camunda.NewJobActivationRequest("greet", 60_000, 10)
req.SetWorker("greet-worker")

result, err := client.ActivateJobs(ctx, *req)
if err != nil {
	return err
}
for _, job := range result.GetJobs() {
	fmt.Printf("activated job %v\n", job.GetJobKey())
}

AssignClientToGroup

func (c *CamundaClient) AssignClientToGroup(ctx context.Context, groupId string, clientId string, opts ...func(ApiAssignClientToGroupRequest) ApiAssignClientToGroupRequest) error

Types: ApiAssignClientToGroupRequest

AssignClientToGroup calls the AssignClientToGroup operation.

Example:

return client.AssignClientToGroup(ctx, "finance", "reporting-service")

AssignClientToTenant

func (c *CamundaClient) AssignClientToTenant(ctx context.Context, tenantId string, clientId string, opts ...func(ApiAssignClientToTenantRequest) ApiAssignClientToTenantRequest) error

Types: ApiAssignClientToTenantRequest

AssignClientToTenant calls the AssignClientToTenant operation.

Example:

return client.AssignClientToTenant(ctx, "tenant-a", "reporting-service")

AssignGroupToTenant

func (c *CamundaClient) AssignGroupToTenant(ctx context.Context, tenantId string, groupId string, opts ...func(ApiAssignGroupToTenantRequest) ApiAssignGroupToTenantRequest) error

Types: ApiAssignGroupToTenantRequest

AssignGroupToTenant calls the AssignGroupToTenant operation.

Example:

return client.AssignGroupToTenant(ctx, "tenant-a", "finance")

AssignMappingRuleToGroup

func (c *CamundaClient) AssignMappingRuleToGroup(ctx context.Context, groupId string, mappingRuleId string, opts ...func(ApiAssignMappingRuleToGroupRequest) ApiAssignMappingRuleToGroupRequest) error

Types: ApiAssignMappingRuleToGroupRequest

AssignMappingRuleToGroup calls the AssignMappingRuleToGroup operation.

Example:

return client.AssignMappingRuleToGroup(ctx, "finance", "sso-auditors")

AssignMappingRuleToTenant

func (c *CamundaClient) AssignMappingRuleToTenant(ctx context.Context, tenantId string, mappingRuleId string, opts ...func(ApiAssignMappingRuleToTenantRequest) ApiAssignMappingRuleToTenantRequest) error

Types: ApiAssignMappingRuleToTenantRequest

AssignMappingRuleToTenant calls the AssignMappingRuleToTenant operation.

Example:

return client.AssignMappingRuleToTenant(ctx, "tenant-a", "sso-auditors")

AssignProcessInstanceBusinessId

func (c *CamundaClient) AssignProcessInstanceBusinessId(ctx context.Context, processInstanceKey ProcessInstanceKey, body ProcessInstanceBusinessIdAssignmentInstruction, opts ...func(ApiAssignProcessInstanceBusinessIdRequest) ApiAssignProcessInstanceBusinessIdRequest) error

Types: ProcessInstanceKey, ProcessInstanceBusinessIdAssignmentInstruction, ApiAssignProcessInstanceBusinessIdRequest

AssignProcessInstanceBusinessId calls the AssignProcessInstanceBusinessId operation.

Example:

return client.AssignProcessInstanceBusinessId(ctx,
	camunda.MustProcessInstanceKey("2251799813685340"),
	*camunda.NewProcessInstanceBusinessIdAssignmentInstruction("order-42"))

AssignRoleToClient

func (c *CamundaClient) AssignRoleToClient(ctx context.Context, roleId string, clientId string, opts ...func(ApiAssignRoleToClientRequest) ApiAssignRoleToClientRequest) error

Types: ApiAssignRoleToClientRequest

AssignRoleToClient calls the AssignRoleToClient operation.

Example:

return client.AssignRoleToClient(ctx, "auditor", "reporting-service")

AssignRoleToGroup

func (c *CamundaClient) AssignRoleToGroup(ctx context.Context, roleId string, groupId string, opts ...func(ApiAssignRoleToGroupRequest) ApiAssignRoleToGroupRequest) error

Types: ApiAssignRoleToGroupRequest

AssignRoleToGroup calls the AssignRoleToGroup operation.

Example:

return client.AssignRoleToGroup(ctx, "auditor", "finance")

AssignRoleToMappingRule

func (c *CamundaClient) AssignRoleToMappingRule(ctx context.Context, roleId string, mappingRuleId string, opts ...func(ApiAssignRoleToMappingRuleRequest) ApiAssignRoleToMappingRuleRequest) error

Types: ApiAssignRoleToMappingRuleRequest

AssignRoleToMappingRule calls the AssignRoleToMappingRule operation.

Example:

return client.AssignRoleToMappingRule(ctx, "auditor", "sso-auditors")

AssignRoleToTenant

func (c *CamundaClient) AssignRoleToTenant(ctx context.Context, tenantId string, roleId string, opts ...func(ApiAssignRoleToTenantRequest) ApiAssignRoleToTenantRequest) error

Types: ApiAssignRoleToTenantRequest

AssignRoleToTenant calls the AssignRoleToTenant operation.

Example:

return client.AssignRoleToTenant(ctx, "tenant-a", "auditor")

AssignRoleToUser

func (c *CamundaClient) AssignRoleToUser(ctx context.Context, roleId string, username string, opts ...func(ApiAssignRoleToUserRequest) ApiAssignRoleToUserRequest) error

Types: ApiAssignRoleToUserRequest

AssignRoleToUser calls the AssignRoleToUser operation.

Example:

return client.AssignRoleToUser(ctx, "auditor", "alice")

AssignUserTask

func (c *CamundaClient) AssignUserTask(ctx context.Context, userTaskKey UserTaskKey, body UserTaskAssignmentRequest, opts ...func(ApiAssignUserTaskRequest) ApiAssignUserTaskRequest) error

Types: UserTaskKey, UserTaskAssignmentRequest, ApiAssignUserTaskRequest

AssignUserTask calls the AssignUserTask operation.

Example:

req := camunda.NewUserTaskAssignmentRequest()
req.SetAssignee("alice")

return client.AssignUserTask(ctx, camunda.MustUserTaskKey("2251799813685380"), *req)

AssignUserToGroup

func (c *CamundaClient) AssignUserToGroup(ctx context.Context, groupId string, username string, opts ...func(ApiAssignUserToGroupRequest) ApiAssignUserToGroupRequest) error

Types: ApiAssignUserToGroupRequest

AssignUserToGroup calls the AssignUserToGroup operation.

Example:

return client.AssignUserToGroup(ctx, "finance", "alice")

AssignUserToTenant

func (c *CamundaClient) AssignUserToTenant(ctx context.Context, tenantId string, username string, opts ...func(ApiAssignUserToTenantRequest) ApiAssignUserToTenantRequest) error

Types: ApiAssignUserToTenantRequest

AssignUserToTenant calls the AssignUserToTenant operation.

Example:

return client.AssignUserToTenant(ctx, "tenant-a", "alice")

BroadcastSignal

func (c *CamundaClient) BroadcastSignal(ctx context.Context, body SignalBroadcastRequest, opts ...func(ApiBroadcastSignalRequest) ApiBroadcastSignalRequest) (*SignalBroadcastResult, error)

Types: SignalBroadcastRequest, ApiBroadcastSignalRequest, SignalBroadcastResult

BroadcastSignal calls the BroadcastSignal operation.

Example:

req := camunda.NewSignalBroadcastRequest("cancel-all-orders")
req.SetVariables(map[string]any{"reason": "maintenance"})

result, err := client.BroadcastSignal(ctx, *req)
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

CancelBatchOperation

func (c *CamundaClient) CancelBatchOperation(ctx context.Context, batchOperationKey string, opts ...func(ApiCancelBatchOperationRequest) ApiCancelBatchOperationRequest) error

Types: ApiCancelBatchOperationRequest

CancelBatchOperation calls the CancelBatchOperation operation.

Example:

return client.CancelBatchOperation(ctx, "2251799813685290")

CancelClusterRebalance

func (c *CamundaClient) CancelClusterRebalance(ctx context.Context, opts ...func(ApiCancelClusterRebalanceRequest) ApiCancelClusterRebalanceRequest) (*RebalanceCancellationResponse, error)

Types: ApiCancelClusterRebalanceRequest, RebalanceCancellationResponse

CancelClusterRebalance calls the CancelClusterRebalance operation.

Example:

// Requires cluster-admin credentials (a separate cluster-admin security chain) —
// calling this with standard Orchestration credentials will fail authorization.
resp, err := client.CancelClusterRebalance(ctx)
if err != nil {
	return err
}
if resp.GetWasRunning() {
	fmt.Println("rebalance cancelled")
} else {
	fmt.Println("no rebalance was running")
}

CancelProcessInstance

func (c *CamundaClient) CancelProcessInstance(ctx context.Context, processInstanceKey ProcessInstanceKey, body CancelProcessInstanceRequest, opts ...func(ApiCancelProcessInstanceRequest) ApiCancelProcessInstanceRequest) error

Types: ProcessInstanceKey, CancelProcessInstanceRequest, ApiCancelProcessInstanceRequest

CancelProcessInstance calls the CancelProcessInstance operation.

Example:

return client.CancelProcessInstance(ctx,
	camunda.MustProcessInstanceKey("2251799813685340"),
	*camunda.NewCancelProcessInstanceRequest())

CancelProcessInstancesBatchOperation

func (c *CamundaClient) CancelProcessInstancesBatchOperation(ctx context.Context, body ProcessInstanceCancellationBatchOperationRequest, opts ...func(ApiCancelProcessInstancesBatchOperationRequest) ApiCancelProcessInstancesBatchOperationRequest) (*BatchOperationCreatedResult, error)

Types: ProcessInstanceCancellationBatchOperationRequest, ApiCancelProcessInstancesBatchOperationRequest, BatchOperationCreatedResult

CancelProcessInstancesBatchOperation calls the CancelProcessInstancesBatchOperation operation.

Example:

// Cancel every instance matching a filter in a single batch operation.
req := camunda.NewProcessInstanceCancellationBatchOperationRequest(*camunda.NewProcessInstanceFilter())

result, err := client.CancelProcessInstancesBatchOperation(ctx, *req)
if err != nil {
	return err
}
fmt.Printf("created batch operation %v\n", result.GetBatchOperationKey())

ChangeClusterMode

func (c *CamundaClient) ChangeClusterMode(ctx context.Context, opts ...func(ApiChangeClusterModeRequest) ApiChangeClusterModeRequest) (*ClusterModeChangeResponse, error)

Types: ApiChangeClusterModeRequest, ClusterModeChangeResponse

ChangeClusterMode calls the ChangeClusterMode operation.

Example:

result, err := client.ChangeClusterMode(ctx)
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

ChangeClusterModeAsClusterAdmin

func (c *CamundaClient) ChangeClusterModeAsClusterAdmin(ctx context.Context, opts ...func(ApiChangeClusterModeAsClusterAdminRequest) ApiChangeClusterModeAsClusterAdminRequest) (*ClusterModeChangeResponse, error)

Types: ApiChangeClusterModeAsClusterAdminRequest, ClusterModeChangeResponse

ChangeClusterModeAsClusterAdmin calls the ChangeClusterModeAsClusterAdmin operation.

Example:

// Changes the cluster mode as a cluster-level admin (cross-tenant authority).
result, err := client.ChangeClusterModeAsClusterAdmin(ctx, func(r camunda.ApiChangeClusterModeAsClusterAdminRequest) camunda.ApiChangeClusterModeAsClusterAdminRequest {
	return r.Mode(camunda.MODE_RECOVERING)
})
if err != nil {
	return err
}
fmt.Printf("change %s: %d planned operation group(s)\n", result.GetChangeId(), len(result.GetPlannedChanges()))

Clock

func (c *CamundaClient) Clock() Clock

Clock returns the clock this client resolves cadence through.

CompleteJob

func (c *CamundaClient) CompleteJob(ctx context.Context, jobKey JobKey, body JobCompletionRequest, opts ...func(ApiCompleteJobRequest) ApiCompleteJobRequest) error

Types: JobKey, JobCompletionRequest, ApiCompleteJobRequest

CompleteJob calls the CompleteJob operation.

Example:

req := camunda.NewJobCompletionRequest()
req.SetVariables(map[string]any{"greeting": "Hello!"})

return client.CompleteJob(ctx, camunda.MustJobKey("2251799813685424"), *req)

CompleteUserTask

func (c *CamundaClient) CompleteUserTask(ctx context.Context, userTaskKey UserTaskKey, body UserTaskCompletionRequest, opts ...func(ApiCompleteUserTaskRequest) ApiCompleteUserTaskRequest) error

Types: UserTaskKey, UserTaskCompletionRequest, ApiCompleteUserTaskRequest

CompleteUserTask calls the CompleteUserTask operation.

Example:

req := camunda.NewUserTaskCompletionRequest()
req.SetVariables(map[string]any{"approved": true})

return client.CompleteUserTask(ctx, camunda.MustUserTaskKey("2251799813685380"), *req)

Config

func (c *CamundaClient) Config() *Config

Config returns the resolved configuration.

CorrelateMessage

func (c *CamundaClient) CorrelateMessage(ctx context.Context, body MessageCorrelationRequest, opts ...func(ApiCorrelateMessageRequest) ApiCorrelateMessageRequest) (*MessageCorrelationResult, error)

Types: MessageCorrelationRequest, ApiCorrelateMessageRequest, MessageCorrelationResult

CorrelateMessage calls the CorrelateMessage operation.

Example:

req := camunda.NewMessageCorrelationRequest("order-confirmed")
req.SetCorrelationKey("order-42")
req.SetVariables(map[string]any{"confirmedBy": "payment-service"})

result, err := client.CorrelateMessage(ctx, *req)
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

CreateAdminUser

func (c *CamundaClient) CreateAdminUser(ctx context.Context, body UserRequest, opts ...func(ApiCreateAdminUserRequest) ApiCreateAdminUserRequest) (*UserCreateResult, error)

Types: UserRequest, ApiCreateAdminUserRequest, UserCreateResult

CreateAdminUser calls the CreateAdminUser operation.

Example:

// One-time setup: create the initial administrator on a fresh cluster.
// "admin-password-123" is a placeholder — don't hardcode passwords in production.
result, err := client.CreateAdminUser(ctx, *camunda.NewUserRequest("admin-password-123", "admin"))
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

CreateAgentInstance

func (c *CamundaClient) CreateAgentInstance(ctx context.Context, body AgentInstanceCreationRequest, opts ...func(ApiCreateAgentInstanceRequest) ApiCreateAgentInstanceRequest) (*AgentInstanceCreationResult, error)

Types: AgentInstanceCreationRequest, ApiCreateAgentInstanceRequest, AgentInstanceCreationResult

CreateAgentInstance calls the CreateAgentInstance operation.

Example:

systemPrompt := []camunda.AgentInstanceMessageContent{
	camunda.AgentInstanceTextContentAsAgentInstanceMessageContent(
		camunda.NewAgentInstanceTextContent("TEXT", "You are a helpful assistant.")),
}
configItem := camunda.NewAgentInstanceHistoryItem(
	"config-1", camunda.MustLoopIterationId(1), camunda.AGENTINSTANCEHISTORYROLEENUM_CONFIGURATION, nil, time.Now())
configItem.SetModel("gpt-4o")
configItem.SetProvider("openai")
configItem.SetSystemPrompt(systemPrompt)

req := camunda.NewAgentInstanceCreationRequest(
	camunda.ElementInstanceKey("2251799813685360"), // elementInstanceKey
	camunda.JobKey("2251799813685424"),             // jobKey
	"lease-token",
	[]camunda.AgentInstanceHistoryItem{*configItem}, // history
)

result, err := client.CreateAgentInstance(ctx, *req)
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

CreateAuthorization

func (c *CamundaClient) CreateAuthorization(ctx context.Context, body AuthorizationRequest, opts ...func(ApiCreateAuthorizationRequest) ApiCreateAuthorizationRequest) (*AuthorizationCreateResult, error)

Types: AuthorizationRequest, ApiCreateAuthorizationRequest, AuthorizationCreateResult

CreateAuthorization calls the CreateAuthorization operation.

Example:

// AuthorizationRequest is a union; grant an id-based authorization here.
grant := camunda.NewAuthorizationIdBasedRequest(
	"user@example.com",
	camunda.OWNERTYPEENUM_USER,
	"order-process",
	camunda.RESOURCETYPEENUM_PROCESS_DEFINITION,
	[]camunda.PermissionTypeEnum{
		camunda.PERMISSIONTYPEENUM_READ_PROCESS_DEFINITION,
		camunda.PERMISSIONTYPEENUM_CREATE_PROCESS_INSTANCE,
	},
)

result, err := client.CreateAuthorization(ctx,
	camunda.AuthorizationIdBasedRequestAsAuthorizationRequest(grant))
if err != nil {
	return err
}
fmt.Printf("created authorization %v\n", result.GetAuthorizationKey())

CreateDeployment

func (c *CamundaClient) CreateDeployment(ctx context.Context, opts ...func(ApiCreateDeploymentRequest) ApiCreateDeploymentRequest) (*DeploymentResult, error)

Types: ApiCreateDeploymentRequest, DeploymentResult

CreateDeployment calls the CreateDeployment operation.

Example:

// Multipart resource upload is done through the Raw() generated client.
f, err := os.Open("order-process.bpmn")
if err != nil {
	return err
}
defer func() { _ = f.Close() }()

deployment, _, err := client.Raw().ResourceAPI.CreateDeployment(ctx).
	Resources([]*os.File{f}).
	Execute()
if err != nil {
	return err
}
fmt.Printf("deployment key %v\n", deployment.GetDeploymentKey())

CreateDocument

func (c *CamundaClient) CreateDocument(ctx context.Context, opts ...func(ApiCreateDocumentRequest) ApiCreateDocumentRequest) (*DocumentReference, error)

Types: ApiCreateDocumentRequest, DocumentReference

CreateDocument calls the CreateDocument operation.

Example:

// The document payload is attached via request options (functional opts) or
// the Raw() client; here we call the ergonomic facade method.
ref, err := client.CreateDocument(ctx)
if err != nil {
	return err
}
fmt.Printf("%v\n", ref)

CreateDocumentLink

func (c *CamundaClient) CreateDocumentLink(ctx context.Context, documentId string, body DocumentLinkRequest, opts ...func(ApiCreateDocumentLinkRequest) ApiCreateDocumentLinkRequest) (*DocumentLink, error)

Types: DocumentLinkRequest, ApiCreateDocumentLinkRequest, DocumentLink

CreateDocumentLink calls the CreateDocumentLink operation.

Example:

// Create a short-lived, shareable download link for a stored document.
link, err := client.CreateDocumentLink(ctx, "doc-123", *camunda.NewDocumentLinkRequest())
if err != nil {
	return err
}
fmt.Printf("%v\n", link)

CreateDocuments

func (c *CamundaClient) CreateDocuments(ctx context.Context, opts ...func(ApiCreateDocumentsRequest) ApiCreateDocumentsRequest) (*DocumentCreationBatchResponse, error)

Types: ApiCreateDocumentsRequest, DocumentCreationBatchResponse

CreateDocuments calls the CreateDocuments operation.

Example:

// Batch upload multiple documents in a single multipart request.
result, err := client.CreateDocuments(ctx)
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

CreateElementInstanceVariables

func (c *CamundaClient) CreateElementInstanceVariables(ctx context.Context, elementInstanceKey ElementInstanceKey, body SetVariableRequest, opts ...func(ApiCreateElementInstanceVariablesRequest) ApiCreateElementInstanceVariablesRequest) error

Types: ElementInstanceKey, SetVariableRequest, ApiCreateElementInstanceVariablesRequest

CreateElementInstanceVariables calls the CreateElementInstanceVariables operation.

Example:

// Set local variables on a specific element instance scope.
req := camunda.NewSetVariableRequest(map[string]any{"approved": true})

return client.CreateElementInstanceVariables(ctx, camunda.MustElementInstanceKey("2251799813685360"), *req)

CreateGlobalClusterVariable

func (c *CamundaClient) CreateGlobalClusterVariable(ctx context.Context, body CreateClusterVariableRequest, opts ...func(ApiCreateGlobalClusterVariableRequest) ApiCreateGlobalClusterVariableRequest) (*ClusterVariableResult, error)

Types: CreateClusterVariableRequest, ApiCreateGlobalClusterVariableRequest, ClusterVariableResult

CreateGlobalClusterVariable calls the CreateGlobalClusterVariable operation.

Example:

result, err := client.CreateGlobalClusterVariable(ctx,
	*camunda.NewCreateClusterVariableRequest("region", map[string]any{"value": "eu-1"}))
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

CreateGlobalTaskListener

func (c *CamundaClient) CreateGlobalTaskListener(ctx context.Context, body CreateGlobalTaskListenerRequest, opts ...func(ApiCreateGlobalTaskListenerRequest) ApiCreateGlobalTaskListenerRequest) (*GlobalTaskListenerResult, error)

Types: CreateGlobalTaskListenerRequest, ApiCreateGlobalTaskListenerRequest, GlobalTaskListenerResult

CreateGlobalTaskListener calls the CreateGlobalTaskListener operation.

Example:

result, err := client.CreateGlobalTaskListener(ctx,
	*camunda.NewCreateGlobalTaskListenerRequest("audit-listener"))
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

CreateGroup

func (c *CamundaClient) CreateGroup(ctx context.Context, body GroupCreateRequest, opts ...func(ApiCreateGroupRequest) ApiCreateGroupRequest) (*GroupCreateResult, error)

Types: GroupCreateRequest, ApiCreateGroupRequest, GroupCreateResult

CreateGroup calls the CreateGroup operation.

Example:

result, err := client.CreateGroup(ctx, *camunda.NewGroupCreateRequest("finance", "Finance"))
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

CreateMappingRule

func (c *CamundaClient) CreateMappingRule(ctx context.Context, body MappingRuleCreateRequest, opts ...func(ApiCreateMappingRuleRequest) ApiCreateMappingRuleRequest) (*MappingRuleCreateResult, error)

Types: MappingRuleCreateRequest, ApiCreateMappingRuleRequest, MappingRuleCreateResult

CreateMappingRule calls the CreateMappingRule operation.

Example:

// Map the IdP claim `groups=auditors` to a Camunda mapping-rule identity.
result, err := client.CreateMappingRule(ctx,
	*camunda.NewMappingRuleCreateRequest("groups", "auditors", "SSO Auditors", "sso-auditors"))
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

CreateProcessInstance

func (c *CamundaClient) CreateProcessInstance(ctx context.Context, body ProcessInstanceCreationInstruction, opts ...func(ApiCreateProcessInstanceRequest) ApiCreateProcessInstanceRequest) (*CreateProcessInstanceResult, error)

Types: ProcessInstanceCreationInstruction, ApiCreateProcessInstanceRequest, CreateProcessInstanceResult

CreateProcessInstance creates (starts) a process instance.

When the gateway advertises the FALCON command stream (a nanobpmn gateway) and FALCON is enabled, the create is routed over the credit-metered WebSocket command stream: a flood of creates queues on the client's submission-credit window instead of being shed with 503s. Against stock Camunda — or if the stream cannot be established — it falls back transparently to the REST endpoint.

The variadic request-builder options apply only on the REST path.

Example:

instruction := camunda.ProcessInstanceCreationInstructionByIdAsProcessInstanceCreationInstruction(
	camunda.NewProcessInstanceCreationInstructionById("order-process"))
result, err := client.CreateProcessInstance(ctx, instruction)

CreateRole

func (c *CamundaClient) CreateRole(ctx context.Context, body RoleCreateRequest, opts ...func(ApiCreateRoleRequest) ApiCreateRoleRequest) (*RoleCreateResult, error)

Types: RoleCreateRequest, ApiCreateRoleRequest, RoleCreateResult

CreateRole calls the CreateRole operation.

Example:

result, err := client.CreateRole(ctx, *camunda.NewRoleCreateRequest("auditor", "Auditor"))
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

CreateTenant

func (c *CamundaClient) CreateTenant(ctx context.Context, body TenantCreateRequest, opts ...func(ApiCreateTenantRequest) ApiCreateTenantRequest) (*TenantCreateResult, error)

Types: TenantCreateRequest, ApiCreateTenantRequest, TenantCreateResult

CreateTenant calls the CreateTenant operation.

Example:

result, err := client.CreateTenant(ctx, *camunda.NewTenantCreateRequest("tenant-a", "Tenant A"))
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

CreateTenantClusterVariable

func (c *CamundaClient) CreateTenantClusterVariable(ctx context.Context, tenantId string, body CreateClusterVariableRequest, opts ...func(ApiCreateTenantClusterVariableRequest) ApiCreateTenantClusterVariableRequest) (*ClusterVariableResult, error)

Types: CreateClusterVariableRequest, ApiCreateTenantClusterVariableRequest, ClusterVariableResult

CreateTenantClusterVariable calls the CreateTenantClusterVariable operation.

Example:

result, err := client.CreateTenantClusterVariable(ctx, "tenant-a",
	*camunda.NewCreateClusterVariableRequest("region", map[string]any{"value": "eu-1"}))
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

CreateUser

func (c *CamundaClient) CreateUser(ctx context.Context, body UserRequest, opts ...func(ApiCreateUserRequest) ApiCreateUserRequest) (*UserCreateResult, error)

Types: UserRequest, ApiCreateUserRequest, UserCreateResult

CreateUser calls the CreateUser operation.

Example:

// "secure-password-123" is a placeholder — don't hardcode passwords in production.
req := camunda.NewUserRequest("secure-password-123", "alice")
req.SetName("Alice Example")
req.SetEmail("alice@example.com")

result, err := client.CreateUser(ctx, *req)
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

DeleteAuthorization

func (c *CamundaClient) DeleteAuthorization(ctx context.Context, authorizationKey AuthorizationKey, opts ...func(ApiDeleteAuthorizationRequest) ApiDeleteAuthorizationRequest) error

Types: AuthorizationKey, ApiDeleteAuthorizationRequest

DeleteAuthorization calls the DeleteAuthorization operation.

Example:

return client.DeleteAuthorization(ctx, camunda.MustAuthorizationKey("2251799813685280"))

DeleteDecisionInstance

func (c *CamundaClient) DeleteDecisionInstance(ctx context.Context, decisionEvaluationKey DecisionEvaluationKey, body DeleteDecisionInstanceRequest, opts ...func(ApiDeleteDecisionInstanceRequest) ApiDeleteDecisionInstanceRequest) error

Types: DecisionEvaluationKey, DeleteDecisionInstanceRequest, ApiDeleteDecisionInstanceRequest

DeleteDecisionInstance calls the DeleteDecisionInstance operation.

Example:

return client.DeleteDecisionInstance(ctx,
	camunda.MustDecisionEvaluationKey("2251799813685310"),
	*camunda.NewDeleteDecisionInstanceRequest())

DeleteDecisionInstancesBatchOperation

func (c *CamundaClient) DeleteDecisionInstancesBatchOperation(ctx context.Context, body DecisionInstanceDeletionBatchOperationRequest, opts ...func(ApiDeleteDecisionInstancesBatchOperationRequest) ApiDeleteDecisionInstancesBatchOperationRequest) (*BatchOperationCreatedResult, error)

Types: DecisionInstanceDeletionBatchOperationRequest, ApiDeleteDecisionInstancesBatchOperationRequest, BatchOperationCreatedResult

DeleteDecisionInstancesBatchOperation calls the DeleteDecisionInstancesBatchOperation operation.

Example:

req := camunda.NewDecisionInstanceDeletionBatchOperationRequest(*camunda.NewDecisionInstanceFilter())

result, err := client.DeleteDecisionInstancesBatchOperation(ctx, *req)
if err != nil {
	return err
}
fmt.Printf("created batch operation %v\n", result.GetBatchOperationKey())

DeleteDocument

func (c *CamundaClient) DeleteDocument(ctx context.Context, documentId string, opts ...func(ApiDeleteDocumentRequest) ApiDeleteDocumentRequest) error

Types: ApiDeleteDocumentRequest

DeleteDocument calls the DeleteDocument operation.

Example:

return client.DeleteDocument(ctx, "doc-123")

DeleteGlobalClusterVariable

func (c *CamundaClient) DeleteGlobalClusterVariable(ctx context.Context, name string, opts ...func(ApiDeleteGlobalClusterVariableRequest) ApiDeleteGlobalClusterVariableRequest) error

Types: ApiDeleteGlobalClusterVariableRequest

DeleteGlobalClusterVariable calls the DeleteGlobalClusterVariable operation.

Example:

return client.DeleteGlobalClusterVariable(ctx, "region")

DeleteGlobalTaskListener

func (c *CamundaClient) DeleteGlobalTaskListener(ctx context.Context, id string, opts ...func(ApiDeleteGlobalTaskListenerRequest) ApiDeleteGlobalTaskListenerRequest) error

Types: ApiDeleteGlobalTaskListenerRequest

DeleteGlobalTaskListener calls the DeleteGlobalTaskListener operation.

Example:

return client.DeleteGlobalTaskListener(ctx, "audit-listener")

DeleteGroup

func (c *CamundaClient) DeleteGroup(ctx context.Context, groupId string, opts ...func(ApiDeleteGroupRequest) ApiDeleteGroupRequest) error

Types: ApiDeleteGroupRequest

DeleteGroup calls the DeleteGroup operation.

Example:

return client.DeleteGroup(ctx, "finance")

DeleteHistoryBackup

func (c *CamundaClient) DeleteHistoryBackup(ctx context.Context, backupId int64, opts ...func(ApiDeleteHistoryBackupRequest) ApiDeleteHistoryBackupRequest) error

Types: ApiDeleteHistoryBackupRequest

DeleteHistoryBackup calls the DeleteHistoryBackup operation.

Example:

if err := client.DeleteHistoryBackup(ctx, 42); err != nil {
	return err
}

DeleteHistoryBackupAsClusterAdmin

func (c *CamundaClient) DeleteHistoryBackupAsClusterAdmin(ctx context.Context, backupId int64, opts ...func(ApiDeleteHistoryBackupAsClusterAdminRequest) ApiDeleteHistoryBackupAsClusterAdminRequest) error

Types: ApiDeleteHistoryBackupAsClusterAdminRequest

DeleteHistoryBackupAsClusterAdmin calls the DeleteHistoryBackupAsClusterAdmin operation.

Example:

if err := client.DeleteHistoryBackupAsClusterAdmin(ctx, 42); err != nil {
	return err
}

DeleteMappingRule

func (c *CamundaClient) DeleteMappingRule(ctx context.Context, mappingRuleId string, opts ...func(ApiDeleteMappingRuleRequest) ApiDeleteMappingRuleRequest) error

Types: ApiDeleteMappingRuleRequest

DeleteMappingRule calls the DeleteMappingRule operation.

Example:

return client.DeleteMappingRule(ctx, "sso-auditors")

DeleteProcessInstance

func (c *CamundaClient) DeleteProcessInstance(ctx context.Context, processInstanceKey ProcessInstanceKey, body DeleteProcessInstanceRequest, opts ...func(ApiDeleteProcessInstanceRequest) ApiDeleteProcessInstanceRequest) error

Types: ProcessInstanceKey, DeleteProcessInstanceRequest, ApiDeleteProcessInstanceRequest

DeleteProcessInstance calls the DeleteProcessInstance operation.

Example:

return client.DeleteProcessInstance(ctx,
	camunda.MustProcessInstanceKey("2251799813685340"),
	*camunda.NewDeleteProcessInstanceRequest())

DeleteProcessInstancesBatchOperation

func (c *CamundaClient) DeleteProcessInstancesBatchOperation(ctx context.Context, body ProcessInstanceDeletionBatchOperationRequest, opts ...func(ApiDeleteProcessInstancesBatchOperationRequest) ApiDeleteProcessInstancesBatchOperationRequest) (*BatchOperationCreatedResult, error)

Types: ProcessInstanceDeletionBatchOperationRequest, ApiDeleteProcessInstancesBatchOperationRequest, BatchOperationCreatedResult

DeleteProcessInstancesBatchOperation calls the DeleteProcessInstancesBatchOperation operation.

Example:

req := camunda.NewProcessInstanceDeletionBatchOperationRequest(*camunda.NewProcessInstanceFilter())

result, err := client.DeleteProcessInstancesBatchOperation(ctx, *req)
if err != nil {
	return err
}
fmt.Printf("created batch operation %v\n", result.GetBatchOperationKey())

DeleteResource

func (c *CamundaClient) DeleteResource(ctx context.Context, resourceKey ResourceKey, body DeleteResourceRequest, opts ...func(ApiDeleteResourceRequest) ApiDeleteResourceRequest) (*DeleteResourceResponse, error)

Types: ResourceKey, DeleteResourceRequest, ApiDeleteResourceRequest, DeleteResourceResponse

DeleteResource calls the DeleteResource operation.

Example:

result, err := client.DeleteResource(ctx,
	camunda.MustResourceKey("2251799813685350"),
	*camunda.NewDeleteResourceRequest())
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

DeleteRole

func (c *CamundaClient) DeleteRole(ctx context.Context, roleId string, opts ...func(ApiDeleteRoleRequest) ApiDeleteRoleRequest) error

Types: ApiDeleteRoleRequest

DeleteRole calls the DeleteRole operation.

Example:

return client.DeleteRole(ctx, "auditor")

DeleteRuntimeBackup

func (c *CamundaClient) DeleteRuntimeBackup(ctx context.Context, backupId int64, opts ...func(ApiDeleteRuntimeBackupRequest) ApiDeleteRuntimeBackupRequest) error

Types: ApiDeleteRuntimeBackupRequest

DeleteRuntimeBackup calls the DeleteRuntimeBackup operation.

Example:

if err := client.DeleteRuntimeBackup(ctx, 42); err != nil {
	return err
}

DeleteRuntimeBackupAsClusterAdmin

func (c *CamundaClient) DeleteRuntimeBackupAsClusterAdmin(ctx context.Context, backupId int64, opts ...func(ApiDeleteRuntimeBackupAsClusterAdminRequest) ApiDeleteRuntimeBackupAsClusterAdminRequest) error

Types: ApiDeleteRuntimeBackupAsClusterAdminRequest

DeleteRuntimeBackupAsClusterAdmin calls the DeleteRuntimeBackupAsClusterAdmin operation.

Example:

// Deletes the runtime backup with the given id from all physical tenants.
if err := client.DeleteRuntimeBackupAsClusterAdmin(ctx, 42); err != nil {
	return err
}

DeleteRuntimeBackupState

func (c *CamundaClient) DeleteRuntimeBackupState(ctx context.Context, opts ...func(ApiDeleteRuntimeBackupStateRequest) ApiDeleteRuntimeBackupStateRequest) error

Types: ApiDeleteRuntimeBackupStateRequest

DeleteRuntimeBackupState calls the DeleteRuntimeBackupState operation.

Example:

if err := client.DeleteRuntimeBackupState(ctx); err != nil {
	return err
}

DeleteRuntimeBackupStateAsClusterAdmin

func (c *CamundaClient) DeleteRuntimeBackupStateAsClusterAdmin(ctx context.Context, opts ...func(ApiDeleteRuntimeBackupStateAsClusterAdminRequest) ApiDeleteRuntimeBackupStateAsClusterAdminRequest) error

Types: ApiDeleteRuntimeBackupStateAsClusterAdminRequest

DeleteRuntimeBackupStateAsClusterAdmin calls the DeleteRuntimeBackupStateAsClusterAdmin operation.

Example:

// Clears the persisted runtime backup state across all physical tenants.
if err := client.DeleteRuntimeBackupStateAsClusterAdmin(ctx); err != nil {
	return err
}

DeleteTenant

func (c *CamundaClient) DeleteTenant(ctx context.Context, tenantId string, opts ...func(ApiDeleteTenantRequest) ApiDeleteTenantRequest) error

Types: ApiDeleteTenantRequest

DeleteTenant calls the DeleteTenant operation.

Example:

return client.DeleteTenant(ctx, "tenant-a")

DeleteTenantClusterVariable

func (c *CamundaClient) DeleteTenantClusterVariable(ctx context.Context, tenantId string, name string, opts ...func(ApiDeleteTenantClusterVariableRequest) ApiDeleteTenantClusterVariableRequest) error

Types: ApiDeleteTenantClusterVariableRequest

DeleteTenantClusterVariable calls the DeleteTenantClusterVariable operation.

Example:

return client.DeleteTenantClusterVariable(ctx, "tenant-a", "region")

DeleteUser

func (c *CamundaClient) DeleteUser(ctx context.Context, username string, opts ...func(ApiDeleteUserRequest) ApiDeleteUserRequest) error

Types: ApiDeleteUserRequest

DeleteUser calls the DeleteUser operation.

Example:

return client.DeleteUser(ctx, "alice")

EvaluateConditionals

func (c *CamundaClient) EvaluateConditionals(ctx context.Context, body ConditionalEvaluationInstruction, opts ...func(ApiEvaluateConditionalsRequest) ApiEvaluateConditionalsRequest) (*EvaluateConditionalResult, error)

Types: ConditionalEvaluationInstruction, ApiEvaluateConditionalsRequest, EvaluateConditionalResult

EvaluateConditionals calls the EvaluateConditionals operation.

Example:

// Evaluate which conditional start events match the given variables.
req := camunda.NewConditionalEvaluationInstruction(map[string]any{"temperature": 42})

result, err := client.EvaluateConditionals(ctx, *req)
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

EvaluateDecision

func (c *CamundaClient) EvaluateDecision(ctx context.Context, body DecisionEvaluationInstruction, opts ...func(ApiEvaluateDecisionRequest) ApiEvaluateDecisionRequest) (*EvaluateDecisionResult, error)

Types: DecisionEvaluationInstruction, ApiEvaluateDecisionRequest, EvaluateDecisionResult

EvaluateDecision calls the EvaluateDecision operation.

Example:

// DecisionEvaluationInstruction is a union; evaluate by decision id here.
byID := camunda.NewDecisionEvaluationById("dish-decision")
byID.SetVariables(map[string]any{"season": "Winter", "guestCount": 4})

result, err := client.EvaluateDecision(ctx,
	camunda.DecisionEvaluationByIdAsDecisionEvaluationInstruction(byID))
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

EvaluateExpression

func (c *CamundaClient) EvaluateExpression(ctx context.Context, body ExpressionEvaluationRequest, opts ...func(ApiEvaluateExpressionRequest) ApiEvaluateExpressionRequest) (*ExpressionEvaluationResult, error)

Types: ExpressionEvaluationRequest, ApiEvaluateExpressionRequest, ExpressionEvaluationResult

EvaluateExpression calls the EvaluateExpression operation.

Example:

// Evaluate a FEEL expression against a set of variables.
req := camunda.NewExpressionEvaluationRequest("a + b")
req.SetVariables(map[string]any{"a": 2, "b": 3})

result, err := client.EvaluateExpression(ctx, *req)
if err != nil {
	return err
}
fmt.Printf("result: %v\n", result.GetResult())

FailJob

func (c *CamundaClient) FailJob(ctx context.Context, jobKey JobKey, body JobFailRequest, opts ...func(ApiFailJobRequest) ApiFailJobRequest) error

Types: JobKey, JobFailRequest, ApiFailJobRequest

FailJob calls the FailJob operation.

Example:

req := camunda.NewJobFailRequest()
req.SetRetries(2)
req.SetErrorMessage("inventory service unavailable")

return client.FailJob(ctx, camunda.MustJobKey("2251799813685424"), *req)

GetAgentDefinition

func (c *CamundaClient) GetAgentDefinition(ctx context.Context, agentDefinitionKey AgentDefinitionKey, opts ...func(ApiGetAgentDefinitionRequest) ApiGetAgentDefinitionRequest) (*AgentDefinitionResult, error)

Types: AgentDefinitionKey, ApiGetAgentDefinitionRequest, AgentDefinitionResult

GetAgentDefinition calls the GetAgentDefinition operation.

Example:

definition, err := client.GetAgentDefinition(ctx, camunda.MustAgentDefinitionKey("2251799813691958"))
if err != nil {
	return err
}
fmt.Printf("%v\n", definition)

GetAgentInstance

func (c *CamundaClient) GetAgentInstance(ctx context.Context, agentInstanceKey AgentInstanceKey, opts ...func(ApiGetAgentInstanceRequest) ApiGetAgentInstanceRequest) (*AgentInstanceResult, error)

Types: AgentInstanceKey, ApiGetAgentInstanceRequest, AgentInstanceResult

GetAgentInstance calls the GetAgentInstance operation.

Example:

agent, err := client.GetAgentInstance(ctx, camunda.MustAgentInstanceKey("2251799813685370"))
if err != nil {
	return err
}
fmt.Printf("%v\n", agent)

GetAuditLog

func (c *CamundaClient) GetAuditLog(ctx context.Context, auditLogKey AuditLogKey, opts ...func(ApiGetAuditLogRequest) ApiGetAuditLogRequest) (*AuditLogResult, error)

Types: AuditLogKey, ApiGetAuditLogRequest, AuditLogResult

GetAuditLog calls the GetAuditLog operation.

Example:

entry, err := client.GetAuditLog(ctx, camunda.MustAuditLogKey("2251799813685270"))
if err != nil {
	return err
}
fmt.Printf("%v\n", entry)

GetAuthentication

func (c *CamundaClient) GetAuthentication(ctx context.Context, opts ...func(ApiGetAuthenticationRequest) ApiGetAuthenticationRequest) (*CamundaUserResult, error)

Types: ApiGetAuthenticationRequest, CamundaUserResult

GetAuthentication calls the GetAuthentication operation.

Example:

// Return the authenticated user derived from the current credentials.
me, err := client.GetAuthentication(ctx)
if err != nil {
	return err
}
fmt.Printf("authenticated as %s\n", me.GetUsername())

GetAuthorization

func (c *CamundaClient) GetAuthorization(ctx context.Context, authorizationKey AuthorizationKey, opts ...func(ApiGetAuthorizationRequest) ApiGetAuthorizationRequest) (*AuthorizationResult, error)

Types: AuthorizationKey, ApiGetAuthorizationRequest, AuthorizationResult

GetAuthorization calls the GetAuthorization operation.

Example:

auth, err := client.GetAuthorization(ctx, camunda.MustAuthorizationKey("2251799813685280"))
if err != nil {
	return err
}
fmt.Printf("%v\n", auth)

GetBatchOperation

func (c *CamundaClient) GetBatchOperation(ctx context.Context, batchOperationKey string, opts ...func(ApiGetBatchOperationRequest) ApiGetBatchOperationRequest) (*BatchOperationResponse, error)

Types: ApiGetBatchOperationRequest, BatchOperationResponse

GetBatchOperation calls the GetBatchOperation operation.

Example:

op, err := client.GetBatchOperation(ctx, "2251799813685290")
if err != nil {
	return err
}
fmt.Printf("%v\n", op)

GetClusterExportingStatus

func (c *CamundaClient) GetClusterExportingStatus(ctx context.Context, opts ...func(ApiGetClusterExportingStatusRequest) ApiGetClusterExportingStatusRequest) (*ExportingStatusResponse, error)

Types: ApiGetClusterExportingStatusRequest, ExportingStatusResponse

GetClusterExportingStatus calls the GetClusterExportingStatus operation.

Example:

// Retrieves the exporting status aggregated across all physical tenants in the cluster.
status, err := client.GetClusterExportingStatus(ctx)
if err != nil {
	return err
}
fmt.Printf("cluster exporting status: %s\n", status.GetStatus())

GetClusterRebalance

func (c *CamundaClient) GetClusterRebalance(ctx context.Context, opts ...func(ApiGetClusterRebalanceRequest) ApiGetClusterRebalanceRequest) (*ClusterBalanceResponse, error)

Types: ApiGetClusterRebalanceRequest, ClusterBalanceResponse

GetClusterRebalance calls the GetClusterRebalance operation.

Example:

// Requires cluster-admin credentials (a separate cluster-admin security chain) —
// calling this with standard Orchestration credentials will fail authorization.
balance, err := client.GetClusterRebalance(ctx)
if err != nil {
	return err
}
fmt.Printf("cluster balance state: %s, %d partition(s)\n", balance.GetState(), len(balance.GetPartitions()))
if running, ok := balance.GetRunningRebalanceOk(); ok && running != nil {
	fmt.Printf("rebalance in progress: %v\n", running)
}

GetClusterStatus

func (c *CamundaClient) GetClusterStatus(ctx context.Context, opts ...func(ApiGetClusterStatusRequest) ApiGetClusterStatusRequest) (*ClusterStatusResponse, error)

Types: ApiGetClusterStatusRequest, ClusterStatusResponse

GetClusterStatus calls the GetClusterStatus operation.

Example:

// Aggregated over every physical tenant: HEALTHY, DEGRADED, or DOWN.
status, err := client.GetClusterStatus(ctx)
if err != nil {
	return err
}
fmt.Printf("cluster status: %s\n", status.GetStatus())

GetClusterTopology

func (c *CamundaClient) GetClusterTopology(ctx context.Context, opts ...func(ApiGetClusterTopologyRequest) ApiGetClusterTopologyRequest) (*ClusterTopologyResponse, error)

Types: ApiGetClusterTopologyRequest, ClusterTopologyResponse

GetClusterTopology calls the GetClusterTopology operation.

Example:

// Returns the topology of all brokers across every physical tenant.
// Requires cluster-admin credentials (a separate cluster-admin security chain) —
// calling this with standard Orchestration credentials will fail authorization.
topology, err := client.GetClusterTopology(ctx)
if err != nil {
	return err
}
fmt.Printf("cluster %s — %d broker(s), %d physical tenant(s)\n",
	topology.GetClusterId(), len(topology.GetBrokers()), len(topology.GetPhysicalTenants()))

GetClusterUpgradeStatus

func (c *CamundaClient) GetClusterUpgradeStatus(ctx context.Context, opts ...func(ApiGetClusterUpgradeStatusRequest) ApiGetClusterUpgradeStatusRequest) (*ClusterUpgradeStatusResponse, error)

Types: ApiGetClusterUpgradeStatusRequest, ClusterUpgradeStatusResponse

GetClusterUpgradeStatus calls the GetClusterUpgradeStatus operation.

Example:

// One overall status folded over every physical tenant and condition:
// MIGRATED, MIGRATION_IN_PROGRESS, or UNKNOWN before anything has been reported yet.
status, err := client.GetClusterUpgradeStatus(ctx)
if err != nil {
	return err
}
fmt.Printf("cluster upgrade status: %s\n", status.GetStatus())

GetDecisionDefinition

func (c *CamundaClient) GetDecisionDefinition(ctx context.Context, decisionDefinitionKey DecisionDefinitionKey, opts ...func(ApiGetDecisionDefinitionRequest) ApiGetDecisionDefinitionRequest) (*DecisionDefinitionResult, error)

Types: DecisionDefinitionKey, ApiGetDecisionDefinitionRequest, DecisionDefinitionResult

GetDecisionDefinition calls the GetDecisionDefinition operation.

Example:

def, err := client.GetDecisionDefinition(ctx, camunda.MustDecisionDefinitionKey("2251799813685310"))
if err != nil {
	return err
}
fmt.Printf("%v\n", def)

GetDecisionDefinitionXML

func (c *CamundaClient) GetDecisionDefinitionXML(ctx context.Context, decisionDefinitionKey DecisionDefinitionKey, opts ...func(ApiGetDecisionDefinitionXMLRequest) ApiGetDecisionDefinitionXMLRequest) (string, error)

Types: DecisionDefinitionKey, ApiGetDecisionDefinitionXMLRequest

GetDecisionDefinitionXML calls the GetDecisionDefinitionXML operation.

Example:

xml, err := client.GetDecisionDefinitionXML(ctx, camunda.MustDecisionDefinitionKey("2251799813685310"))
if err != nil {
	return err
}
fmt.Println(xml)

GetDecisionInstance

func (c *CamundaClient) GetDecisionInstance(ctx context.Context, decisionEvaluationInstanceKey string, opts ...func(ApiGetDecisionInstanceRequest) ApiGetDecisionInstanceRequest) (*DecisionInstanceGetQueryResult, error)

Types: ApiGetDecisionInstanceRequest, DecisionInstanceGetQueryResult

GetDecisionInstance calls the GetDecisionInstance operation.

Example:

instance, err := client.GetDecisionInstance(ctx, "2251799813685310-1")
if err != nil {
	return err
}
fmt.Printf("%v\n", instance)

GetDecisionRequirements

func (c *CamundaClient) GetDecisionRequirements(ctx context.Context, decisionRequirementsKey DecisionRequirementsKey, opts ...func(ApiGetDecisionRequirementsRequest) ApiGetDecisionRequirementsRequest) (*DecisionRequirementsResult, error)

Types: DecisionRequirementsKey, ApiGetDecisionRequirementsRequest, DecisionRequirementsResult

GetDecisionRequirements calls the GetDecisionRequirements operation.

Example:

drd, err := client.GetDecisionRequirements(ctx, camunda.MustDecisionRequirementsKey("2251799813685320"))
if err != nil {
	return err
}
fmt.Printf("%v\n", drd)

GetDecisionRequirementsXML

func (c *CamundaClient) GetDecisionRequirementsXML(ctx context.Context, decisionRequirementsKey DecisionRequirementsKey, opts ...func(ApiGetDecisionRequirementsXMLRequest) ApiGetDecisionRequirementsXMLRequest) (string, error)

Types: DecisionRequirementsKey, ApiGetDecisionRequirementsXMLRequest

GetDecisionRequirementsXML calls the GetDecisionRequirementsXML operation.

Example:

xml, err := client.GetDecisionRequirementsXML(ctx, camunda.MustDecisionRequirementsKey("2251799813685320"))
if err != nil {
	return err
}
fmt.Println(xml)

GetDocument

func (c *CamundaClient) GetDocument(ctx context.Context, documentId string, opts ...func(ApiGetDocumentRequest) ApiGetDocumentRequest) (*os.File, error)

Types: ApiGetDocumentRequest

GetDocument calls the GetDocument operation.

Example:

file, err := client.GetDocument(ctx, "doc-123")
if err != nil {
	return err
}
fmt.Printf("downloaded to %s\n", file.Name())

GetElementInstance

func (c *CamundaClient) GetElementInstance(ctx context.Context, elementInstanceKey ElementInstanceKey, opts ...func(ApiGetElementInstanceRequest) ApiGetElementInstanceRequest) (*ElementInstanceResult, error)

Types: ElementInstanceKey, ApiGetElementInstanceRequest, ElementInstanceResult

GetElementInstance calls the GetElementInstance operation.

Example:

element, err := client.GetElementInstance(ctx, camunda.MustElementInstanceKey("2251799813685360"))
if err != nil {
	return err
}
fmt.Printf("%v\n", element)

GetExportingStatus

func (c *CamundaClient) GetExportingStatus(ctx context.Context, opts ...func(ApiGetExportingStatusRequest) ApiGetExportingStatusRequest) (*ExportingStatusResponse, error)

Types: ApiGetExportingStatusRequest, ExportingStatusResponse

GetExportingStatus calls the GetExportingStatus operation.

Example:

// Aggregated over every replica of the physical tenant.
status, err := client.GetExportingStatus(ctx)
if err != nil {
	return err
}
fmt.Printf("exporting status: %s\n", status.GetStatus())

GetFormByKey

func (c *CamundaClient) GetFormByKey(ctx context.Context, formKey FormKey, opts ...func(ApiGetFormByKeyRequest) ApiGetFormByKeyRequest) (*FormResult, error)

Types: FormKey, ApiGetFormByKeyRequest, FormResult

GetFormByKey calls the GetFormByKey operation.

Example:

form, err := client.GetFormByKey(ctx, camunda.MustFormKey("2251799813685260"))
if err != nil {
	return err
}
fmt.Printf("form %v version %d\n", form.GetFormId(), form.GetVersion())

GetGlobalClusterVariable

func (c *CamundaClient) GetGlobalClusterVariable(ctx context.Context, name string, opts ...func(ApiGetGlobalClusterVariableRequest) ApiGetGlobalClusterVariableRequest) (*ClusterVariableResult, error)

Types: ApiGetGlobalClusterVariableRequest, ClusterVariableResult

GetGlobalClusterVariable calls the GetGlobalClusterVariable operation.

Example:

result, err := client.GetGlobalClusterVariable(ctx, "region")
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

GetGlobalJobStatistics

func (c *CamundaClient) GetGlobalJobStatistics(ctx context.Context, opts ...func(ApiGetGlobalJobStatisticsRequest) ApiGetGlobalJobStatisticsRequest) (*GlobalJobStatisticsQueryResult, error)

Types: ApiGetGlobalJobStatisticsRequest, GlobalJobStatisticsQueryResult

GetGlobalJobStatistics calls the GetGlobalJobStatistics operation.

Example:

result, err := client.GetGlobalJobStatistics(ctx)
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

GetGlobalTaskListener

func (c *CamundaClient) GetGlobalTaskListener(ctx context.Context, id string, opts ...func(ApiGetGlobalTaskListenerRequest) ApiGetGlobalTaskListenerRequest) (*GlobalTaskListenerResult, error)

Types: ApiGetGlobalTaskListenerRequest, GlobalTaskListenerResult

GetGlobalTaskListener calls the GetGlobalTaskListener operation.

Example:

result, err := client.GetGlobalTaskListener(ctx, "audit-listener")
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

GetGroup

func (c *CamundaClient) GetGroup(ctx context.Context, groupId string, opts ...func(ApiGetGroupRequest) ApiGetGroupRequest) (*GroupResult, error)

Types: ApiGetGroupRequest, GroupResult

GetGroup calls the GetGroup operation.

Example:

group, err := client.GetGroup(ctx, "finance")
if err != nil {
	return err
}
fmt.Printf("%v\n", group)

GetHistoryBackup

func (c *CamundaClient) GetHistoryBackup(ctx context.Context, backupId int64, opts ...func(ApiGetHistoryBackupRequest) ApiGetHistoryBackupRequest) (*HistoryBackupInfo, error)

Types: ApiGetHistoryBackupRequest, HistoryBackupInfo

GetHistoryBackup calls the GetHistoryBackup operation.

Example:

backup, err := client.GetHistoryBackup(ctx, 42)
if err != nil {
	return err
}
fmt.Printf("history backup %d state=%v\n", backup.GetBackupId(), backup.GetState())
for _, snapshot := range backup.GetDetails() {
	fmt.Printf("  snapshot %v\n", snapshot)
}

GetHistoryBackupAsClusterAdmin

func (c *CamundaClient) GetHistoryBackupAsClusterAdmin(ctx context.Context, backupId int64, opts ...func(ApiGetHistoryBackupAsClusterAdminRequest) ApiGetHistoryBackupAsClusterAdminRequest) (*ClusterHistoryBackupInfo, error)

Types: ApiGetHistoryBackupAsClusterAdminRequest, ClusterHistoryBackupInfo

GetHistoryBackupAsClusterAdmin calls the GetHistoryBackupAsClusterAdmin operation.

Example:

backup, err := client.GetHistoryBackupAsClusterAdmin(ctx, 42)
if err != nil {
	return err
}
for _, tenant := range backup.GetPhysicalTenants() {
	fmt.Printf("tenant %s: state=%v\n", tenant.GetPhysicalTenantId(), tenant.GetState())
}

GetIncident

func (c *CamundaClient) GetIncident(ctx context.Context, incidentKey IncidentKey, opts ...func(ApiGetIncidentRequest) ApiGetIncidentRequest) (*IncidentResult, error)

Types: IncidentKey, ApiGetIncidentRequest, IncidentResult

GetIncident calls the GetIncident operation.

Example:

incident, err := client.GetIncident(ctx, camunda.MustIncidentKey("2251799813685300"))
if err != nil {
	return err
}
fmt.Printf("%v\n", incident)

GetJobErrorStatistics

func (c *CamundaClient) GetJobErrorStatistics(ctx context.Context, body JobErrorStatisticsQuery, opts ...func(ApiGetJobErrorStatisticsRequest) ApiGetJobErrorStatisticsRequest) (*JobErrorStatisticsQueryResult, error)

Types: JobErrorStatisticsQuery, ApiGetJobErrorStatisticsRequest, JobErrorStatisticsQueryResult

GetJobErrorStatistics calls the GetJobErrorStatistics operation.

Example:

from, to := time.Now().Add(-24*time.Hour), time.Now()
query := camunda.NewJobErrorStatisticsQuery(*camunda.NewJobErrorStatisticsFilter(from, to, "greet"))

result, err := client.GetJobErrorStatistics(ctx, *query)
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

GetJobTimeSeriesStatistics

func (c *CamundaClient) GetJobTimeSeriesStatistics(ctx context.Context, body JobTimeSeriesStatisticsQuery, opts ...func(ApiGetJobTimeSeriesStatisticsRequest) ApiGetJobTimeSeriesStatisticsRequest) (*JobTimeSeriesStatisticsQueryResult, error)

Types: JobTimeSeriesStatisticsQuery, ApiGetJobTimeSeriesStatisticsRequest, JobTimeSeriesStatisticsQueryResult

GetJobTimeSeriesStatistics calls the GetJobTimeSeriesStatistics operation.

Example:

from, to := time.Now().Add(-24*time.Hour), time.Now()
query := camunda.NewJobTimeSeriesStatisticsQuery(*camunda.NewJobTimeSeriesStatisticsFilter(from, to, "greet"))

result, err := client.GetJobTimeSeriesStatistics(ctx, *query)
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

GetJobTypeStatistics

func (c *CamundaClient) GetJobTypeStatistics(ctx context.Context, body JobTypeStatisticsQuery, opts ...func(ApiGetJobTypeStatisticsRequest) ApiGetJobTypeStatisticsRequest) (*JobTypeStatisticsQueryResult, error)

Types: JobTypeStatisticsQuery, ApiGetJobTypeStatisticsRequest, JobTypeStatisticsQueryResult

GetJobTypeStatistics calls the GetJobTypeStatistics operation.

Example:

result, err := client.GetJobTypeStatistics(ctx, *camunda.NewJobTypeStatisticsQuery())
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

GetJobWorkerStatistics

func (c *CamundaClient) GetJobWorkerStatistics(ctx context.Context, body JobWorkerStatisticsQuery, opts ...func(ApiGetJobWorkerStatisticsRequest) ApiGetJobWorkerStatisticsRequest) (*JobWorkerStatisticsQueryResult, error)

Types: JobWorkerStatisticsQuery, ApiGetJobWorkerStatisticsRequest, JobWorkerStatisticsQueryResult

GetJobWorkerStatistics calls the GetJobWorkerStatistics operation.

Example:

from, to := time.Now().Add(-24*time.Hour), time.Now()
query := camunda.NewJobWorkerStatisticsQuery(*camunda.NewJobWorkerStatisticsFilter(from, to, "greet"))

result, err := client.GetJobWorkerStatistics(ctx, *query)
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

GetLicense

func (c *CamundaClient) GetLicense(ctx context.Context, opts ...func(ApiGetLicenseRequest) ApiGetLicenseRequest) (*LicenseResponse, error)

Types: ApiGetLicenseRequest, LicenseResponse

GetLicense calls the GetLicense operation.

Example:

license, err := client.GetLicense(ctx)
if err != nil {
	return err
}
fmt.Printf("license type=%s valid=%v\n", license.GetLicenseType(), license.GetValidLicense())

GetMappingRule

func (c *CamundaClient) GetMappingRule(ctx context.Context, mappingRuleId string, opts ...func(ApiGetMappingRuleRequest) ApiGetMappingRuleRequest) (*MappingRuleResult, error)

Types: ApiGetMappingRuleRequest, MappingRuleResult

GetMappingRule calls the GetMappingRule operation.

Example:

rule, err := client.GetMappingRule(ctx, "sso-auditors")
if err != nil {
	return err
}
fmt.Printf("%v\n", rule)

GetProcessDefinition

func (c *CamundaClient) GetProcessDefinition(ctx context.Context, processDefinitionKey ProcessDefinitionKey, opts ...func(ApiGetProcessDefinitionRequest) ApiGetProcessDefinitionRequest) (*ProcessDefinitionResult, error)

Types: ProcessDefinitionKey, ApiGetProcessDefinitionRequest, ProcessDefinitionResult

GetProcessDefinition calls the GetProcessDefinition operation.

Example:

def, err := client.GetProcessDefinition(ctx, camunda.MustProcessDefinitionKey("2251799813685330"))
if err != nil {
	return err
}
fmt.Printf("%v\n", def)

GetProcessDefinitionInstanceStatistics

func (c *CamundaClient) GetProcessDefinitionInstanceStatistics(ctx context.Context, body ProcessDefinitionInstanceStatisticsQuery, opts ...func(ApiGetProcessDefinitionInstanceStatisticsRequest) ApiGetProcessDefinitionInstanceStatisticsRequest) (*ProcessDefinitionInstanceStatisticsQueryResult, error)

Types: ProcessDefinitionInstanceStatisticsQuery, ApiGetProcessDefinitionInstanceStatisticsRequest, ProcessDefinitionInstanceStatisticsQueryResult

GetProcessDefinitionInstanceStatistics calls the GetProcessDefinitionInstanceStatistics operation.

Example:

result, err := client.GetProcessDefinitionInstanceStatistics(ctx,
	*camunda.NewProcessDefinitionInstanceStatisticsQuery())
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

GetProcessDefinitionInstanceVersionStatistics

func (c *CamundaClient) GetProcessDefinitionInstanceVersionStatistics(ctx context.Context, body ProcessDefinitionInstanceVersionStatisticsQuery, opts ...func(ApiGetProcessDefinitionInstanceVersionStatisticsRequest) ApiGetProcessDefinitionInstanceVersionStatisticsRequest) (*ProcessDefinitionInstanceVersionStatisticsQueryResult, error)

Types: ProcessDefinitionInstanceVersionStatisticsQuery, ApiGetProcessDefinitionInstanceVersionStatisticsRequest, ProcessDefinitionInstanceVersionStatisticsQueryResult

GetProcessDefinitionInstanceVersionStatistics calls the GetProcessDefinitionInstanceVersionStatistics operation.

Example:

query := camunda.NewProcessDefinitionInstanceVersionStatisticsQuery(
	*camunda.NewProcessDefinitionInstanceVersionStatisticsFilter("order-process"))

result, err := client.GetProcessDefinitionInstanceVersionStatistics(ctx, *query)
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

GetProcessDefinitionMessageSubscriptionStatistics

func (c *CamundaClient) GetProcessDefinitionMessageSubscriptionStatistics(ctx context.Context, body ProcessDefinitionMessageSubscriptionStatisticsQuery, opts ...func(ApiGetProcessDefinitionMessageSubscriptionStatisticsRequest) ApiGetProcessDefinitionMessageSubscriptionStatisticsRequest) (*ProcessDefinitionMessageSubscriptionStatisticsQueryResult, error)

Types: ProcessDefinitionMessageSubscriptionStatisticsQuery, ApiGetProcessDefinitionMessageSubscriptionStatisticsRequest, ProcessDefinitionMessageSubscriptionStatisticsQueryResult

GetProcessDefinitionMessageSubscriptionStatistics calls the GetProcessDefinitionMessageSubscriptionStatistics operation.

Example:

result, err := client.GetProcessDefinitionMessageSubscriptionStatistics(ctx,
	*camunda.NewProcessDefinitionMessageSubscriptionStatisticsQuery())
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

GetProcessDefinitionStatistics

func (c *CamundaClient) GetProcessDefinitionStatistics(ctx context.Context, processDefinitionKey ProcessDefinitionKey, body ProcessDefinitionElementStatisticsQuery, opts ...func(ApiGetProcessDefinitionStatisticsRequest) ApiGetProcessDefinitionStatisticsRequest) (*ProcessDefinitionElementStatisticsQueryResult, error)

Types: ProcessDefinitionKey, ProcessDefinitionElementStatisticsQuery, ApiGetProcessDefinitionStatisticsRequest, ProcessDefinitionElementStatisticsQueryResult

GetProcessDefinitionStatistics calls the GetProcessDefinitionStatistics operation.

Example:

result, err := client.GetProcessDefinitionStatistics(ctx,
	camunda.MustProcessDefinitionKey("2251799813685330"),
	*camunda.NewProcessDefinitionElementStatisticsQuery())
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

GetProcessDefinitionXML

func (c *CamundaClient) GetProcessDefinitionXML(ctx context.Context, processDefinitionKey ProcessDefinitionKey, opts ...func(ApiGetProcessDefinitionXMLRequest) ApiGetProcessDefinitionXMLRequest) (string, error)

Types: ProcessDefinitionKey, ApiGetProcessDefinitionXMLRequest

GetProcessDefinitionXML calls the GetProcessDefinitionXML operation.

Example:

xml, err := client.GetProcessDefinitionXML(ctx, camunda.MustProcessDefinitionKey("2251799813685330"))
if err != nil {
	return err
}
fmt.Println(xml)

GetProcessInstance

func (c *CamundaClient) GetProcessInstance(ctx context.Context, processInstanceKey ProcessInstanceKey, opts ...func(ApiGetProcessInstanceRequest) ApiGetProcessInstanceRequest) (*ProcessInstanceResult, error)

Types: ProcessInstanceKey, ApiGetProcessInstanceRequest, ProcessInstanceResult

GetProcessInstance calls the GetProcessInstance operation.

Example:

instance, err := client.GetProcessInstance(ctx, camunda.MustProcessInstanceKey("2251799813685340"))
if err != nil {
	return err
}
fmt.Printf("state=%v definition=%q\n", instance.GetState(), instance.GetProcessDefinitionId())

GetProcessInstanceCallHierarchy

func (c *CamundaClient) GetProcessInstanceCallHierarchy(ctx context.Context, processInstanceKey ProcessInstanceKey, opts ...func(ApiGetProcessInstanceCallHierarchyRequest) ApiGetProcessInstanceCallHierarchyRequest) ([]ProcessInstanceCallHierarchyEntry, error)

Types: ProcessInstanceKey, ApiGetProcessInstanceCallHierarchyRequest, ProcessInstanceCallHierarchyEntry

GetProcessInstanceCallHierarchy calls the GetProcessInstanceCallHierarchy operation.

Example:

hierarchy, err := client.GetProcessInstanceCallHierarchy(ctx, camunda.MustProcessInstanceKey("2251799813685340"))
if err != nil {
	return err
}
for _, entry := range hierarchy {
	fmt.Printf("%v\n", entry)
}

GetProcessInstanceSequenceFlows

func (c *CamundaClient) GetProcessInstanceSequenceFlows(ctx context.Context, processInstanceKey ProcessInstanceKey, opts ...func(ApiGetProcessInstanceSequenceFlowsRequest) ApiGetProcessInstanceSequenceFlowsRequest) (*ProcessInstanceSequenceFlowsQueryResult, error)

Types: ProcessInstanceKey, ApiGetProcessInstanceSequenceFlowsRequest, ProcessInstanceSequenceFlowsQueryResult

GetProcessInstanceSequenceFlows calls the GetProcessInstanceSequenceFlows operation.

Example:

result, err := client.GetProcessInstanceSequenceFlows(ctx, camunda.MustProcessInstanceKey("2251799813685340"))
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

GetProcessInstanceStatistics

func (c *CamundaClient) GetProcessInstanceStatistics(ctx context.Context, processInstanceKey ProcessInstanceKey, opts ...func(ApiGetProcessInstanceStatisticsRequest) ApiGetProcessInstanceStatisticsRequest) (*ProcessInstanceElementStatisticsQueryResult, error)

Types: ProcessInstanceKey, ApiGetProcessInstanceStatisticsRequest, ProcessInstanceElementStatisticsQueryResult

GetProcessInstanceStatistics calls the GetProcessInstanceStatistics operation.

Example:

result, err := client.GetProcessInstanceStatistics(ctx, camunda.MustProcessInstanceKey("2251799813685340"))
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

GetProcessInstanceStatisticsByDefinition

func (c *CamundaClient) GetProcessInstanceStatisticsByDefinition(ctx context.Context, body IncidentProcessInstanceStatisticsByDefinitionQuery, opts ...func(ApiGetProcessInstanceStatisticsByDefinitionRequest) ApiGetProcessInstanceStatisticsByDefinitionRequest) (*IncidentProcessInstanceStatisticsByDefinitionQueryResult, error)

Types: IncidentProcessInstanceStatisticsByDefinitionQuery, ApiGetProcessInstanceStatisticsByDefinitionRequest, IncidentProcessInstanceStatisticsByDefinitionQueryResult

GetProcessInstanceStatisticsByDefinition calls the GetProcessInstanceStatisticsByDefinition operation.

Example:

query := camunda.NewIncidentProcessInstanceStatisticsByDefinitionQuery(
	*camunda.NewIncidentProcessInstanceStatisticsByDefinitionFilter(0))

result, err := client.GetProcessInstanceStatisticsByDefinition(ctx, *query)
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

GetProcessInstanceStatisticsByError

func (c *CamundaClient) GetProcessInstanceStatisticsByError(ctx context.Context, body IncidentProcessInstanceStatisticsByErrorQuery, opts ...func(ApiGetProcessInstanceStatisticsByErrorRequest) ApiGetProcessInstanceStatisticsByErrorRequest) (*IncidentProcessInstanceStatisticsByErrorQueryResult, error)

Types: IncidentProcessInstanceStatisticsByErrorQuery, ApiGetProcessInstanceStatisticsByErrorRequest, IncidentProcessInstanceStatisticsByErrorQueryResult

GetProcessInstanceStatisticsByError calls the GetProcessInstanceStatisticsByError operation.

Example:

result, err := client.GetProcessInstanceStatisticsByError(ctx,
	*camunda.NewIncidentProcessInstanceStatisticsByErrorQuery())
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

GetProcessInstanceWaitStateStatistics

func (c *CamundaClient) GetProcessInstanceWaitStateStatistics(ctx context.Context, processInstanceKey ProcessInstanceKey, opts ...func(ApiGetProcessInstanceWaitStateStatisticsRequest) ApiGetProcessInstanceWaitStateStatisticsRequest) (*ProcessInstanceWaitStateStatisticsQueryResult, error)

Types: ProcessInstanceKey, ApiGetProcessInstanceWaitStateStatisticsRequest, ProcessInstanceWaitStateStatisticsQueryResult

GetProcessInstanceWaitStateStatistics calls the GetProcessInstanceWaitStateStatistics operation.

Example:

result, err := client.GetProcessInstanceWaitStateStatistics(ctx, camunda.MustProcessInstanceKey("2251799813685340"))
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

GetResource

func (c *CamundaClient) GetResource(ctx context.Context, resourceKey ResourceKey, opts ...func(ApiGetResourceRequest) ApiGetResourceRequest) (*ResourceResult, error)

Types: ResourceKey, ApiGetResourceRequest, ResourceResult

GetResource calls the GetResource operation.

Example:

resource, err := client.GetResource(ctx, camunda.MustResourceKey("2251799813685350"))
if err != nil {
	return err
}
fmt.Printf("%v\n", resource)

GetResourceContent

func (c *CamundaClient) GetResourceContent(ctx context.Context, resourceKey ResourceKey, opts ...func(ApiGetResourceContentRequest) ApiGetResourceContentRequest) (map[string]interface{}, error)

Types: ResourceKey, ApiGetResourceContentRequest

GetResourceContent calls the GetResourceContent operation.

Example:

content, err := client.GetResourceContent(ctx, camunda.MustResourceKey("2251799813685350"))
if err != nil {
	return err
}
fmt.Printf("%v\n", content)

GetResourceContentBinary

func (c *CamundaClient) GetResourceContentBinary(ctx context.Context, resourceKey ResourceKey, opts ...func(ApiGetResourceContentBinaryRequest) ApiGetResourceContentBinaryRequest) (*os.File, error)

Types: ResourceKey, ApiGetResourceContentBinaryRequest

GetResourceContentBinary calls the GetResourceContentBinary operation.

Example:

file, err := client.GetResourceContentBinary(ctx, camunda.MustResourceKey("2251799813685350"))
if err != nil {
	return err
}
fmt.Printf("downloaded to %s\n", file.Name())

GetRestoreStatus

func (c *CamundaClient) GetRestoreStatus(ctx context.Context, opts ...func(ApiGetRestoreStatusRequest) ApiGetRestoreStatusRequest) (*RestoreStatusResponse, error)

Types: ApiGetRestoreStatusRequest, RestoreStatusResponse

GetRestoreStatus calls the GetRestoreStatus operation.

Example:

// Reports the in-flight restore only — 404 once it has finished.
status, err := client.GetRestoreStatus(ctx)
if err != nil {
	return err
}
fmt.Printf("restore %s: %s\n", status.GetChangeId(), status.GetStatus())
for _, broker := range status.GetBrokers() {
	fmt.Printf("%v\n", broker)
}

GetRole

func (c *CamundaClient) GetRole(ctx context.Context, roleId string, opts ...func(ApiGetRoleRequest) ApiGetRoleRequest) (*RoleResult, error)

Types: ApiGetRoleRequest, RoleResult

GetRole calls the GetRole operation.

Example:

role, err := client.GetRole(ctx, "auditor")
if err != nil {
	return err
}
fmt.Printf("%v\n", role)

GetRuntimeBackup

func (c *CamundaClient) GetRuntimeBackup(ctx context.Context, backupId int64, opts ...func(ApiGetRuntimeBackupRequest) ApiGetRuntimeBackupRequest) (*BackupInfo, error)

Types: ApiGetRuntimeBackupRequest, BackupInfo

GetRuntimeBackup calls the GetRuntimeBackup operation.

Example:

backup, err := client.GetRuntimeBackup(ctx, 42)
if err != nil {
	return err
}
// Details cover every partition of the physical tenant.
for _, partition := range backup.GetDetails() {
	fmt.Printf("%v\n", partition)
}

GetRuntimeBackupAsClusterAdmin

func (c *CamundaClient) GetRuntimeBackupAsClusterAdmin(ctx context.Context, backupId int64, opts ...func(ApiGetRuntimeBackupAsClusterAdminRequest) ApiGetRuntimeBackupAsClusterAdminRequest) (*ClusterRuntimeBackupInfo, error)

Types: ApiGetRuntimeBackupAsClusterAdminRequest, ClusterRuntimeBackupInfo

GetRuntimeBackupAsClusterAdmin calls the GetRuntimeBackupAsClusterAdmin operation.

Example:

backup, err := client.GetRuntimeBackupAsClusterAdmin(ctx, 42)
if err != nil {
	return err
}
fmt.Printf("cluster runtime backup %d: state=%v\n", backup.GetBackupId(), backup.GetState())
for _, tenant := range backup.GetPhysicalTenants() {
	fmt.Printf("  tenant %v\n", tenant)
}

GetRuntimeBackupState

func (c *CamundaClient) GetRuntimeBackupState(ctx context.Context, opts ...func(ApiGetRuntimeBackupStateRequest) ApiGetRuntimeBackupStateRequest) (*RuntimeBackupState, error)

Types: ApiGetRuntimeBackupStateRequest, RuntimeBackupState

GetRuntimeBackupState calls the GetRuntimeBackupState operation.

Example:

state, err := client.GetRuntimeBackupState(ctx)
if err != nil {
	return err
}
for _, checkpoint := range state.GetCheckpointStates() {
	fmt.Printf("%v\n", checkpoint)
}

GetRuntimeBackupStateAsClusterAdmin

func (c *CamundaClient) GetRuntimeBackupStateAsClusterAdmin(ctx context.Context, opts ...func(ApiGetRuntimeBackupStateAsClusterAdminRequest) ApiGetRuntimeBackupStateAsClusterAdminRequest) (*ClusterRuntimeBackupState, error)

Types: ApiGetRuntimeBackupStateAsClusterAdminRequest, ClusterRuntimeBackupState

GetRuntimeBackupStateAsClusterAdmin calls the GetRuntimeBackupStateAsClusterAdmin operation.

Example:

// Returns the runtime backup state for every physical tenant in the cluster.
state, err := client.GetRuntimeBackupStateAsClusterAdmin(ctx)
if err != nil {
	return err
}
for _, tenant := range state.GetPhysicalTenants() {
	fmt.Printf("%v\n", tenant)
}

GetStartProcessForm

func (c *CamundaClient) GetStartProcessForm(ctx context.Context, processDefinitionKey ProcessDefinitionKey, opts ...func(ApiGetStartProcessFormRequest) ApiGetStartProcessFormRequest) (*FormResult, error)

Types: ProcessDefinitionKey, ApiGetStartProcessFormRequest, FormResult

GetStartProcessForm calls the GetStartProcessForm operation.

Example:

form, err := client.GetStartProcessForm(ctx, camunda.MustProcessDefinitionKey("2251799813685330"))
if err != nil {
	return err
}
fmt.Printf("%v\n", form)

GetStatus

func (c *CamundaClient) GetStatus(ctx context.Context, opts ...func(ApiGetStatusRequest) ApiGetStatusRequest) error

Types: ApiGetStatusRequest

GetStatus calls the GetStatus operation.

Example:

// Readiness probe: returns a non-nil error when the cluster is not ready.
if err := client.GetStatus(ctx); err != nil {
	return err
}
fmt.Println("cluster is ready")

GetSystemConfiguration

func (c *CamundaClient) GetSystemConfiguration(ctx context.Context, opts ...func(ApiGetSystemConfigurationRequest) ApiGetSystemConfigurationRequest) (*SystemConfigurationResponse, error)

Types: ApiGetSystemConfigurationRequest, SystemConfigurationResponse

GetSystemConfiguration calls the GetSystemConfiguration operation.

Example:

config, err := client.GetSystemConfiguration(ctx)
if err != nil {
	return err
}
fmt.Printf("%v\n", config)

GetTenant

func (c *CamundaClient) GetTenant(ctx context.Context, tenantId string, opts ...func(ApiGetTenantRequest) ApiGetTenantRequest) (*TenantResult, error)

Types: ApiGetTenantRequest, TenantResult

GetTenant calls the GetTenant operation.

Example:

tenant, err := client.GetTenant(ctx, "tenant-a")
if err != nil {
	return err
}
fmt.Printf("%v\n", tenant)

GetTenantClusterVariable

func (c *CamundaClient) GetTenantClusterVariable(ctx context.Context, tenantId string, name string, opts ...func(ApiGetTenantClusterVariableRequest) ApiGetTenantClusterVariableRequest) (*ClusterVariableResult, error)

Types: ApiGetTenantClusterVariableRequest, ClusterVariableResult

GetTenantClusterVariable calls the GetTenantClusterVariable operation.

Example:

result, err := client.GetTenantClusterVariable(ctx, "tenant-a", "region")
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

GetTopology

func (c *CamundaClient) GetTopology(ctx context.Context, opts ...func(ApiGetTopologyRequest) ApiGetTopologyRequest) (*TopologyResponse, error)

Types: ApiGetTopologyRequest, TopologyResponse

GetTopology calls the GetTopology operation.

Example:

topology, err := client.GetTopology(ctx)
if err != nil {
	return err
}
fmt.Printf("gateway %s — %d broker(s), %d partition(s)\n",
	topology.GetGatewayVersion(), len(topology.GetBrokers()), topology.GetPartitionsCount())

GetUsageMetrics

func (c *CamundaClient) GetUsageMetrics(ctx context.Context, opts ...func(ApiGetUsageMetricsRequest) ApiGetUsageMetricsRequest) (*UsageMetricsResponse, error)

Types: ApiGetUsageMetricsRequest, UsageMetricsResponse

GetUsageMetrics calls the GetUsageMetrics operation.

Example:

metrics, err := client.GetUsageMetrics(ctx)
if err != nil {
	return err
}
fmt.Printf("%v\n", metrics)

GetUser

func (c *CamundaClient) GetUser(ctx context.Context, username string, opts ...func(ApiGetUserRequest) ApiGetUserRequest) (*UserResult, error)

Types: ApiGetUserRequest, UserResult

GetUser calls the GetUser operation.

Example:

user, err := client.GetUser(ctx, "alice")
if err != nil {
	return err
}
fmt.Printf("%v\n", user)

GetUserTask

func (c *CamundaClient) GetUserTask(ctx context.Context, userTaskKey UserTaskKey, opts ...func(ApiGetUserTaskRequest) ApiGetUserTaskRequest) (*UserTaskResult, error)

Types: UserTaskKey, ApiGetUserTaskRequest, UserTaskResult

GetUserTask calls the GetUserTask operation.

Example:

task, err := client.GetUserTask(ctx, camunda.MustUserTaskKey("2251799813685380"))
if err != nil {
	return err
}
fmt.Printf("%v\n", task)

GetUserTaskForm

func (c *CamundaClient) GetUserTaskForm(ctx context.Context, userTaskKey UserTaskKey, opts ...func(ApiGetUserTaskFormRequest) ApiGetUserTaskFormRequest) (*FormResult, error)

Types: UserTaskKey, ApiGetUserTaskFormRequest, FormResult

GetUserTaskForm calls the GetUserTaskForm operation.

Example:

form, err := client.GetUserTaskForm(ctx, camunda.MustUserTaskKey("2251799813685380"))
if err != nil {
	return err
}
fmt.Printf("%v\n", form)

GetVariable

func (c *CamundaClient) GetVariable(ctx context.Context, variableKey VariableKey, opts ...func(ApiGetVariableRequest) ApiGetVariableRequest) (*VariableResult, error)

Types: VariableKey, ApiGetVariableRequest, VariableResult

GetVariable calls the GetVariable operation.

Example:

variable, err := client.GetVariable(ctx, camunda.MustVariableKey("2251799813685390"))
if err != nil {
	return err
}
fmt.Printf("%v\n", variable)

ListHistoryBackups

func (c *CamundaClient) ListHistoryBackups(ctx context.Context, opts ...func(ApiListHistoryBackupsRequest) ApiListHistoryBackupsRequest) ([]HistoryBackupInfo, error)

Types: ApiListHistoryBackupsRequest, HistoryBackupInfo

ListHistoryBackups calls the ListHistoryBackups operation.

Example:

backups, err := client.ListHistoryBackups(ctx)
if err != nil {
	return err
}
for _, backup := range backups {
	fmt.Printf("history backup %d is %v\n", backup.GetBackupId(), backup.GetState())
}

ListHistoryBackupsAsClusterAdmin

func (c *CamundaClient) ListHistoryBackupsAsClusterAdmin(ctx context.Context, opts ...func(ApiListHistoryBackupsAsClusterAdminRequest) ApiListHistoryBackupsAsClusterAdminRequest) ([]ClusterHistoryBackupInfo, error)

Types: ApiListHistoryBackupsAsClusterAdminRequest, ClusterHistoryBackupInfo

ListHistoryBackupsAsClusterAdmin calls the ListHistoryBackupsAsClusterAdmin operation.

Example:

// Lists history backups across all physical tenants in the cluster.
backups, err := client.ListHistoryBackupsAsClusterAdmin(ctx)
if err != nil {
	return err
}
for _, backup := range backups {
	fmt.Printf("cluster history backup %d: %d tenant(s)\n", backup.GetBackupId(), len(backup.GetPhysicalTenants()))
}

ListRuntimeBackups

func (c *CamundaClient) ListRuntimeBackups(ctx context.Context, opts ...func(ApiListRuntimeBackupsRequest) ApiListRuntimeBackupsRequest) ([]BackupInfo, error)

Types: ApiListRuntimeBackupsRequest, BackupInfo

ListRuntimeBackups calls the ListRuntimeBackups operation.

Example:

backups, err := client.ListRuntimeBackups(ctx)
if err != nil {
	return err
}
for _, backup := range backups {
	fmt.Printf("backup %v is %v\n", backup.GetBackupId(), backup.GetState())
}

ListRuntimeBackupsAsClusterAdmin

func (c *CamundaClient) ListRuntimeBackupsAsClusterAdmin(ctx context.Context, opts ...func(ApiListRuntimeBackupsAsClusterAdminRequest) ApiListRuntimeBackupsAsClusterAdminRequest) ([]ClusterRuntimeBackupInfo, error)

Types: ApiListRuntimeBackupsAsClusterAdminRequest, ClusterRuntimeBackupInfo

ListRuntimeBackupsAsClusterAdmin calls the ListRuntimeBackupsAsClusterAdmin operation.

Example:

// Lists runtime backups across all physical tenants in the cluster.
backups, err := client.ListRuntimeBackupsAsClusterAdmin(ctx)
if err != nil {
	return err
}
for _, backup := range backups {
	fmt.Printf("cluster runtime backup %d: state=%v, %d tenant(s)\n",
		backup.GetBackupId(), backup.GetState(), len(backup.GetPhysicalTenants()))
}

ListSecrets

func (c *CamundaClient) ListSecrets(ctx context.Context, opts ...func(ApiListSecretsRequest) ApiListSecretsRequest) (*SecretListResult, error)

Types: ApiListSecretsRequest, SecretListResult

ListSecrets calls the ListSecrets operation.

Example:

// Returns only the references the caller is authorized to see — never values.
result, err := client.ListSecrets(ctx)
if err != nil {
	return err
}
for _, reference := range result.GetReferences() {
	fmt.Printf("%v\n", reference)
}

MigrateProcessInstance

func (c *CamundaClient) MigrateProcessInstance(ctx context.Context, processInstanceKey ProcessInstanceKey, body ProcessInstanceMigrationInstruction, opts ...func(ApiMigrateProcessInstanceRequest) ApiMigrateProcessInstanceRequest) error

Types: ProcessInstanceKey, ProcessInstanceMigrationInstruction, ApiMigrateProcessInstanceRequest

MigrateProcessInstance calls the MigrateProcessInstance operation.

Example:

instruction := camunda.NewProcessInstanceMigrationInstruction(
	camunda.ProcessDefinitionKey("2251799813685399"),
	[]camunda.MigrateProcessInstanceMappingInstruction{
		*camunda.NewMigrateProcessInstanceMappingInstruction("review", "review-v2"),
	})

return client.MigrateProcessInstance(ctx, camunda.MustProcessInstanceKey("2251799813685340"), *instruction)

MigrateProcessInstancesBatchOperation

func (c *CamundaClient) MigrateProcessInstancesBatchOperation(ctx context.Context, body ProcessInstanceMigrationBatchOperationRequest, opts ...func(ApiMigrateProcessInstancesBatchOperationRequest) ApiMigrateProcessInstancesBatchOperationRequest) (*BatchOperationCreatedResult, error)

Types: ProcessInstanceMigrationBatchOperationRequest, ApiMigrateProcessInstancesBatchOperationRequest, BatchOperationCreatedResult

MigrateProcessInstancesBatchOperation calls the MigrateProcessInstancesBatchOperation operation.

Example:

plan := camunda.NewProcessInstanceMigrationBatchOperationPlan(
	camunda.ProcessDefinitionKey("2251799813685399"),
	[]camunda.MigrateProcessInstanceMappingInstruction{
		*camunda.NewMigrateProcessInstanceMappingInstruction("review", "review-v2"),
	})
req := camunda.NewProcessInstanceMigrationBatchOperationRequest(*camunda.NewProcessInstanceFilter(), *plan)

result, err := client.MigrateProcessInstancesBatchOperation(ctx, *req)
if err != nil {
	return err
}
fmt.Printf("created batch operation %v\n", result.GetBatchOperationKey())

ModifyProcessInstance

func (c *CamundaClient) ModifyProcessInstance(ctx context.Context, processInstanceKey ProcessInstanceKey, body ProcessInstanceModificationInstruction, opts ...func(ApiModifyProcessInstanceRequest) ApiModifyProcessInstanceRequest) error

Types: ProcessInstanceKey, ProcessInstanceModificationInstruction, ApiModifyProcessInstanceRequest

ModifyProcessInstance calls the ModifyProcessInstance operation.

Example:

return client.ModifyProcessInstance(ctx,
	camunda.MustProcessInstanceKey("2251799813685340"),
	*camunda.NewProcessInstanceModificationInstruction())

ModifyProcessInstancesBatchOperation

func (c *CamundaClient) ModifyProcessInstancesBatchOperation(ctx context.Context, body ProcessInstanceModificationBatchOperationRequest, opts ...func(ApiModifyProcessInstancesBatchOperationRequest) ApiModifyProcessInstancesBatchOperationRequest) (*BatchOperationCreatedResult, error)

Types: ProcessInstanceModificationBatchOperationRequest, ApiModifyProcessInstancesBatchOperationRequest, BatchOperationCreatedResult

ModifyProcessInstancesBatchOperation calls the ModifyProcessInstancesBatchOperation operation.

Example:

req := camunda.NewProcessInstanceModificationBatchOperationRequest(
	*camunda.NewProcessInstanceFilter(),
	[]camunda.ProcessInstanceModificationMoveBatchOperationInstruction{
		*camunda.NewProcessInstanceModificationMoveBatchOperationInstruction("review", "approve"),
	})

result, err := client.ModifyProcessInstancesBatchOperation(ctx, *req)
if err != nil {
	return err
}
fmt.Printf("created batch operation %v\n", result.GetBatchOperationKey())

NewJobWorker

func (c *CamundaClient) NewJobWorker(jobType string, handler JobHandler, opts ...WorkerOption) *JobWorker

NewJobWorker creates a worker for jobType. Defaults are seeded from the client's CAMUNDA_WORKER_* configuration and can be overridden with options.

NewStreamJobWorker

func (c *CamundaClient) NewStreamJobWorker(jobType string, handler JobHandler, opts ...StreamWorkerOption) *StreamJobWorker

NewStreamJobWorker creates a gRPC streaming worker for jobType. Defaults are seeded from the client's CAMUNDA_WORKER_* configuration and can be overridden with options.

PauseClusterExporting

func (c *CamundaClient) PauseClusterExporting(ctx context.Context, opts ...func(ApiPauseClusterExportingRequest) ApiPauseClusterExportingRequest) error

Types: ApiPauseClusterExportingRequest

PauseClusterExporting calls the PauseClusterExporting operation.

Example:

// Pauses exporting across all physical tenants in the cluster.
// While paused, reads from secondary storage stop advancing for every tenant.
if err := client.PauseClusterExporting(ctx); err != nil {
	return err
}

PauseExporting

func (c *CamundaClient) PauseExporting(ctx context.Context, opts ...func(ApiPauseExportingRequest) ApiPauseExportingRequest) error

Types: ApiPauseExportingRequest

PauseExporting calls the PauseExporting operation.

Example:

// While exporting is paused, reads from secondary storage stop advancing.
if err := client.PauseExporting(ctx); err != nil {
	return err
}

PinAt

func (c *CamundaClient) PinAt(ctx context.Context, t time.Time) error

PinAt moves the engine clock to t.

PinClock

func (c *CamundaClient) PinClock(ctx context.Context, body ClockPinRequest, opts ...func(ApiPinClockRequest) ApiPinClockRequest) error

Types: ClockPinRequest, ApiPinClockRequest

PinClock calls the PinClock operation.

Example:

// Pin the cluster clock to a fixed instant (epoch milliseconds).
pinned := time.Date(2025, time.January, 1, 0, 0, 0, 0, time.UTC)
return client.PinClock(ctx, *camunda.NewClockPinRequest(pinned.UnixMilli()))

PublishMessage

func (c *CamundaClient) PublishMessage(ctx context.Context, body MessagePublicationRequest, opts ...func(ApiPublishMessageRequest) ApiPublishMessageRequest) (*MessagePublicationResult, error)

Types: MessagePublicationRequest, ApiPublishMessageRequest, MessagePublicationResult

PublishMessage calls the PublishMessage operation.

Example:

req := camunda.NewMessagePublicationRequest("order-confirmed")
req.SetCorrelationKey("order-42")
req.SetVariables(map[string]any{"confirmedBy": "payment-service"})

result, err := client.PublishMessage(ctx, *req)
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

Raw

func (c *CamundaClient) Raw() *camundaapi.APIClient

Raw returns the underlying generated client for operations or options not yet surfaced on the ergonomic facade.

ResetClock

func (c *CamundaClient) ResetClock(ctx context.Context, opts ...func(ApiResetClockRequest) ApiResetClockRequest) error

Types: ApiResetClockRequest

ResetClock calls the ResetClock operation.

Example:

// Release a previously pinned clock back to system time.
return client.ResetClock(ctx)

ResetToLive

func (c *CamundaClient) ResetToLive(ctx context.Context) error

ResetToLive returns the engine clock to real time.

ResolveIncident

func (c *CamundaClient) ResolveIncident(ctx context.Context, incidentKey IncidentKey, body IncidentResolutionRequest, opts ...func(ApiResolveIncidentRequest) ApiResolveIncidentRequest) error

Types: IncidentKey, IncidentResolutionRequest, ApiResolveIncidentRequest

ResolveIncident calls the ResolveIncident operation.

Example:

// After fixing the root cause (e.g. correcting a variable), resolve the
// incident so the engine retries the failed element.
return client.ResolveIncident(ctx,
	camunda.MustIncidentKey("2251799813685300"),
	*camunda.NewIncidentResolutionRequest())

ResolveIncidentsBatchOperation

func (c *CamundaClient) ResolveIncidentsBatchOperation(ctx context.Context, body ProcessInstanceIncidentResolutionBatchOperationRequest, opts ...func(ApiResolveIncidentsBatchOperationRequest) ApiResolveIncidentsBatchOperationRequest) (*BatchOperationCreatedResult, error)

Types: ProcessInstanceIncidentResolutionBatchOperationRequest, ApiResolveIncidentsBatchOperationRequest, BatchOperationCreatedResult

ResolveIncidentsBatchOperation calls the ResolveIncidentsBatchOperation operation.

Example:

req := camunda.NewProcessInstanceIncidentResolutionBatchOperationRequest(*camunda.NewProcessInstanceFilter())

result, err := client.ResolveIncidentsBatchOperation(ctx, *req)
if err != nil {
	return err
}
fmt.Printf("created batch operation %v\n", result.GetBatchOperationKey())

ResolveProcessInstanceIncidents

func (c *CamundaClient) ResolveProcessInstanceIncidents(ctx context.Context, processInstanceKey ProcessInstanceKey, opts ...func(ApiResolveProcessInstanceIncidentsRequest) ApiResolveProcessInstanceIncidentsRequest) (*BatchOperationCreatedResult, error)

Types: ProcessInstanceKey, ApiResolveProcessInstanceIncidentsRequest, BatchOperationCreatedResult

ResolveProcessInstanceIncidents calls the ResolveProcessInstanceIncidents operation.

Example:

result, err := client.ResolveProcessInstanceIncidents(ctx, camunda.MustProcessInstanceKey("2251799813685340"))
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

ResolveSecrets

func (c *CamundaClient) ResolveSecrets(ctx context.Context, body SecretResolveRequest, opts ...func(ApiResolveSecretsRequest) ApiResolveSecretsRequest) (*SecretResolveResult, error)

Types: SecretResolveRequest, ApiResolveSecretsRequest, SecretResolveResult

ResolveSecrets calls the ResolveSecrets operation.

Example:

// References take the form `camunda.secrets.<name>`.
req := camunda.NewSecretResolveRequest([]string{"camunda.secrets.MY_API_KEY", "camunda.secrets.MY_TOKEN"})

result, err := client.ResolveSecrets(ctx, *req)
if err != nil {
	return err
}
for _, secret := range result.GetResolved() {
	fmt.Printf("%v = %v\n", secret.GetReference(), secret.GetValue())
}

Restore

func (c *CamundaClient) Restore(ctx context.Context, body RestoreRequest, opts ...func(ApiRestoreRequest) ApiRestoreRequest) (*ClusterRestoreResponse, error)

Types: RestoreRequest, ApiRestoreRequest, ClusterRestoreResponse

Restore calls the Restore operation.

Example:

result, err := client.Restore(ctx, *camunda.NewRestoreRequest())
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

RestoreAsClusterAdmin

func (c *CamundaClient) RestoreAsClusterAdmin(ctx context.Context, body ClusterRestoreRequest, opts ...func(ApiRestoreAsClusterAdminRequest) ApiRestoreAsClusterAdminRequest) (*ClusterRestoreResponse, error)

Types: ClusterRestoreRequest, ApiRestoreAsClusterAdminRequest, ClusterRestoreResponse

RestoreAsClusterAdmin calls the RestoreAsClusterAdmin operation.

Example:

// Triggers a cluster-level restore (cluster-admin authority), restoring from the given backup IDs.
// backupIds are one per partition, so the placeholder slice below must be extended to
// match the actual partition count of the target cluster (shown here for a 2-partition cluster).
restoreRequest := camunda.NewClusterRestoreRequestWithDefaults()
restoreRequest.SetBackupIds([]int64{1, 2})
result, err := client.RestoreAsClusterAdmin(ctx, *restoreRequest)
if err != nil {
	return err
}
fmt.Printf("restore change id: %s\n", result.GetChangeId())

ResumeBatchOperation

func (c *CamundaClient) ResumeBatchOperation(ctx context.Context, batchOperationKey string, opts ...func(ApiResumeBatchOperationRequest) ApiResumeBatchOperationRequest) error

Types: ApiResumeBatchOperationRequest

ResumeBatchOperation calls the ResumeBatchOperation operation.

Example:

return client.ResumeBatchOperation(ctx, "2251799813685290")

ResumeClusterExporting

func (c *CamundaClient) ResumeClusterExporting(ctx context.Context, opts ...func(ApiResumeClusterExportingRequest) ApiResumeClusterExportingRequest) error

Types: ApiResumeClusterExportingRequest

ResumeClusterExporting calls the ResumeClusterExporting operation.

Example:

// Resumes exporting across all physical tenants in the cluster.
if err := client.ResumeClusterExporting(ctx); err != nil {
	return err
}

ResumeExporting

func (c *CamundaClient) ResumeExporting(ctx context.Context, opts ...func(ApiResumeExportingRequest) ApiResumeExportingRequest) error

Types: ApiResumeExportingRequest

ResumeExporting calls the ResumeExporting operation.

Example:

if err := client.ResumeExporting(ctx); err != nil {
	return err
}

ResumeProcessInstance

func (c *CamundaClient) ResumeProcessInstance(ctx context.Context, processInstanceKey ProcessInstanceKey, body ResumeProcessInstanceRequest, opts ...func(ApiResumeProcessInstanceRequest) ApiResumeProcessInstanceRequest) error

Types: ProcessInstanceKey, ResumeProcessInstanceRequest, ApiResumeProcessInstanceRequest

ResumeProcessInstance calls the ResumeProcessInstance operation.

Example:

return client.ResumeProcessInstance(ctx,
	camunda.MustProcessInstanceKey("2251799813685340"),
	*camunda.NewResumeProcessInstanceRequest())

ResumeProcessInstancesBatchOperation

func (c *CamundaClient) ResumeProcessInstancesBatchOperation(ctx context.Context, body ProcessInstanceResumptionBatchOperationRequest, opts ...func(ApiResumeProcessInstancesBatchOperationRequest) ApiResumeProcessInstancesBatchOperationRequest) (*BatchOperationCreatedResult, error)

Types: ProcessInstanceResumptionBatchOperationRequest, ApiResumeProcessInstancesBatchOperationRequest, BatchOperationCreatedResult

ResumeProcessInstancesBatchOperation calls the ResumeProcessInstancesBatchOperation operation.

Example:

// Resume every previously-suspended instance matching a filter.
req := camunda.NewProcessInstanceResumptionBatchOperationRequest(*camunda.NewProcessInstanceFilter())

result, err := client.ResumeProcessInstancesBatchOperation(ctx, *req)
if err != nil {
	return err
}
fmt.Printf("created batch operation %v\n", result.GetBatchOperationKey())

SearchAgentDefinitions

func (c *CamundaClient) SearchAgentDefinitions(ctx context.Context, body AgentDefinitionSearchQuery, opts ...func(ApiSearchAgentDefinitionsRequest) ApiSearchAgentDefinitionsRequest) (*AgentDefinitionSearchQueryResult, error)

Types: AgentDefinitionSearchQuery, ApiSearchAgentDefinitionsRequest, AgentDefinitionSearchQueryResult

SearchAgentDefinitions calls the SearchAgentDefinitions operation.

Example:

result, err := client.SearchAgentDefinitions(ctx, *camunda.NewAgentDefinitionSearchQuery())
if err != nil {
	return err
}
for _, d := range result.GetItems() {
	fmt.Printf("%v\n", d)
}

SearchAgentInstanceHistory

func (c *CamundaClient) SearchAgentInstanceHistory(ctx context.Context, agentInstanceKey AgentInstanceKey, body AgentInstanceHistorySearchQuery, opts ...func(ApiSearchAgentInstanceHistoryRequest) ApiSearchAgentInstanceHistoryRequest) (*AgentInstanceHistorySearchQueryResult, error)

Types: AgentInstanceKey, AgentInstanceHistorySearchQuery, ApiSearchAgentInstanceHistoryRequest, AgentInstanceHistorySearchQueryResult

SearchAgentInstanceHistory calls the SearchAgentInstanceHistory operation.

Example:

result, err := client.SearchAgentInstanceHistory(ctx,
	camunda.MustAgentInstanceKey("2251799813685370"),
	*camunda.NewAgentInstanceHistorySearchQuery())
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

SearchAgentInstances

func (c *CamundaClient) SearchAgentInstances(ctx context.Context, body AgentInstanceSearchQuery, opts ...func(ApiSearchAgentInstancesRequest) ApiSearchAgentInstancesRequest) (*AgentInstanceSearchQueryResult, error)

Types: AgentInstanceSearchQuery, ApiSearchAgentInstancesRequest, AgentInstanceSearchQueryResult

SearchAgentInstances calls the SearchAgentInstances operation.

Example:

result, err := client.SearchAgentInstances(ctx, *camunda.NewAgentInstanceSearchQuery())
if err != nil {
	return err
}
for _, a := range result.GetItems() {
	fmt.Printf("%v\n", a)
}

SearchAuditLogs

func (c *CamundaClient) SearchAuditLogs(ctx context.Context, body AuditLogSearchQueryRequest, opts ...func(ApiSearchAuditLogsRequest) ApiSearchAuditLogsRequest) (*AuditLogSearchQueryResult, error)

Types: AuditLogSearchQueryRequest, ApiSearchAuditLogsRequest, AuditLogSearchQueryResult

SearchAuditLogs calls the SearchAuditLogs operation.

Example:

result, err := client.SearchAuditLogs(ctx, *camunda.NewAuditLogSearchQueryRequest())
if err != nil {
	return err
}
for _, entry := range result.GetItems() {
	fmt.Printf("%v\n", entry)
}

SearchAuthorizations

func (c *CamundaClient) SearchAuthorizations(ctx context.Context, body AuthorizationSearchQuery, opts ...func(ApiSearchAuthorizationsRequest) ApiSearchAuthorizationsRequest) (*AuthorizationSearchResult, error)

Types: AuthorizationSearchQuery, ApiSearchAuthorizationsRequest, AuthorizationSearchResult

SearchAuthorizations calls the SearchAuthorizations operation.

Example:

result, err := client.SearchAuthorizations(ctx, *camunda.NewAuthorizationSearchQuery())
if err != nil {
	return err
}
for _, a := range result.GetItems() {
	fmt.Printf("%v\n", a)
}

SearchBatchOperationItems

func (c *CamundaClient) SearchBatchOperationItems(ctx context.Context, body BatchOperationItemSearchQuery, opts ...func(ApiSearchBatchOperationItemsRequest) ApiSearchBatchOperationItemsRequest) (*BatchOperationItemSearchQueryResult, error)

Types: BatchOperationItemSearchQuery, ApiSearchBatchOperationItemsRequest, BatchOperationItemSearchQueryResult

SearchBatchOperationItems calls the SearchBatchOperationItems operation.

Example:

result, err := client.SearchBatchOperationItems(ctx, *camunda.NewBatchOperationItemSearchQuery())
if err != nil {
	return err
}
for _, item := range result.GetItems() {
	fmt.Printf("%v\n", item)
}

SearchBatchOperations

func (c *CamundaClient) SearchBatchOperations(ctx context.Context, body BatchOperationSearchQuery, opts ...func(ApiSearchBatchOperationsRequest) ApiSearchBatchOperationsRequest) (*BatchOperationSearchQueryResult, error)

Types: BatchOperationSearchQuery, ApiSearchBatchOperationsRequest, BatchOperationSearchQueryResult

SearchBatchOperations calls the SearchBatchOperations operation.

Example:

result, err := client.SearchBatchOperations(ctx, *camunda.NewBatchOperationSearchQuery())
if err != nil {
	return err
}
for _, op := range result.GetItems() {
	fmt.Printf("%v\n", op)
}

SearchClientsForGroup

func (c *CamundaClient) SearchClientsForGroup(ctx context.Context, groupId string, body GroupClientSearchQueryRequest, opts ...func(ApiSearchClientsForGroupRequest) ApiSearchClientsForGroupRequest) (*GroupClientSearchResult, error)

Types: GroupClientSearchQueryRequest, ApiSearchClientsForGroupRequest, GroupClientSearchResult

SearchClientsForGroup calls the SearchClientsForGroup operation.

Example:

result, err := client.SearchClientsForGroup(ctx, "finance", *camunda.NewGroupClientSearchQueryRequest())
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

SearchClientsForRole

func (c *CamundaClient) SearchClientsForRole(ctx context.Context, roleId string, body RoleClientSearchQueryRequest, opts ...func(ApiSearchClientsForRoleRequest) ApiSearchClientsForRoleRequest) (*RoleClientSearchResult, error)

Types: RoleClientSearchQueryRequest, ApiSearchClientsForRoleRequest, RoleClientSearchResult

SearchClientsForRole calls the SearchClientsForRole operation.

Example:

result, err := client.SearchClientsForRole(ctx, "auditor", *camunda.NewRoleClientSearchQueryRequest())
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

SearchClientsForTenant

func (c *CamundaClient) SearchClientsForTenant(ctx context.Context, tenantId string, body TenantClientSearchQueryRequest, opts ...func(ApiSearchClientsForTenantRequest) ApiSearchClientsForTenantRequest) (*TenantClientSearchResult, error)

Types: TenantClientSearchQueryRequest, ApiSearchClientsForTenantRequest, TenantClientSearchResult

SearchClientsForTenant calls the SearchClientsForTenant operation.

Example:

result, err := client.SearchClientsForTenant(ctx, "tenant-a", *camunda.NewTenantClientSearchQueryRequest())
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

SearchClusterVariables

func (c *CamundaClient) SearchClusterVariables(ctx context.Context, body ClusterVariableSearchQueryRequest, opts ...func(ApiSearchClusterVariablesRequest) ApiSearchClusterVariablesRequest) (*ClusterVariableSearchQueryResult, error)

Types: ClusterVariableSearchQueryRequest, ApiSearchClusterVariablesRequest, ClusterVariableSearchQueryResult

SearchClusterVariables calls the SearchClusterVariables operation.

Example:

result, err := client.SearchClusterVariables(ctx, *camunda.NewClusterVariableSearchQueryRequest())
if err != nil {
	return err
}
for _, v := range result.GetItems() {
	fmt.Printf("%v\n", v)
}

SearchCorrelatedMessageSubscriptions

func (c *CamundaClient) SearchCorrelatedMessageSubscriptions(ctx context.Context, body CorrelatedMessageSubscriptionSearchQuery, opts ...func(ApiSearchCorrelatedMessageSubscriptionsRequest) ApiSearchCorrelatedMessageSubscriptionsRequest) (*CorrelatedMessageSubscriptionSearchQueryResult, error)

Types: CorrelatedMessageSubscriptionSearchQuery, ApiSearchCorrelatedMessageSubscriptionsRequest, CorrelatedMessageSubscriptionSearchQueryResult

SearchCorrelatedMessageSubscriptions calls the SearchCorrelatedMessageSubscriptions operation.

Example:

result, err := client.SearchCorrelatedMessageSubscriptions(ctx,
	*camunda.NewCorrelatedMessageSubscriptionSearchQuery())
if err != nil {
	return err
}
for _, s := range result.GetItems() {
	fmt.Printf("%v\n", s)
}

SearchDecisionDefinitions

func (c *CamundaClient) SearchDecisionDefinitions(ctx context.Context, body DecisionDefinitionSearchQuery, opts ...func(ApiSearchDecisionDefinitionsRequest) ApiSearchDecisionDefinitionsRequest) (*DecisionDefinitionSearchQueryResult, error)

Types: DecisionDefinitionSearchQuery, ApiSearchDecisionDefinitionsRequest, DecisionDefinitionSearchQueryResult

SearchDecisionDefinitions calls the SearchDecisionDefinitions operation.

Example:

result, err := client.SearchDecisionDefinitions(ctx, *camunda.NewDecisionDefinitionSearchQuery())
if err != nil {
	return err
}
for _, d := range result.GetItems() {
	fmt.Printf("%v\n", d)
}

SearchDecisionInstances

func (c *CamundaClient) SearchDecisionInstances(ctx context.Context, body DecisionInstanceSearchQuery, opts ...func(ApiSearchDecisionInstancesRequest) ApiSearchDecisionInstancesRequest) (*DecisionInstanceSearchQueryResult, error)

Types: DecisionInstanceSearchQuery, ApiSearchDecisionInstancesRequest, DecisionInstanceSearchQueryResult

SearchDecisionInstances calls the SearchDecisionInstances operation.

Example:

result, err := client.SearchDecisionInstances(ctx, *camunda.NewDecisionInstanceSearchQuery())
if err != nil {
	return err
}
for _, d := range result.GetItems() {
	fmt.Printf("%v\n", d)
}

SearchDecisionRequirements

func (c *CamundaClient) SearchDecisionRequirements(ctx context.Context, body DecisionRequirementsSearchQuery, opts ...func(ApiSearchDecisionRequirementsRequest) ApiSearchDecisionRequirementsRequest) (*DecisionRequirementsSearchQueryResult, error)

Types: DecisionRequirementsSearchQuery, ApiSearchDecisionRequirementsRequest, DecisionRequirementsSearchQueryResult

SearchDecisionRequirements calls the SearchDecisionRequirements operation.

Example:

result, err := client.SearchDecisionRequirements(ctx, *camunda.NewDecisionRequirementsSearchQuery())
if err != nil {
	return err
}
for _, d := range result.GetItems() {
	fmt.Printf("%v\n", d)
}

SearchElementInstanceIncidents

func (c *CamundaClient) SearchElementInstanceIncidents(ctx context.Context, elementInstanceKey ElementInstanceKey, body IncidentSearchQuery, opts ...func(ApiSearchElementInstanceIncidentsRequest) ApiSearchElementInstanceIncidentsRequest) (*IncidentSearchQueryResult, error)

Types: ElementInstanceKey, IncidentSearchQuery, ApiSearchElementInstanceIncidentsRequest, IncidentSearchQueryResult

SearchElementInstanceIncidents calls the SearchElementInstanceIncidents operation.

Example:

result, err := client.SearchElementInstanceIncidents(ctx,
	camunda.MustElementInstanceKey("2251799813685360"),
	*camunda.NewIncidentSearchQuery())
if err != nil {
	return err
}
for _, inc := range result.GetItems() {
	fmt.Printf("%v\n", inc)
}

SearchElementInstanceWaitStates

func (c *CamundaClient) SearchElementInstanceWaitStates(ctx context.Context, body ElementInstanceWaitStateQuery, opts ...func(ApiSearchElementInstanceWaitStatesRequest) ApiSearchElementInstanceWaitStatesRequest) (*ElementInstanceWaitStateQueryResult, error)

Types: ElementInstanceWaitStateQuery, ApiSearchElementInstanceWaitStatesRequest, ElementInstanceWaitStateQueryResult

SearchElementInstanceWaitStates calls the SearchElementInstanceWaitStates operation.

Example:

result, err := client.SearchElementInstanceWaitStates(ctx, *camunda.NewElementInstanceWaitStateQuery())
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

SearchElementInstances

func (c *CamundaClient) SearchElementInstances(ctx context.Context, body ElementInstanceSearchQuery, opts ...func(ApiSearchElementInstancesRequest) ApiSearchElementInstancesRequest) (*ElementInstanceSearchQueryResult, error)

Types: ElementInstanceSearchQuery, ApiSearchElementInstancesRequest, ElementInstanceSearchQueryResult

SearchElementInstances calls the SearchElementInstances operation.

Example:

result, err := client.SearchElementInstances(ctx, *camunda.NewElementInstanceSearchQuery())
if err != nil {
	return err
}
for _, e := range result.GetItems() {
	fmt.Printf("%v\n", e)
}

SearchGlobalTaskListeners

func (c *CamundaClient) SearchGlobalTaskListeners(ctx context.Context, body GlobalTaskListenerSearchQueryRequest, opts ...func(ApiSearchGlobalTaskListenersRequest) ApiSearchGlobalTaskListenersRequest) (*GlobalTaskListenerSearchQueryResult, error)

Types: GlobalTaskListenerSearchQueryRequest, ApiSearchGlobalTaskListenersRequest, GlobalTaskListenerSearchQueryResult

SearchGlobalTaskListeners calls the SearchGlobalTaskListeners operation.

Example:

result, err := client.SearchGlobalTaskListeners(ctx, *camunda.NewGlobalTaskListenerSearchQueryRequest())
if err != nil {
	return err
}
for _, l := range result.GetItems() {
	fmt.Printf("%v\n", l)
}

SearchGroupIdsForTenant

func (c *CamundaClient) SearchGroupIdsForTenant(ctx context.Context, tenantId string, body TenantGroupSearchQueryRequest, opts ...func(ApiSearchGroupIdsForTenantRequest) ApiSearchGroupIdsForTenantRequest) (*TenantGroupSearchResult, error)

Types: TenantGroupSearchQueryRequest, ApiSearchGroupIdsForTenantRequest, TenantGroupSearchResult

SearchGroupIdsForTenant calls the SearchGroupIdsForTenant operation.

Example:

result, err := client.SearchGroupIdsForTenant(ctx, "tenant-a", *camunda.NewTenantGroupSearchQueryRequest())
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

SearchGroups

func (c *CamundaClient) SearchGroups(ctx context.Context, body GroupSearchQueryRequest, opts ...func(ApiSearchGroupsRequest) ApiSearchGroupsRequest) (*GroupSearchQueryResult, error)

Types: GroupSearchQueryRequest, ApiSearchGroupsRequest, GroupSearchQueryResult

SearchGroups calls the SearchGroups operation.

Example:

result, err := client.SearchGroups(ctx, *camunda.NewGroupSearchQueryRequest())
if err != nil {
	return err
}
for _, g := range result.GetItems() {
	fmt.Printf("%v\n", g)
}

SearchGroupsForRole

func (c *CamundaClient) SearchGroupsForRole(ctx context.Context, roleId string, body RoleGroupSearchQueryRequest, opts ...func(ApiSearchGroupsForRoleRequest) ApiSearchGroupsForRoleRequest) (*RoleGroupSearchResult, error)

Types: RoleGroupSearchQueryRequest, ApiSearchGroupsForRoleRequest, RoleGroupSearchResult

SearchGroupsForRole calls the SearchGroupsForRole operation.

Example:

result, err := client.SearchGroupsForRole(ctx, "auditor", *camunda.NewRoleGroupSearchQueryRequest())
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

SearchIncidents

func (c *CamundaClient) SearchIncidents(ctx context.Context, body IncidentSearchQuery, opts ...func(ApiSearchIncidentsRequest) ApiSearchIncidentsRequest) (*IncidentSearchQueryResult, error)

Types: IncidentSearchQuery, ApiSearchIncidentsRequest, IncidentSearchQueryResult

SearchIncidents calls the SearchIncidents operation.

Example:

result, err := client.SearchIncidents(ctx, *camunda.NewIncidentSearchQuery())
if err != nil {
	return err
}
for _, inc := range result.GetItems() {
	fmt.Printf("incident %v: %s\n", inc.GetIncidentKey(), inc.GetErrorType())
}

SearchJobs

func (c *CamundaClient) SearchJobs(ctx context.Context, body JobSearchQuery, opts ...func(ApiSearchJobsRequest) ApiSearchJobsRequest) (*JobSearchQueryResult, error)

Types: JobSearchQuery, ApiSearchJobsRequest, JobSearchQueryResult

SearchJobs calls the SearchJobs operation.

Example:

result, err := client.SearchJobs(ctx, *camunda.NewJobSearchQuery())
if err != nil {
	return err
}
for _, job := range result.GetItems() {
	fmt.Printf("%v\n", job)
}

SearchMappingRule

func (c *CamundaClient) SearchMappingRule(ctx context.Context, body MappingRuleSearchQueryRequest, opts ...func(ApiSearchMappingRuleRequest) ApiSearchMappingRuleRequest) (*MappingRuleSearchQueryResult, error)

Types: MappingRuleSearchQueryRequest, ApiSearchMappingRuleRequest, MappingRuleSearchQueryResult

SearchMappingRule calls the SearchMappingRule operation.

Example:

result, err := client.SearchMappingRule(ctx, *camunda.NewMappingRuleSearchQueryRequest())
if err != nil {
	return err
}
for _, r := range result.GetItems() {
	fmt.Printf("%v\n", r)
}

SearchMappingRulesForGroup

func (c *CamundaClient) SearchMappingRulesForGroup(ctx context.Context, groupId string, body MappingRuleSearchQueryRequest, opts ...func(ApiSearchMappingRulesForGroupRequest) ApiSearchMappingRulesForGroupRequest) (*GroupMappingRuleSearchResult, error)

Types: MappingRuleSearchQueryRequest, ApiSearchMappingRulesForGroupRequest, GroupMappingRuleSearchResult

SearchMappingRulesForGroup calls the SearchMappingRulesForGroup operation.

Example:

result, err := client.SearchMappingRulesForGroup(ctx, "finance", *camunda.NewMappingRuleSearchQueryRequest())
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

SearchMappingRulesForRole

func (c *CamundaClient) SearchMappingRulesForRole(ctx context.Context, roleId string, body MappingRuleSearchQueryRequest, opts ...func(ApiSearchMappingRulesForRoleRequest) ApiSearchMappingRulesForRoleRequest) (*RoleMappingRuleSearchResult, error)

Types: MappingRuleSearchQueryRequest, ApiSearchMappingRulesForRoleRequest, RoleMappingRuleSearchResult

SearchMappingRulesForRole calls the SearchMappingRulesForRole operation.

Example:

result, err := client.SearchMappingRulesForRole(ctx, "auditor", *camunda.NewMappingRuleSearchQueryRequest())
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

SearchMappingRulesForTenant

func (c *CamundaClient) SearchMappingRulesForTenant(ctx context.Context, tenantId string, body MappingRuleSearchQueryRequest, opts ...func(ApiSearchMappingRulesForTenantRequest) ApiSearchMappingRulesForTenantRequest) (*TenantMappingRuleSearchResult, error)

Types: MappingRuleSearchQueryRequest, ApiSearchMappingRulesForTenantRequest, TenantMappingRuleSearchResult

SearchMappingRulesForTenant calls the SearchMappingRulesForTenant operation.

Example:

result, err := client.SearchMappingRulesForTenant(ctx, "tenant-a", *camunda.NewMappingRuleSearchQueryRequest())
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

SearchMessageSubscriptions

func (c *CamundaClient) SearchMessageSubscriptions(ctx context.Context, body MessageSubscriptionSearchQuery, opts ...func(ApiSearchMessageSubscriptionsRequest) ApiSearchMessageSubscriptionsRequest) (*MessageSubscriptionSearchQueryResult, error)

Types: MessageSubscriptionSearchQuery, ApiSearchMessageSubscriptionsRequest, MessageSubscriptionSearchQueryResult

SearchMessageSubscriptions calls the SearchMessageSubscriptions operation.

Example:

result, err := client.SearchMessageSubscriptions(ctx, *camunda.NewMessageSubscriptionSearchQuery())
if err != nil {
	return err
}
for _, s := range result.GetItems() {
	fmt.Printf("%v\n", s)
}

SearchOwnAuthorizations

func (c *CamundaClient) SearchOwnAuthorizations(ctx context.Context, body AuthorizationSearchQuery, opts ...func(ApiSearchOwnAuthorizationsRequest) ApiSearchOwnAuthorizationsRequest) (*OwnAuthorizationSearchResult, error)

Types: AuthorizationSearchQuery, ApiSearchOwnAuthorizationsRequest, OwnAuthorizationSearchResult

SearchOwnAuthorizations calls the SearchOwnAuthorizations operation.

Example:

// Scoped to the authenticated principal: direct grants plus those inherited
// from a group, role, or mapping rule.
result, err := client.SearchOwnAuthorizations(ctx, *camunda.NewAuthorizationSearchQuery())
if err != nil {
	return err
}
for _, a := range result.GetItems() {
	fmt.Printf("%v\n", a)
}

SearchProcessDefinitionVariableNames

func (c *CamundaClient) SearchProcessDefinitionVariableNames(ctx context.Context, processDefinitionKey ProcessDefinitionKey, body ProcessDefinitionVariableNameSearchQuery, opts ...func(ApiSearchProcessDefinitionVariableNamesRequest) ApiSearchProcessDefinitionVariableNamesRequest) (*ProcessDefinitionVariableNameSearchQueryResult, error)

Types: ProcessDefinitionKey, ProcessDefinitionVariableNameSearchQuery, ApiSearchProcessDefinitionVariableNamesRequest, ProcessDefinitionVariableNameSearchQueryResult

SearchProcessDefinitionVariableNames calls the SearchProcessDefinitionVariableNames operation.

Example:

result, err := client.SearchProcessDefinitionVariableNames(ctx,
	camunda.MustProcessDefinitionKey("2251799813685330"),
	*camunda.NewProcessDefinitionVariableNameSearchQuery())
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

SearchProcessDefinitions

func (c *CamundaClient) SearchProcessDefinitions(ctx context.Context, body ProcessDefinitionSearchQuery, opts ...func(ApiSearchProcessDefinitionsRequest) ApiSearchProcessDefinitionsRequest) (*ProcessDefinitionSearchQueryResult, error)

Types: ProcessDefinitionSearchQuery, ApiSearchProcessDefinitionsRequest, ProcessDefinitionSearchQueryResult

SearchProcessDefinitions calls the SearchProcessDefinitions operation.

Example:

result, err := client.SearchProcessDefinitions(ctx, *camunda.NewProcessDefinitionSearchQuery())
if err != nil {
	return err
}
for _, d := range result.GetItems() {
	fmt.Printf("%v\n", d)
}

SearchProcessInstanceIncidents

func (c *CamundaClient) SearchProcessInstanceIncidents(ctx context.Context, processInstanceKey ProcessInstanceKey, body IncidentSearchQuery, opts ...func(ApiSearchProcessInstanceIncidentsRequest) ApiSearchProcessInstanceIncidentsRequest) (*IncidentSearchQueryResult, error)

Types: ProcessInstanceKey, IncidentSearchQuery, ApiSearchProcessInstanceIncidentsRequest, IncidentSearchQueryResult

SearchProcessInstanceIncidents calls the SearchProcessInstanceIncidents operation.

Example:

result, err := client.SearchProcessInstanceIncidents(ctx,
	camunda.MustProcessInstanceKey("2251799813685340"),
	*camunda.NewIncidentSearchQuery())
if err != nil {
	return err
}
for _, inc := range result.GetItems() {
	fmt.Printf("%v\n", inc)
}

SearchProcessInstances

func (c *CamundaClient) SearchProcessInstances(ctx context.Context, body ProcessInstanceSearchQuery, opts ...func(ApiSearchProcessInstancesRequest) ApiSearchProcessInstancesRequest) (*ProcessInstanceSearchQueryResult, error)

Types: ProcessInstanceSearchQuery, ApiSearchProcessInstancesRequest, ProcessInstanceSearchQueryResult

SearchProcessInstances calls the SearchProcessInstances operation.

Example:

result, err := client.SearchProcessInstances(ctx, *camunda.NewProcessInstanceSearchQuery())
if err != nil {
	return err
}
for _, pi := range result.GetItems() {
	fmt.Printf("%v: %v\n", pi.GetProcessInstanceKey(), pi.GetState())
}

SearchResources

func (c *CamundaClient) SearchResources(ctx context.Context, body ResourceSearchQuery, opts ...func(ApiSearchResourcesRequest) ApiSearchResourcesRequest) (*ResourceSearchQueryResult, error)

Types: ResourceSearchQuery, ApiSearchResourcesRequest, ResourceSearchQueryResult

SearchResources calls the SearchResources operation.

Example:

result, err := client.SearchResources(ctx, *camunda.NewResourceSearchQuery())
if err != nil {
	return err
}
for _, r := range result.GetItems() {
	fmt.Printf("%v\n", r)
}

SearchRoles

func (c *CamundaClient) SearchRoles(ctx context.Context, body RoleSearchQueryRequest, opts ...func(ApiSearchRolesRequest) ApiSearchRolesRequest) (*RoleSearchQueryResult, error)

Types: RoleSearchQueryRequest, ApiSearchRolesRequest, RoleSearchQueryResult

SearchRoles calls the SearchRoles operation.

Example:

result, err := client.SearchRoles(ctx, *camunda.NewRoleSearchQueryRequest())
if err != nil {
	return err
}
for _, r := range result.GetItems() {
	fmt.Printf("%v\n", r)
}

SearchRolesForGroup

func (c *CamundaClient) SearchRolesForGroup(ctx context.Context, groupId string, body RoleSearchQueryRequest, opts ...func(ApiSearchRolesForGroupRequest) ApiSearchRolesForGroupRequest) (*GroupRoleSearchResult, error)

Types: RoleSearchQueryRequest, ApiSearchRolesForGroupRequest, GroupRoleSearchResult

SearchRolesForGroup calls the SearchRolesForGroup operation.

Example:

result, err := client.SearchRolesForGroup(ctx, "finance", *camunda.NewRoleSearchQueryRequest())
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

SearchRolesForTenant

func (c *CamundaClient) SearchRolesForTenant(ctx context.Context, tenantId string, body RoleSearchQueryRequest, opts ...func(ApiSearchRolesForTenantRequest) ApiSearchRolesForTenantRequest) (*TenantRoleSearchResult, error)

Types: RoleSearchQueryRequest, ApiSearchRolesForTenantRequest, TenantRoleSearchResult

SearchRolesForTenant calls the SearchRolesForTenant operation.

Example:

result, err := client.SearchRolesForTenant(ctx, "tenant-a", *camunda.NewRoleSearchQueryRequest())
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

SearchTenants

func (c *CamundaClient) SearchTenants(ctx context.Context, body TenantSearchQueryRequest, opts ...func(ApiSearchTenantsRequest) ApiSearchTenantsRequest) (*TenantSearchQueryResult, error)

Types: TenantSearchQueryRequest, ApiSearchTenantsRequest, TenantSearchQueryResult

SearchTenants calls the SearchTenants operation.

Example:

result, err := client.SearchTenants(ctx, *camunda.NewTenantSearchQueryRequest())
if err != nil {
	return err
}
for _, t := range result.GetItems() {
	fmt.Printf("%v\n", t)
}

SearchUserTaskAuditLogs

func (c *CamundaClient) SearchUserTaskAuditLogs(ctx context.Context, userTaskKey UserTaskKey, body UserTaskAuditLogSearchQueryRequest, opts ...func(ApiSearchUserTaskAuditLogsRequest) ApiSearchUserTaskAuditLogsRequest) (*AuditLogSearchQueryResult, error)

Types: UserTaskKey, UserTaskAuditLogSearchQueryRequest, ApiSearchUserTaskAuditLogsRequest, AuditLogSearchQueryResult

SearchUserTaskAuditLogs calls the SearchUserTaskAuditLogs operation.

Example:

result, err := client.SearchUserTaskAuditLogs(ctx,
	camunda.MustUserTaskKey("2251799813685380"),
	*camunda.NewUserTaskAuditLogSearchQueryRequest())
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

SearchUserTaskEffectiveVariables

func (c *CamundaClient) SearchUserTaskEffectiveVariables(ctx context.Context, userTaskKey UserTaskKey, body UserTaskEffectiveVariableSearchQueryRequest, opts ...func(ApiSearchUserTaskEffectiveVariablesRequest) ApiSearchUserTaskEffectiveVariablesRequest) (*VariableSearchQueryResult, error)

Types: UserTaskKey, UserTaskEffectiveVariableSearchQueryRequest, ApiSearchUserTaskEffectiveVariablesRequest, VariableSearchQueryResult

SearchUserTaskEffectiveVariables calls the SearchUserTaskEffectiveVariables operation.

Example:

result, err := client.SearchUserTaskEffectiveVariables(ctx,
	camunda.MustUserTaskKey("2251799813685380"),
	*camunda.NewUserTaskEffectiveVariableSearchQueryRequest())
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

SearchUserTaskVariables

func (c *CamundaClient) SearchUserTaskVariables(ctx context.Context, userTaskKey UserTaskKey, body UserTaskVariableSearchQueryRequest, opts ...func(ApiSearchUserTaskVariablesRequest) ApiSearchUserTaskVariablesRequest) (*VariableSearchQueryResult, error)

Types: UserTaskKey, UserTaskVariableSearchQueryRequest, ApiSearchUserTaskVariablesRequest, VariableSearchQueryResult

SearchUserTaskVariables calls the SearchUserTaskVariables operation.

Example:

result, err := client.SearchUserTaskVariables(ctx,
	camunda.MustUserTaskKey("2251799813685380"),
	*camunda.NewUserTaskVariableSearchQueryRequest())
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

SearchUserTasks

func (c *CamundaClient) SearchUserTasks(ctx context.Context, body UserTaskSearchQuery, opts ...func(ApiSearchUserTasksRequest) ApiSearchUserTasksRequest) (*UserTaskSearchQueryResult, error)

Types: UserTaskSearchQuery, ApiSearchUserTasksRequest, UserTaskSearchQueryResult

SearchUserTasks calls the SearchUserTasks operation.

Example:

result, err := client.SearchUserTasks(ctx, *camunda.NewUserTaskSearchQuery())
if err != nil {
	return err
}
for _, t := range result.GetItems() {
	fmt.Printf("%v\n", t)
}

SearchUsers

func (c *CamundaClient) SearchUsers(ctx context.Context, body UserSearchQueryRequest, opts ...func(ApiSearchUsersRequest) ApiSearchUsersRequest) (*UserSearchResult, error)

Types: UserSearchQueryRequest, ApiSearchUsersRequest, UserSearchResult

SearchUsers calls the SearchUsers operation.

Example:

result, err := client.SearchUsers(ctx, *camunda.NewUserSearchQueryRequest())
if err != nil {
	return err
}
for _, u := range result.GetItems() {
	fmt.Printf("%v\n", u)
}

SearchUsersForGroup

func (c *CamundaClient) SearchUsersForGroup(ctx context.Context, groupId string, body GroupUserSearchQueryRequest, opts ...func(ApiSearchUsersForGroupRequest) ApiSearchUsersForGroupRequest) (*GroupUserSearchResult, error)

Types: GroupUserSearchQueryRequest, ApiSearchUsersForGroupRequest, GroupUserSearchResult

SearchUsersForGroup calls the SearchUsersForGroup operation.

Example:

result, err := client.SearchUsersForGroup(ctx, "finance", *camunda.NewGroupUserSearchQueryRequest())
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

SearchUsersForRole

func (c *CamundaClient) SearchUsersForRole(ctx context.Context, roleId string, body RoleUserSearchQueryRequest, opts ...func(ApiSearchUsersForRoleRequest) ApiSearchUsersForRoleRequest) (*RoleUserSearchResult, error)

Types: RoleUserSearchQueryRequest, ApiSearchUsersForRoleRequest, RoleUserSearchResult

SearchUsersForRole calls the SearchUsersForRole operation.

Example:

result, err := client.SearchUsersForRole(ctx, "auditor", *camunda.NewRoleUserSearchQueryRequest())
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

SearchUsersForTenant

func (c *CamundaClient) SearchUsersForTenant(ctx context.Context, tenantId string, body TenantUserSearchQueryRequest, opts ...func(ApiSearchUsersForTenantRequest) ApiSearchUsersForTenantRequest) (*TenantUserSearchResult, error)

Types: TenantUserSearchQueryRequest, ApiSearchUsersForTenantRequest, TenantUserSearchResult

SearchUsersForTenant calls the SearchUsersForTenant operation.

Example:

result, err := client.SearchUsersForTenant(ctx, "tenant-a", *camunda.NewTenantUserSearchQueryRequest())
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

SearchVariables

func (c *CamundaClient) SearchVariables(ctx context.Context, body VariableSearchQuery, opts ...func(ApiSearchVariablesRequest) ApiSearchVariablesRequest) (*VariableSearchQueryResult, error)

Types: VariableSearchQuery, ApiSearchVariablesRequest, VariableSearchQueryResult

SearchVariables calls the SearchVariables operation.

Example:

result, err := client.SearchVariables(ctx, *camunda.NewVariableSearchQuery())
if err != nil {
	return err
}
for _, v := range result.GetItems() {
	fmt.Printf("%v\n", v)
}

SuspendBatchOperation

func (c *CamundaClient) SuspendBatchOperation(ctx context.Context, batchOperationKey string, opts ...func(ApiSuspendBatchOperationRequest) ApiSuspendBatchOperationRequest) error

Types: ApiSuspendBatchOperationRequest

SuspendBatchOperation calls the SuspendBatchOperation operation.

Example:

return client.SuspendBatchOperation(ctx, "2251799813685290")

SuspendProcessInstance

func (c *CamundaClient) SuspendProcessInstance(ctx context.Context, processInstanceKey ProcessInstanceKey, body SuspendProcessInstanceRequest, opts ...func(ApiSuspendProcessInstanceRequest) ApiSuspendProcessInstanceRequest) error

Types: ProcessInstanceKey, SuspendProcessInstanceRequest, ApiSuspendProcessInstanceRequest

SuspendProcessInstance calls the SuspendProcessInstance operation.

Example:

return client.SuspendProcessInstance(ctx,
	camunda.MustProcessInstanceKey("2251799813685340"),
	*camunda.NewSuspendProcessInstanceRequest())

SuspendProcessInstancesBatchOperation

func (c *CamundaClient) SuspendProcessInstancesBatchOperation(ctx context.Context, body ProcessInstanceSuspensionBatchOperationRequest, opts ...func(ApiSuspendProcessInstancesBatchOperationRequest) ApiSuspendProcessInstancesBatchOperationRequest) (*BatchOperationCreatedResult, error)

Types: ProcessInstanceSuspensionBatchOperationRequest, ApiSuspendProcessInstancesBatchOperationRequest, BatchOperationCreatedResult

SuspendProcessInstancesBatchOperation calls the SuspendProcessInstancesBatchOperation operation.

Example:

// Suspend every instance matching a filter in a single batch operation.
req := camunda.NewProcessInstanceSuspensionBatchOperationRequest(*camunda.NewProcessInstanceFilter())

result, err := client.SuspendProcessInstancesBatchOperation(ctx, *req)
if err != nil {
	return err
}
fmt.Printf("created batch operation %v\n", result.GetBatchOperationKey())

SyncRuntimeBackupState

func (c *CamundaClient) SyncRuntimeBackupState(ctx context.Context, opts ...func(ApiSyncRuntimeBackupStateRequest) ApiSyncRuntimeBackupStateRequest) (*RuntimeBackupState, error)

Types: ApiSyncRuntimeBackupStateRequest, RuntimeBackupState

SyncRuntimeBackupState calls the SyncRuntimeBackupState operation.

Example:

// Re-reads the backup store so the reported state matches what is stored.
state, err := client.SyncRuntimeBackupState(ctx)
if err != nil {
	return err
}
for _, backup := range state.GetBackupStates() {
	fmt.Printf("%v\n", backup)
}

SyncRuntimeBackupStateAsClusterAdmin

func (c *CamundaClient) SyncRuntimeBackupStateAsClusterAdmin(ctx context.Context, opts ...func(ApiSyncRuntimeBackupStateAsClusterAdminRequest) ApiSyncRuntimeBackupStateAsClusterAdminRequest) (*ClusterRuntimeBackupState, error)

Types: ApiSyncRuntimeBackupStateAsClusterAdminRequest, ClusterRuntimeBackupState

SyncRuntimeBackupStateAsClusterAdmin calls the SyncRuntimeBackupStateAsClusterAdmin operation.

Example:

// Force-writes the current checkpoint/backup metadata to each physical tenant's
// backup store and returns the updated state. Use this to repair stale or missing
// state entries without triggering a new backup.
state, err := client.SyncRuntimeBackupStateAsClusterAdmin(ctx)
if err != nil {
	return err
}
for _, tenant := range state.GetPhysicalTenants() {
	fmt.Printf("%v\n", tenant)
}

TakeHistoryBackup

func (c *CamundaClient) TakeHistoryBackup(ctx context.Context, body TakeHistoryBackupRequest, opts ...func(ApiTakeHistoryBackupRequest) ApiTakeHistoryBackupRequest) (*TakeHistoryBackupResponse, error)

Types: TakeHistoryBackupRequest, ApiTakeHistoryBackupRequest, TakeHistoryBackupResponse

TakeHistoryBackup calls the TakeHistoryBackup operation.

Example:

result, err := client.TakeHistoryBackup(ctx, *camunda.NewTakeHistoryBackupRequest(42))
if err != nil {
	return err
}
fmt.Printf("backup %d scheduled %d snapshot(s)\n", result.GetBackupId(), len(result.GetScheduledSnapshots()))

TakeHistoryBackupAsClusterAdmin

func (c *CamundaClient) TakeHistoryBackupAsClusterAdmin(ctx context.Context, body TakeHistoryBackupRequest, opts ...func(ApiTakeHistoryBackupAsClusterAdminRequest) ApiTakeHistoryBackupAsClusterAdminRequest) (*ClusterTakeHistoryBackupResponse, error)

Types: TakeHistoryBackupRequest, ApiTakeHistoryBackupAsClusterAdminRequest, ClusterTakeHistoryBackupResponse

TakeHistoryBackupAsClusterAdmin calls the TakeHistoryBackupAsClusterAdmin operation.

Example:

// Takes a history backup for every physical tenant in the cluster simultaneously.
result, err := client.TakeHistoryBackupAsClusterAdmin(ctx, *camunda.NewTakeHistoryBackupRequest(42))
if err != nil {
	return err
}
fmt.Printf("cluster history backup %d across %d tenant(s)\n", result.GetBackupId(), len(result.GetPhysicalTenants()))

TakeRuntimeBackup

func (c *CamundaClient) TakeRuntimeBackup(ctx context.Context, body TakeRuntimeBackupRequest, opts ...func(ApiTakeRuntimeBackupRequest) ApiTakeRuntimeBackupRequest) (*TakeRuntimeBackupResponse, error)

Types: TakeRuntimeBackupRequest, ApiTakeRuntimeBackupRequest, TakeRuntimeBackupResponse

TakeRuntimeBackup calls the TakeRuntimeBackup operation.

Example:

req := camunda.NewTakeRuntimeBackupRequest()
// The id is required here, and must be omitted instead when continuous backups
// or a backup/checkpoint schedule is enabled for the tenant — the server
// generates it in that case.
req.SetBackupId(42)

result, err := client.TakeRuntimeBackup(ctx, *req)
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

TakeRuntimeBackupAsClusterAdmin

func (c *CamundaClient) TakeRuntimeBackupAsClusterAdmin(ctx context.Context, body TakeRuntimeBackupRequest, opts ...func(ApiTakeRuntimeBackupAsClusterAdminRequest) ApiTakeRuntimeBackupAsClusterAdminRequest) (*ClusterTakeRuntimeBackupResponse, error)

Types: TakeRuntimeBackupRequest, ApiTakeRuntimeBackupAsClusterAdminRequest, ClusterTakeRuntimeBackupResponse

TakeRuntimeBackupAsClusterAdmin calls the TakeRuntimeBackupAsClusterAdmin operation.

Example:

// Takes a runtime backup across every physical tenant in the cluster simultaneously.
// Pass SetBackupId to use an explicit backup ID; omit it to let the cluster
// generate one automatically (generated-id mode). Do not mix modes: sending a
// backup ID when the cluster is configured for generated IDs will be rejected.
req := camunda.NewTakeRuntimeBackupRequest()
req.SetBackupId(42)

result, err := client.TakeRuntimeBackupAsClusterAdmin(ctx, *req)
if err != nil {
	return err
}
for _, tenant := range result.GetPhysicalTenants() {
	fmt.Printf("%v\n", tenant)
}

ThrowJobError

func (c *CamundaClient) ThrowJobError(ctx context.Context, jobKey JobKey, body JobErrorRequest, opts ...func(ApiThrowJobErrorRequest) ApiThrowJobErrorRequest) error

Types: JobKey, JobErrorRequest, ApiThrowJobErrorRequest

ThrowJobError calls the ThrowJobError operation.

Example:

req := camunda.NewJobErrorRequest("OUT_OF_STOCK")
req.SetErrorMessage("item is out of stock")

return client.ThrowJobError(ctx, camunda.MustJobKey("2251799813685424"), *req)

TriggerClusterRebalance

func (c *CamundaClient) TriggerClusterRebalance(ctx context.Context, body ClusterRebalanceRequest, opts ...func(ApiTriggerClusterRebalanceRequest) ApiTriggerClusterRebalanceRequest) (*ClusterBalanceResponse, error)

Types: ClusterRebalanceRequest, ApiTriggerClusterRebalanceRequest, ClusterBalanceResponse

TriggerClusterRebalance calls the TriggerClusterRebalance operation.

Example:

// Starts a cluster rebalance, redistributing partition leadership to the preferred nodes.
// Requires cluster-admin credentials (a separate cluster-admin security chain) —
// calling this with standard Orchestration credentials will fail authorization.
req := camunda.NewClusterRebalanceRequest()
req.SetReplicationLagThreshold(1024 * 1024) // 1 MiB max lag for leader transfer

balance, err := client.TriggerClusterRebalance(ctx, *req)
if err != nil {
	return err
}
fmt.Printf("cluster balance state: %s, %d partition(s)\n", balance.GetState(), len(balance.GetPartitions()))

UnassignClientFromGroup

func (c *CamundaClient) UnassignClientFromGroup(ctx context.Context, groupId string, clientId string, opts ...func(ApiUnassignClientFromGroupRequest) ApiUnassignClientFromGroupRequest) error

Types: ApiUnassignClientFromGroupRequest

UnassignClientFromGroup calls the UnassignClientFromGroup operation.

Example:

return client.UnassignClientFromGroup(ctx, "finance", "reporting-service")

UnassignClientFromTenant

func (c *CamundaClient) UnassignClientFromTenant(ctx context.Context, tenantId string, clientId string, opts ...func(ApiUnassignClientFromTenantRequest) ApiUnassignClientFromTenantRequest) error

Types: ApiUnassignClientFromTenantRequest

UnassignClientFromTenant calls the UnassignClientFromTenant operation.

Example:

return client.UnassignClientFromTenant(ctx, "tenant-a", "reporting-service")

UnassignGroupFromTenant

func (c *CamundaClient) UnassignGroupFromTenant(ctx context.Context, tenantId string, groupId string, opts ...func(ApiUnassignGroupFromTenantRequest) ApiUnassignGroupFromTenantRequest) error

Types: ApiUnassignGroupFromTenantRequest

UnassignGroupFromTenant calls the UnassignGroupFromTenant operation.

Example:

return client.UnassignGroupFromTenant(ctx, "tenant-a", "finance")

UnassignMappingRuleFromGroup

func (c *CamundaClient) UnassignMappingRuleFromGroup(ctx context.Context, groupId string, mappingRuleId string, opts ...func(ApiUnassignMappingRuleFromGroupRequest) ApiUnassignMappingRuleFromGroupRequest) error

Types: ApiUnassignMappingRuleFromGroupRequest

UnassignMappingRuleFromGroup calls the UnassignMappingRuleFromGroup operation.

Example:

return client.UnassignMappingRuleFromGroup(ctx, "finance", "sso-auditors")

UnassignMappingRuleFromTenant

func (c *CamundaClient) UnassignMappingRuleFromTenant(ctx context.Context, tenantId string, mappingRuleId string, opts ...func(ApiUnassignMappingRuleFromTenantRequest) ApiUnassignMappingRuleFromTenantRequest) error

Types: ApiUnassignMappingRuleFromTenantRequest

UnassignMappingRuleFromTenant calls the UnassignMappingRuleFromTenant operation.

Example:

return client.UnassignMappingRuleFromTenant(ctx, "tenant-a", "sso-auditors")

UnassignRoleFromClient

func (c *CamundaClient) UnassignRoleFromClient(ctx context.Context, roleId string, clientId string, opts ...func(ApiUnassignRoleFromClientRequest) ApiUnassignRoleFromClientRequest) error

Types: ApiUnassignRoleFromClientRequest

UnassignRoleFromClient calls the UnassignRoleFromClient operation.

Example:

return client.UnassignRoleFromClient(ctx, "auditor", "reporting-service")

UnassignRoleFromGroup

func (c *CamundaClient) UnassignRoleFromGroup(ctx context.Context, roleId string, groupId string, opts ...func(ApiUnassignRoleFromGroupRequest) ApiUnassignRoleFromGroupRequest) error

Types: ApiUnassignRoleFromGroupRequest

UnassignRoleFromGroup calls the UnassignRoleFromGroup operation.

Example:

return client.UnassignRoleFromGroup(ctx, "auditor", "finance")

UnassignRoleFromMappingRule

func (c *CamundaClient) UnassignRoleFromMappingRule(ctx context.Context, roleId string, mappingRuleId string, opts ...func(ApiUnassignRoleFromMappingRuleRequest) ApiUnassignRoleFromMappingRuleRequest) error

Types: ApiUnassignRoleFromMappingRuleRequest

UnassignRoleFromMappingRule calls the UnassignRoleFromMappingRule operation.

Example:

return client.UnassignRoleFromMappingRule(ctx, "auditor", "sso-auditors")

UnassignRoleFromTenant

func (c *CamundaClient) UnassignRoleFromTenant(ctx context.Context, tenantId string, roleId string, opts ...func(ApiUnassignRoleFromTenantRequest) ApiUnassignRoleFromTenantRequest) error

Types: ApiUnassignRoleFromTenantRequest

UnassignRoleFromTenant calls the UnassignRoleFromTenant operation.

Example:

return client.UnassignRoleFromTenant(ctx, "tenant-a", "auditor")

UnassignRoleFromUser

func (c *CamundaClient) UnassignRoleFromUser(ctx context.Context, roleId string, username string, opts ...func(ApiUnassignRoleFromUserRequest) ApiUnassignRoleFromUserRequest) error

Types: ApiUnassignRoleFromUserRequest

UnassignRoleFromUser calls the UnassignRoleFromUser operation.

Example:

return client.UnassignRoleFromUser(ctx, "auditor", "alice")

UnassignUserFromGroup

func (c *CamundaClient) UnassignUserFromGroup(ctx context.Context, groupId string, username string, opts ...func(ApiUnassignUserFromGroupRequest) ApiUnassignUserFromGroupRequest) error

Types: ApiUnassignUserFromGroupRequest

UnassignUserFromGroup calls the UnassignUserFromGroup operation.

Example:

return client.UnassignUserFromGroup(ctx, "finance", "alice")

UnassignUserFromTenant

func (c *CamundaClient) UnassignUserFromTenant(ctx context.Context, tenantId string, username string, opts ...func(ApiUnassignUserFromTenantRequest) ApiUnassignUserFromTenantRequest) error

Types: ApiUnassignUserFromTenantRequest

UnassignUserFromTenant calls the UnassignUserFromTenant operation.

Example:

return client.UnassignUserFromTenant(ctx, "tenant-a", "alice")

UnassignUserTask

func (c *CamundaClient) UnassignUserTask(ctx context.Context, userTaskKey UserTaskKey, opts ...func(ApiUnassignUserTaskRequest) ApiUnassignUserTaskRequest) error

Types: UserTaskKey, ApiUnassignUserTaskRequest

UnassignUserTask calls the UnassignUserTask operation.

Example:

return client.UnassignUserTask(ctx, camunda.MustUserTaskKey("2251799813685380"))

UpdateAgentInstance

func (c *CamundaClient) UpdateAgentInstance(ctx context.Context, agentInstanceKey AgentInstanceKey, body AgentInstanceUpdateRequest, opts ...func(ApiUpdateAgentInstanceRequest) ApiUpdateAgentInstanceRequest) (*AgentInstanceUpdateResult, error)

Types: AgentInstanceKey, AgentInstanceUpdateRequest, ApiUpdateAgentInstanceRequest, AgentInstanceUpdateResult

UpdateAgentInstance calls the UpdateAgentInstance operation.

Example:

req := camunda.NewAgentInstanceUpdateRequest(
	camunda.ElementInstanceKey("2251799813685360"), // elementInstanceKey
	camunda.JobKey("2251799813685424"),             // jobKey
	"lease-token",
)

result, err := client.UpdateAgentInstance(ctx, camunda.MustAgentInstanceKey("2251799813685370"), *req)
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

UpdateAuthorization

func (c *CamundaClient) UpdateAuthorization(ctx context.Context, authorizationKey AuthorizationKey, body AuthorizationRequest, opts ...func(ApiUpdateAuthorizationRequest) ApiUpdateAuthorizationRequest) error

Types: AuthorizationKey, AuthorizationRequest, ApiUpdateAuthorizationRequest

UpdateAuthorization calls the UpdateAuthorization operation.

Example:

updated := camunda.NewAuthorizationIdBasedRequest(
	"user@example.com",
	camunda.OWNERTYPEENUM_USER,
	"order-process",
	camunda.RESOURCETYPEENUM_PROCESS_DEFINITION,
	[]camunda.PermissionTypeEnum{camunda.PERMISSIONTYPEENUM_READ_PROCESS_DEFINITION},
)

return client.UpdateAuthorization(ctx,
	camunda.MustAuthorizationKey("2251799813685280"),
	camunda.AuthorizationIdBasedRequestAsAuthorizationRequest(updated))

UpdateGlobalClusterVariable

func (c *CamundaClient) UpdateGlobalClusterVariable(ctx context.Context, name string, body UpdateClusterVariableRequest, opts ...func(ApiUpdateGlobalClusterVariableRequest) ApiUpdateGlobalClusterVariableRequest) (*ClusterVariableResult, error)

Types: UpdateClusterVariableRequest, ApiUpdateGlobalClusterVariableRequest, ClusterVariableResult

UpdateGlobalClusterVariable calls the UpdateGlobalClusterVariable operation.

Example:

result, err := client.UpdateGlobalClusterVariable(ctx, "region",
	*camunda.NewUpdateClusterVariableRequest(map[string]any{"value": "eu-2"}))
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

UpdateGlobalTaskListener

func (c *CamundaClient) UpdateGlobalTaskListener(ctx context.Context, id string, body UpdateGlobalTaskListenerRequest, opts ...func(ApiUpdateGlobalTaskListenerRequest) ApiUpdateGlobalTaskListenerRequest) (*GlobalTaskListenerResult, error)

Types: UpdateGlobalTaskListenerRequest, ApiUpdateGlobalTaskListenerRequest, GlobalTaskListenerResult

UpdateGlobalTaskListener calls the UpdateGlobalTaskListener operation.

Example:

result, err := client.UpdateGlobalTaskListener(ctx, "audit-listener",
	*camunda.NewUpdateGlobalTaskListenerRequest(
		"audit-worker",
		[]camunda.GlobalTaskListenerEventTypeEnum{camunda.GLOBALTASKLISTENEREVENTTYPEENUM_ALL},
	))
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

UpdateGroup

func (c *CamundaClient) UpdateGroup(ctx context.Context, groupId string, body GroupUpdateRequest, opts ...func(ApiUpdateGroupRequest) ApiUpdateGroupRequest) (*GroupUpdateResult, error)

Types: GroupUpdateRequest, ApiUpdateGroupRequest, GroupUpdateResult

UpdateGroup calls the UpdateGroup operation.

Example:

result, err := client.UpdateGroup(ctx, "finance", *camunda.NewGroupUpdateRequest("Finance & Accounting"))
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

UpdateJob

func (c *CamundaClient) UpdateJob(ctx context.Context, jobKey JobKey, body JobUpdateRequest, opts ...func(ApiUpdateJobRequest) ApiUpdateJobRequest) error

Types: JobKey, JobUpdateRequest, ApiUpdateJobRequest

UpdateJob calls the UpdateJob operation.

Example:

changeset := camunda.NewJobChangeset()
changeset.SetRetries(3)

return client.UpdateJob(ctx, camunda.MustJobKey("2251799813685424"), *camunda.NewJobUpdateRequest(*changeset))

UpdateJobsBatchOperation

func (c *CamundaClient) UpdateJobsBatchOperation(ctx context.Context, body JobBatchUpdateRequest, opts ...func(ApiUpdateJobsBatchOperationRequest) ApiUpdateJobsBatchOperationRequest) (*BatchOperationCreatedResult, error)

Types: JobBatchUpdateRequest, ApiUpdateJobsBatchOperationRequest, BatchOperationCreatedResult

UpdateJobsBatchOperation calls the UpdateJobsBatchOperation operation.

Example:

changeset := camunda.NewJobChangeset()
changeset.SetRetries(3)
req := camunda.NewJobBatchUpdateRequest(*camunda.NewJobFilter(), *changeset)

result, err := client.UpdateJobsBatchOperation(ctx, *req)
if err != nil {
	return err
}
fmt.Printf("created batch operation %v\n", result.GetBatchOperationKey())

UpdateMappingRule

func (c *CamundaClient) UpdateMappingRule(ctx context.Context, mappingRuleId string, body MappingRuleUpdateRequest, opts ...func(ApiUpdateMappingRuleRequest) ApiUpdateMappingRuleRequest) (*MappingRuleUpdateResult, error)

Types: MappingRuleUpdateRequest, ApiUpdateMappingRuleRequest, MappingRuleUpdateResult

UpdateMappingRule calls the UpdateMappingRule operation.

Example:

result, err := client.UpdateMappingRule(ctx, "sso-auditors",
	*camunda.NewMappingRuleUpdateRequest("groups", "senior-auditors", "SSO Senior Auditors"))
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

UpdateRole

func (c *CamundaClient) UpdateRole(ctx context.Context, roleId string, body RoleUpdateRequest, opts ...func(ApiUpdateRoleRequest) ApiUpdateRoleRequest) (*RoleUpdateResult, error)

Types: RoleUpdateRequest, ApiUpdateRoleRequest, RoleUpdateResult

UpdateRole calls the UpdateRole operation.

Example:

result, err := client.UpdateRole(ctx, "auditor", *camunda.NewRoleUpdateRequest("Senior Auditor"))
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

UpdateTenant

func (c *CamundaClient) UpdateTenant(ctx context.Context, tenantId string, body TenantUpdateRequest, opts ...func(ApiUpdateTenantRequest) ApiUpdateTenantRequest) (*TenantUpdateResult, error)

Types: TenantUpdateRequest, ApiUpdateTenantRequest, TenantUpdateResult

UpdateTenant calls the UpdateTenant operation.

Example:

result, err := client.UpdateTenant(ctx, "tenant-a", *camunda.NewTenantUpdateRequest("Tenant A (renamed)"))
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

UpdateTenantClusterVariable

func (c *CamundaClient) UpdateTenantClusterVariable(ctx context.Context, tenantId string, name string, body UpdateClusterVariableRequest, opts ...func(ApiUpdateTenantClusterVariableRequest) ApiUpdateTenantClusterVariableRequest) (*ClusterVariableResult, error)

Types: UpdateClusterVariableRequest, ApiUpdateTenantClusterVariableRequest, ClusterVariableResult

UpdateTenantClusterVariable calls the UpdateTenantClusterVariable operation.

Example:

result, err := client.UpdateTenantClusterVariable(ctx, "tenant-a", "region",
	*camunda.NewUpdateClusterVariableRequest(map[string]any{"value": "eu-2"}))
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

UpdateUser

func (c *CamundaClient) UpdateUser(ctx context.Context, username string, body UserUpdateRequest, opts ...func(ApiUpdateUserRequest) ApiUpdateUserRequest) (*UserUpdateResult, error)

Types: UserUpdateRequest, ApiUpdateUserRequest, UserUpdateResult

UpdateUser calls the UpdateUser operation.

Example:

req := camunda.NewUserUpdateRequest()
req.SetName("Alice Updated")

result, err := client.UpdateUser(ctx, "alice", *req)
if err != nil {
	return err
}
fmt.Printf("%v\n", result)

UpdateUserTask

func (c *CamundaClient) UpdateUserTask(ctx context.Context, userTaskKey UserTaskKey, body UserTaskUpdateRequest, opts ...func(ApiUpdateUserTaskRequest) ApiUpdateUserTaskRequest) error

Types: UserTaskKey, UserTaskUpdateRequest, ApiUpdateUserTaskRequest

UpdateUserTask calls the UpdateUserTask operation.

Example:

// Update fields (priority, due/follow-up dates, ...) via the request's
// changeset. An empty request is a no-op.
req := camunda.NewUserTaskUpdateRequest()

return client.UpdateUserTask(ctx, camunda.MustUserTaskKey("2251799813685380"), *req)