Package io.camunda.client.impl.command

Class UnassignRoleFromUserCommandImpl

java.lang.Object

io.camunda.client.impl.command.UnassignRoleFromUserCommandImpl

All Implemented Interfaces:

FinalCommandStep<UnassignUserFromRoleResponse>, UnassignRoleFromUserCommandStep1, UnassignRoleFromUserCommandStep1.UnassignRoleFromUserCommandStep2

public class UnassignRoleFromUserCommandImpl
extends Object
implements UnassignRoleFromUserCommandStep1, UnassignRoleFromUserCommandStep1.UnassignRoleFromUserCommandStep2

Nested Class Summary

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

UnassignRoleFromUserCommandStep1.UnassignRoleFromUserCommandStep2

Constructor Summary

Constructors

Constructor	Description
UnassignRoleFromUserCommandImpl(HttpClient httpClient)

Method Summary

Modifier and Type	Method	Description
FinalCommandStep<UnassignUserFromRoleResponse>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
UnassignRoleFromUserCommandStep1.UnassignRoleFromUserCommandStep2	roleId(String roleId)	Sets the role ID for the unassignment.
CamundaFuture<UnassignUserFromRoleResponse>	send()	Sends the command to the Camunda gateway.
UnassignRoleFromUserCommandStep1.UnassignRoleFromUserCommandStep2	username(String username)	Sets the username for the unassignment.

Methods inherited from class java.lang.Object

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

Constructor Details

UnassignRoleFromUserCommandImpl

public UnassignRoleFromUserCommandImpl(HttpClient httpClient)

Method Details

roleId

public UnassignRoleFromUserCommandStep1.UnassignRoleFromUserCommandStep2 roleId(String roleId)

Description copied from interface: UnassignRoleFromUserCommandStep1

Sets the role ID for the unassignment.

Specified by:

roleId in interface UnassignRoleFromUserCommandStep1

Parameters:

roleId - the roleId of the role

Returns:

the next step of the command builder.

username

public UnassignRoleFromUserCommandStep1.UnassignRoleFromUserCommandStep2 username(String username)

Description copied from interface: UnassignRoleFromUserCommandStep1.UnassignRoleFromUserCommandStep2

Sets the username for the unassignment.

Specified by:

username in interface UnassignRoleFromUserCommandStep1.UnassignRoleFromUserCommandStep2

Parameters:

username - the username of the user

Returns:

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

requestTimeout

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

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

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

Returns:

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