Package io.camunda.client.impl.command

Class AssignUserToGroupCommandImpl

java.lang.Object

io.camunda.client.impl.command.AssignUserToGroupCommandImpl

All Implemented Interfaces:

AssignUserToGroupCommandStep1, AssignUserToGroupCommandStep1.AssignUserToGroupCommandStep2, AssignUserToGroupCommandStep1.AssignUserToGroupCommandStep3, FinalCommandStep<AssignUserToGroupResponse>

public class AssignUserToGroupCommandImpl
extends Object
implements AssignUserToGroupCommandStep1, AssignUserToGroupCommandStep1.AssignUserToGroupCommandStep2, AssignUserToGroupCommandStep1.AssignUserToGroupCommandStep3

Nested Class Summary

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

AssignUserToGroupCommandStep1.AssignUserToGroupCommandStep2, AssignUserToGroupCommandStep1.AssignUserToGroupCommandStep3

Constructor Summary

Constructors

Constructor	Description
AssignUserToGroupCommandImpl(HttpClient httpClient)

Method Summary

Modifier and Type	Method	Description
AssignUserToGroupCommandStep1.AssignUserToGroupCommandStep3	groupId(String groupId)	Sets the group ID.
FinalCommandStep<AssignUserToGroupResponse>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<AssignUserToGroupResponse>	send()	Sends the command to the Camunda gateway.
AssignUserToGroupCommandStep1.AssignUserToGroupCommandStep2	username(String username)	Sets the username for the assignment.

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

AssignUserToGroupCommandImpl

public AssignUserToGroupCommandImpl(HttpClient httpClient)

Method Details

username

public AssignUserToGroupCommandStep1.AssignUserToGroupCommandStep2 username(String username)

Description copied from interface: AssignUserToGroupCommandStep1

Sets the username for the assignment.

Specified by:

username in interface AssignUserToGroupCommandStep1

Parameters:

username - the username of the user

Returns:

the builder for this command.

groupId

public AssignUserToGroupCommandStep1.AssignUserToGroupCommandStep3 groupId(String groupId)

Description copied from interface: AssignUserToGroupCommandStep1.AssignUserToGroupCommandStep2

Sets the group ID.

Specified by:

groupId in interface AssignUserToGroupCommandStep1.AssignUserToGroupCommandStep2

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<AssignUserToGroupResponse> 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<AssignUserToGroupResponse>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public CamundaFuture<AssignUserToGroupResponse> 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<AssignUserToGroupResponse>

Returns:

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