Package io.camunda.client.impl.command

Class CreateRoleCommandImpl

java.lang.Object

io.camunda.client.impl.command.CreateRoleCommandImpl

All Implemented Interfaces:

CreateRoleCommandStep1, CreateRoleCommandStep1.CreateRoleCommandStep2, FinalCommandStep<CreateRoleResponse>

public final class CreateRoleCommandImpl
extends Object
implements CreateRoleCommandStep1, CreateRoleCommandStep1.CreateRoleCommandStep2

Nested Class Summary

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

CreateRoleCommandStep1.CreateRoleCommandStep2

Constructor Summary

Constructors

Constructor	Description
CreateRoleCommandImpl(HttpClient httpClient, JsonMapper jsonMapper)

Method Summary

Modifier and Type	Method	Description
CreateRoleCommandStep1.CreateRoleCommandStep2	description(String description)	Set the description for the role to be created.
CreateRoleCommandStep1.CreateRoleCommandStep2	name(String name)	Set the name for the role to be created.
FinalCommandStep<CreateRoleResponse>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CreateRoleCommandStep1.CreateRoleCommandStep2	roleId(String roleId)	Set the ID to create role with.
CamundaFuture<CreateRoleResponse>	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

Constructor Details

CreateRoleCommandImpl

public CreateRoleCommandImpl(HttpClient httpClient,
 JsonMapper jsonMapper)

Method Details

roleId

public CreateRoleCommandStep1.CreateRoleCommandStep2 roleId(String roleId)

Description copied from interface: CreateRoleCommandStep1

Set the ID to create role with.

Specified by:

roleId in interface CreateRoleCommandStep1

Parameters:

roleId - the role ID

Returns:

the builder for this command.

name

public CreateRoleCommandStep1.CreateRoleCommandStep2 name(String name)

Description copied from interface: CreateRoleCommandStep1.CreateRoleCommandStep2

Set the name for the role to be created.

Specified by:

name in interface CreateRoleCommandStep1.CreateRoleCommandStep2

Parameters:

name - the role name

Returns:

the builder for this command

description

public CreateRoleCommandStep1.CreateRoleCommandStep2 description(String description)

Description copied from interface: CreateRoleCommandStep1.CreateRoleCommandStep2

Set the description for the role to be created.

Specified by:

description in interface CreateRoleCommandStep1.CreateRoleCommandStep2

Parameters:

description - the role description

Returns:

the builder for this command

requestTimeout

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

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

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

Returns:

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