Package io.camunda.client.api.command

Interface FinalCommandStep<T>

All Known Subinterfaces:
ActivateAdHocSubProcessActivitiesCommandStep1.ActivateAdHocSubProcessActivitiesCommandStep2, ActivateJobsCommandStep1.ActivateJobsCommandStep3, AssignClientToGroupCommandStep1.AssignClientToGroupCommandStep3, AssignClientToTenantCommandStep1.AssignClientToTenantCommandStep3, AssignGroupToTenantCommandStep1.AssignGroupToTenantCommandStep3, AssignMappingRuleToGroupStep1.AssignMappingRuleToGroupStep3, AssignMappingRuleToTenantCommandStep1.AssignMappingRuleToTenantCommandStep3, AssignRoleToClientCommandStep1.AssignRoleToClientCommandStep3, AssignRoleToGroupCommandStep1.AssignRoleToGroupCommandStep3, AssignRoleToMappingRuleCommandStep1.AssignRoleToMappingRuleCommandStep3, AssignRoleToTenantCommandStep1.AssignRoleToTenantCommandStep3, AssignRoleToUserCommandStep1.AssignRoleToUserCommandStep3, AssignUserTaskCommandStep1, AssignUserToGroupCommandStep1.AssignUserToGroupCommandStep3, AssignUserToTenantCommandStep1.AssignUserToTenantCommandStep3, AuthorizationGetRequest, AuthorizationsSearchRequest, BatchOperationGetRequest, BatchOperationItemSearchRequest, BatchOperationSearchRequest, BroadcastSignalCommandStep1.BroadcastSignalCommandStep2, CancelBatchOperationStep1, CancelProcessInstanceCommandStep1, ClientsByGroupSearchRequest, ClientsByRoleSearchRequest, ClientsByTenantSearchRequest, CompleteJobCommandStep1, CompleteUserTaskCommandStep1, CorrelatedMessageSubscriptionSearchRequest, CorrelateMessageCommandStep1.CorrelateMessageCommandStep3, CreateAuthorizationCommandStep1.CreateAuthorizationCommandStep6, CreateBatchOperationCommandStep1.CreateBatchOperationCommandStep3<E>, CreateDocumentBatchCommandStep1, CreateDocumentCommandStep1.CreateDocumentCommandStep2, CreateDocumentLinkCommandStep1, CreateGroupCommandStep1.CreateGroupCommandStep2, CreateMappingRuleCommandStep1, CreateProcessInstanceCommandStep1.CreateProcessInstanceCommandStep3, CreateProcessInstanceCommandStep1.CreateProcessInstanceWithResultCommandStep1, CreateRoleCommandStep1.CreateRoleCommandStep2, CreateTenantCommandStep1, CreateUserCommandStep1, DecisionDefinitionGetRequest, DecisionDefinitionGetXmlRequest, DecisionDefinitionSearchRequest, DecisionInstanceGetRequest, DecisionInstanceSearchRequest, DecisionRequirementsGetRequest, DecisionRequirementsGetXmlRequest, DecisionRequirementsSearchRequest, DeleteAuthorizationCommandStep1, DeleteDocumentCommandStep1, DeleteGroupCommandStep1, DeleteResourceCommandStep1, DeleteRoleCommandStep1, DeleteTenantCommandStep1, DeleteUserCommandStep1, DeployProcessCommandStep1.DeployProcessCommandBuilderStep2, DeployResourceCommandStep1.DeployResourceCommandStep2, DocumentContentGetRequest, ElementInstanceGetRequest, ElementInstanceSearchRequest, EvaluateDecisionCommandStep1.EvaluateDecisionCommandStep2, FailJobCommandStep1.FailJobCommandStep2, FinalSearchRequestStep<T>, GroupGetRequest, GroupsByRoleSearchRequest, GroupsByTenantSearchRequest, GroupsSearchRequest, IncidentGetRequest, IncidentsByProcessInstanceSearchRequest, IncidentSearchRequest, JobSearchRequest, MappingRulesByGroupSearchRequest, MappingRulesByRoleSearchRequest, MessageSubscriptionSearchRequest, MigrateProcessInstanceCommandStep1.MigrateProcessInstanceCommandFinalStep, ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep2, ModifyProcessInstanceCommandStep1.ModifyProcessInstanceCommandStep3, PinClockCommandStep1, ProcessDefinitionElementStatisticsRequest, ProcessDefinitionGetFormRequest, ProcessDefinitionGetRequest, ProcessDefinitionGetXmlRequest, ProcessDefinitionSearchRequest, ProcessInstanceElementStatisticsRequest, ProcessInstanceGetCallHierarchyRequest, ProcessInstanceGetRequest, ProcessInstanceSearchRequest, ProcessInstanceSequenceFlowsRequest, PublishMessageCommandStep1.PublishMessageCommandStep3, ResetClockCommandStep1, ResolveIncidentCommandStep1, ResumeBatchOperationStep1, RoleGetRequest, RolesByGroupSearchRequest, RolesByTenantSearchRequest, RolesSearchRequest, SetVariablesCommandStep1.SetVariablesCommandStep2, StatusRequestStep1, StreamJobsCommandStep1.StreamJobsCommandStep3, SuspendBatchOperationStep1, TenantGetRequest, TenantsSearchRequest, ThrowErrorCommandStep1.ThrowErrorCommandStep2, TopologyRequestStep1, UnassignClientFromGroupCommandStep1.UnassignClientFromGroupCommandStep3, UnassignGroupFromTenantCommandStep1.UnassignGroupFromTenantCommandStep3, UnassignMappingRuleFromGroupStep1.UnassignMappingRuleFromGroupStep3, UnassignRoleFromClientCommandStep1.UnassignRoleFromClientCommandStep3, UnassignRoleFromGroupCommandStep1.UnassignRoleFromGroupCommandStep3, UnassignRoleFromMappingRuleCommandStep1.UnassignRoleFromMappingRuleCommandStep3, UnassignRoleFromTenantCommandStep1.UnassignRoleFromTenantCommandStep3, UnassignRoleFromUserCommandStep1.UnassignRoleFromUserCommandStep3, UnassignUserFromGroupCommandStep1.UnassignUserFromGroupCommandStep3, UnassignUserFromTenantCommandStep1.UnassignUserFromTenantCommandStep3, UnassignUserTaskCommandStep1, UpdateAuthorizationCommandStep1.UpdateAuthorizationCommandStep6, UpdateGroupCommandStep1, UpdateJobCommandStep1.UpdateJobCommandStep2, UpdateRetriesJobCommandStep1.UpdateRetriesJobCommandStep2, UpdateRoleCommandStep1, UpdateTenantCommandStep1, UpdateTimeoutJobCommandStep1.UpdateTimeoutJobCommandStep2, UpdateUserCommandStep1, UpdateUserTaskCommandStep1, UsageMetricsStatisticsRequest, UserGetRequest, UsersByGroupSearchRequest, UsersByRoleSearchRequest, UsersByTenantSearchRequest, UsersSearchRequest, UserTaskGetFormRequest, UserTaskGetRequest, UserTaskSearchRequest, UserTaskVariableSearchRequest, VariableGetRequest, VariableSearchRequest
All Known Implementing Classes:
ActivateAdHocSubProcessActivitiesCommandImpl, ActivateJobsCommandImpl, AssignClientToGroupCommandImpl, AssignClientToTenantCommandImpl, AssignGroupToTenantCommandImpl, AssignMappingRuleToGroupCommandImpl, AssignMappingRuleToTenantCommandImpl, AssignRoleToClientCommandImpl, AssignRoleToGroupCommandImpl, AssignRoleToMappingRuleCommandImpl, AssignRoleToTenantCommandImpl, AssignRoleToUserCommandImpl, AssignUserTaskCommandImpl, AssignUserToGroupCommandImpl, AssignUserToTenantCommandImpl, AuthorizationGetRequestImpl, AuthorizationsSearchRequestImpl, BatchOperationGetRequestImpl, BatchOperationItemSearchRequestImpl, BatchOperationSearchRequestImpl, BroadcastSignalCommandImpl, CancelBatchOperationCommandImpl, CancelProcessInstanceCommandImpl, ClientsByGroupSearchRequestImpl, ClientsByRoleSearchRequestImpl, ClientsByTenantSearchRequestImpl, CompleteJobCommandImpl, CompleteUserTaskCommandImpl, CorrelatedMessageSubscriptionSearchRequestImpl, CorrelateMessageCommandImpl, CreateAuthorizationCommandImpl, CreateBatchOperationCommandImpl, CreateDocumentBatchCommandImpl, CreateDocumentCommandImpl, CreateDocumentLinkCommandImpl, CreateGroupCommandImpl, CreateMappingRuleCommandImpl, CreateProcessInstanceCommandImpl, CreateProcessInstanceWithResultCommandImpl, CreateRoleCommandImpl, CreateTenantCommandImpl, CreateUserCommandImpl, DecisionDefinitionGetRequestImpl, DecisionDefinitionGetXmlRequestImpl, DecisionDefinitionSearchRequestImpl, DecisionInstanceGetRequestImpl, DecisionInstanceSearchRequestImpl, DecisionRequirementsGetRequestImpl, DecisionRequirementsGetXmlRequestImpl, DecisionRequirementsSearchRequestImpl, DeleteAuthorizationCommandImpl, DeleteDocumentCommandImpl, DeleteGroupCommandImpl, DeleteResourceCommandImpl, DeleteRoleCommandImpl, DeleteTenantCommandImpl, DeleteUserCommandImpl, DeployProcessCommandImpl, DeployResourceCommandImpl, DocumentContentGetRequestImpl, ElementInstanceGetRequestImpl, ElementInstanceSearchRequestImpl, EvaluateDecisionCommandImpl, FailJobCommandImpl, GroupGetRequestImpl, GroupsByRoleSearchRequestImpl, GroupsByTenantSearchRequestImpl, GroupSearchRequestImpl, IncidentGetRequestImpl, IncidentsByProcessInstanceSearchRequestImpl, IncidentSearchRequestImpl, JobSearchRequestImpl, JobUpdateRetriesCommandImpl, JobUpdateTimeoutCommandImpl, MappingRulesByGroupSearchRequestImpl, MappingRulesByRoleSearchRequestImpl, MessageSubscriptionSearchRequestImpl, MigrateProcessInstanceCommandImpl, ModifyProcessInstanceCommandImpl, PinClockCommandImpl, ProcessDefinitionElementStatisticsRequestImpl, ProcessDefinitionGetFormRequestImpl, ProcessDefinitionGetRequestImpl, ProcessDefinitionGetXmlRequestImpl, ProcessDefinitionSearchRequestImpl, ProcessInstanceElementStatisticsRequestImpl, ProcessInstanceGetCallHierarchyRequestImpl, ProcessInstanceGetRequestImpl, ProcessInstanceSearchRequestImpl, ProcessInstanceSequenceFlowsRequestImpl, PublishMessageCommandImpl, ResetClockCommandImpl, ResolveIncidentCommandImpl, ResumeBatchOperationCommandImpl, RoleGetRequestImpl, RolesByGroupSearchRequestImpl, RolesByTenantSearchRequestImpl, RolesSearchRequestImpl, SetVariablesCommandImpl, StatusRequestImpl, StreamJobsCommandImpl, SuspendBatchOperationCommandImpl, TenantGetRequestImpl, TenantsSearchRequestImpl, ThrowErrorCommandImpl, TopologyRequestImpl, UnassignClientFromGroupCommandImpl, UnassignGroupFromTenantCommandImpl, UnassignMappingRuleFromGroupCommandImpl, UnassignRoleFromClientCommandImpl, UnassignRoleFromGroupCommandImpl, UnassignRoleFromMappingRuleCommandImpl, UnassignRoleFromTenantCommandImpl, UnassignRoleFromUserCommandImpl, UnassignUserFromGroupCommandImpl, UnassignUserFromTenantCommandImpl, UnassignUserTaskCommandImpl, UpdateAuthorizationCommandImpl, UpdateGroupCommandImpl, UpdateJobCommandImpl, UpdateRoleCommandImpl, UpdateTenantCommandImpl, UpdateUserCommandImpl, UpdateUserTaskCommandImpl, UsageMetricsStatisticsRequestImpl, UserGetRequestImpl, UsersByGroupSearchRequestImpl, UsersByRoleSearchRequestImpl, UsersByTenantSearchRequestImpl, UsersSearchRequestImpl, UserTaskGetFormRequestImpl, UserTaskGetRequestImpl, UserTaskSearchRequestImpl, UserTaskVariableSearchRequestImpl, VariableGetRequestImpl, VariableSearchRequestImpl
public interface FinalCommandStep<T>

  • Method Summary

    Modifier and Type
    Method
    Description
    default T
    execute()
    Sends the command to the Camunda gateway and returns the response.
    FinalCommandStep<T>
    requestTimeout(Duration requestTimeout)
    Sets the request timeout for the command.
    CamundaFuture<T>
    send()
    Sends the command to the Camunda gateway.

  • Method Details

    • requestTimeout

      FinalCommandStep<T> requestTimeout(Duration requestTimeout)
      Sets the request timeout for the command. The default request timeout can be configured using CamundaClientBuilder.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: '&#62' future = command.send();
 JobEvent event = future.join();
      Returns:
      a future tracking state of success/failure of the command.

    • execute

      default T execute()
      Sends the command to the Camunda gateway and returns the response. This operation is synchronous. 
       JobEvent event = command.execute();
      Returns:
      the response of the command.