Package io.camunda.client.impl.command

Class AssignClientToGroupCommandImpl

java.lang.Object

io.camunda.client.impl.command.AssignClientToGroupCommandImpl

All Implemented Interfaces:

AssignClientToGroupCommandStep1, AssignClientToGroupCommandStep1.AssignClientToGroupCommandStep2, AssignClientToGroupCommandStep1.AssignClientToGroupCommandStep3, FinalCommandStep<AssignClientToGroupResponse>

public class AssignClientToGroupCommandImpl
extends Object
implements AssignClientToGroupCommandStep1, AssignClientToGroupCommandStep1.AssignClientToGroupCommandStep2, AssignClientToGroupCommandStep1.AssignClientToGroupCommandStep3

Nested Class Summary

Nested classes/interfaces inherited from interface io.camunda.client.api.command.AssignClientToGroupCommandStep1

AssignClientToGroupCommandStep1.AssignClientToGroupCommandStep2, AssignClientToGroupCommandStep1.AssignClientToGroupCommandStep3

Constructor Summary

Constructors

Constructor	Description
AssignClientToGroupCommandImpl(HttpClient httpClient)

Method Summary

Modifier and Type	Method	Description
AssignClientToGroupCommandStep1.AssignClientToGroupCommandStep2	clientId(String clientId)	Sets the ID of the client to be assigned to a group.
AssignClientToGroupCommandStep1.AssignClientToGroupCommandStep3	groupId(String groupId)	Sets the group ID.
FinalCommandStep<AssignClientToGroupResponse>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<AssignClientToGroupResponse>	send()	Sends the command to the Camunda gateway.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.camunda.client.api.command.FinalCommandStep

execute

Constructor Details

AssignClientToGroupCommandImpl

public AssignClientToGroupCommandImpl(HttpClient httpClient)

Method Details

clientId

public AssignClientToGroupCommandStep1.AssignClientToGroupCommandStep2 clientId(String clientId)

Description copied from interface: AssignClientToGroupCommandStep1

Sets the ID of the client to be assigned to a group.

Specified by:

clientId in interface AssignClientToGroupCommandStep1

Parameters:

clientId - the ID of the client

Returns:

the builder for this command.

groupId

public AssignClientToGroupCommandStep1.AssignClientToGroupCommandStep3 groupId(String groupId)

Description copied from interface: AssignClientToGroupCommandStep1.AssignClientToGroupCommandStep2

Sets the group ID.

Specified by:

groupId in interface AssignClientToGroupCommandStep1.AssignClientToGroupCommandStep2

Parameters:

groupId - the ID of the group

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker.

requestTimeout

public FinalCommandStep<AssignClientToGroupResponse> requestTimeout(Duration requestTimeout)

Description copied from interface: FinalCommandStep

Sets the request timeout for the command. The default request timeout can be configured using CamundaClientBuilder.defaultRequestTimeout(Duration).

Specified by:

requestTimeout in interface FinalCommandStep<AssignClientToGroupResponse>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public CamundaFuture<AssignClientToGroupResponse> send()

Description copied from interface: FinalCommandStep

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();
 

Specified by:

send in interface FinalCommandStep<AssignClientToGroupResponse>

Returns:

a future tracking state of success/failure of the command.