Package io.camunda.client.impl.command

Class AssignRoleToUserCommandImpl

java.lang.Object

io.camunda.client.impl.command.AssignRoleToUserCommandImpl

All Implemented Interfaces:

AssignRoleToUserCommandStep1, AssignRoleToUserCommandStep1.AssignRoleToUserCommandStep2, AssignRoleToUserCommandStep1.AssignRoleToUserCommandStep3, FinalCommandStep<AssignRoleToUserResponse>

public final class AssignRoleToUserCommandImpl
extends Object
implements AssignRoleToUserCommandStep1, AssignRoleToUserCommandStep1.AssignRoleToUserCommandStep2, AssignRoleToUserCommandStep1.AssignRoleToUserCommandStep3

Nested Class Summary

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

AssignRoleToUserCommandStep1.AssignRoleToUserCommandStep2, AssignRoleToUserCommandStep1.AssignRoleToUserCommandStep3

Constructor Summary

Constructors

Constructor	Description
AssignRoleToUserCommandImpl(HttpClient httpClient)

Method Summary

Modifier and Type	Method	Description
FinalCommandStep<AssignRoleToUserResponse>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
AssignRoleToUserCommandStep1.AssignRoleToUserCommandStep2	roleId(String roleId)	Sets the role ID.
CamundaFuture<AssignRoleToUserResponse>	send()	Sends the command to the Camunda gateway.
AssignRoleToUserCommandStep1.AssignRoleToUserCommandStep3	username(String username)	Sets the username of the user to assign the role to.

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

AssignRoleToUserCommandImpl

public AssignRoleToUserCommandImpl(HttpClient httpClient)

Method Details

roleId

public AssignRoleToUserCommandStep1.AssignRoleToUserCommandStep2 roleId(String roleId)

Description copied from interface: AssignRoleToUserCommandStep1

Sets the role ID.

Specified by:

roleId in interface AssignRoleToUserCommandStep1

Parameters:

roleId - the ID of the role

Returns:

the next step of the builder to set the username

username

public AssignRoleToUserCommandStep1.AssignRoleToUserCommandStep3 username(String username)

Description copied from interface: AssignRoleToUserCommandStep1.AssignRoleToUserCommandStep2

Sets the username of the user to assign the role to.

Specified by:

username in interface AssignRoleToUserCommandStep1.AssignRoleToUserCommandStep2

Parameters:

username - the username

Returns:

the builder for this command. Call FinalCommandStep.send() to execute.

requestTimeout

public FinalCommandStep<AssignRoleToUserResponse> 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<AssignRoleToUserResponse>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

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

Returns:

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