Package io.camunda.client.api.command
Interface FinalCommandStep<T>
- All Known Subinterfaces:
ActivateJobsCommandStep1.ActivateJobsCommandStep3,AssignGroupToTenantCommandStep1,AssignMappingToTenantCommandStep1,AssignUserTaskCommandStep1,AssignUserToGroupCommandStep1,AssignUserToTenantCommandStep1,BroadcastSignalCommandStep1.BroadcastSignalCommandStep2,CancelProcessInstanceCommandStep1,ClockPinCommandStep1,ClockResetCommandStep1,CompleteJobCommandStep1,CompleteJobCommandStep1.CompleteJobCommandStep2,CompleteUserTaskCommandStep1,CorrelateMessageCommandStep1.CorrelateMessageCommandStep3,CreateAuthorizationCommandStep1.CreateAuthorizationCommandStep6,CreateDocumentBatchCommandStep1,CreateDocumentCommandStep1.CreateDocumentCommandStep2,CreateDocumentLinkCommandStep1,CreateGroupCommandStep1,CreateMappingCommandStep1,CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3,CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1,CreateRoleCommandStep1,CreateTenantCommandStep1,CreateUserCommandStep1,DecisionDefinitionGetRequest,DecisionDefinitionGetXmlRequest,DecisionDefinitionQuery,DecisionInstanceGetRequest,DecisionInstanceQuery,DecisionRequirementsGetRequest,DecisionRequirementsGetXmlRequest,DecisionRequirementsQuery,DeleteAuthorizationCommandStep1,DeleteDocumentCommandStep1,DeleteGroupCommandStep1,DeleteResourceCommandStep1,DeleteTenantCommandStep1,DeployProcessCommandStep1.DeployProcessCommandBuilderStep2,DeployResourceCommandStep1.DeployResourceCommandStep2,DocumentContentGetRequest,EvaluateDecisionCommandStep1.EvaluateDecisionCommandStep2,FailJobCommandStep1.FailJobCommandStep2,FinalSearchQueryStep<T>,FlowNodeInstanceGetRequest,FlownodeInstanceQuery,IncidentGetRequest,IncidentQuery,MigrateProcessInstanceCommandStep1.MigrateProcessInstanceCommandFinalStep,ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep2,ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3,ProcessDefinitionGetFormRequest,ProcessDefinitionGetRequest,ProcessDefinitionGetXmlRequest,ProcessDefinitionQuery,ProcessInstanceGetRequest,ProcessInstanceQuery,PublishMessageCommandStep1.PublishMessageCommandStep3,RemoveUserFromTenantCommandStep1,ResolveIncidentCommandStep1,SetVariablesCommandStep1.SetVariablesCommandStep2,StreamJobsCommandStep1.StreamJobsCommandStep3,ThrowErrorCommandStep1.ThrowErrorCommandStep2,TopologyRequestStep1,UnassignGroupFromTenantCommandStep1,UnassignUserFromGroupCommandStep1,UnassignUserTaskCommandStep1,UpdateAuthorizationCommandStep1.UpdateAuthorizationCommandStep6,UpdateGroupCommandStep1,UpdateJobCommandStep1.UpdateJobCommandStep2,UpdateRetriesJobCommandStep1.UpdateRetriesJobCommandStep2,UpdateTenantCommandStep1,UpdateTimeoutJobCommandStep1.UpdateTimeoutJobCommandStep2,UpdateUserTaskCommandStep1,UserTaskGetFormRequest,UserTaskGetRequest,UserTaskQuery,UserTaskVariableQuery,VariableGetRequest,VariableQuery
- All Known Implementing Classes:
ActivateJobsCommandImpl,AssignGroupToTenantCommandImpl,AssignMappingToTenantCommandImpl,AssignUserTaskCommandImpl,AssignUserToGroupCommandImpl,AssignUserToTenantCommandImpl,BroadcastSignalCommandImpl,CancelProcessInstanceCommandImpl,ClockPinCommandImpl,ClockResetCommandImpl,CompleteJobCommandImpl,CompleteUserTaskCommandImpl,CorrelateMessageCommandImpl,CreateAuthorizationCommandImpl,CreateDocumentBatchCommandImpl,CreateDocumentCommandImpl,CreateDocumentLinkCommandImpl,CreateGroupCommandImpl,CreateMappingCommandImpl,CreateProcessInstanceCommandImpl,CreateProcessInstanceWithResultCommandImpl,CreateRoleCommandImpl,CreateTenantCommandImpl,CreateUserCommandImpl,DecisionDefinitionGetRequestImpl,DecisionDefinitionGetXmlRequestImpl,DecisionDefinitionQueryImpl,DecisionInstanceGetRequestImpl,DecisionInstanceQueryImpl,DecisionRequirementsGetRequestImpl,DecisionRequirementsGetXmlRequestImpl,DecisionRequirementsQueryImpl,DeleteAuthorizationCommandImpl,DeleteDocumentCommandImpl,DeleteGroupCommandImpl,DeleteResourceCommandImpl,DeleteTenantCommandImpl,DeployProcessCommandImpl,DeployResourceCommandImpl,DocumentContentGetRequestImpl,EvaluateDecisionCommandImpl,FailJobCommandImpl,FlowNodeInstanceGetRequestImpl,FlowNodeInstanceQueryImpl,IncidentGetRequestImpl,IncidentQueryImpl,JobUpdateCommandImpl,JobUpdateRetriesCommandImpl,JobUpdateTimeoutCommandImpl,MigrateProcessInstanceCommandImpl,ModifyProcessInstanceCommandImpl,ProcessDefinitionGetFormRequestImpl,ProcessDefinitionGetRequestImpl,ProcessDefinitionGetXmlRequestImpl,ProcessDefinitionQueryImpl,ProcessInstanceGetRequestImpl,ProcessInstanceQueryImpl,PublishMessageCommandImpl,RemoveUserFromTenantCommandImpl,ResolveIncidentCommandImpl,SetVariablesCommandImpl,StreamJobsCommandImpl,ThrowErrorCommandImpl,TopologyRequestImpl,UnassignGroupFromTenantCommandImpl,UnassignUserFromGroupCommandImpl,UnassignUserTaskCommandImpl,UpdateAuthorizationCommandImpl,UpdateGroupCommandImpl,UpdateTenantCommandImpl,UpdateUserTaskCommandImpl,UserTaskGetFormRequestImpl,UserTaskGetRequestImpl,UserTaskQueryImpl,UserTaskVariableQueryImpl,VariableGetRequestImpl,VariableQueryImpl
public interface FinalCommandStep<T>
-
Method Summary
Modifier and TypeMethodDescriptionrequestTimeout(Duration requestTimeout) Sets the request timeout for the command.send()Sends the command to the Camunda gateway.
-
Method Details
-
requestTimeout
Sets the request timeout for the command. The default request timeout can be configured usingCamundaClientBuilder.defaultRequestTimeout(Duration).- Parameters:
requestTimeout- the request timeout- Returns:
- the configured command
-
send
CamundaFuture<T> send()Sends the command to the Camunda gateway. This operation is asynchronous. In case of success, the future returns the event that was generated by the Camunda gateway in response to the command.Call
CamundaFuture.join()to wait until the response is available.Future<JobEventinvalid input: '>' future = command.send(); JobEvent event = future.join();- Returns:
- a future tracking state of success/failure of the command.
-