Package io.camunda.client.impl.command

Class CreateGroupCommandImpl

java.lang.Object

io.camunda.client.impl.command.CreateGroupCommandImpl

All Implemented Interfaces:

CreateGroupCommandStep1, CreateGroupCommandStep1.CreateGroupCommandStep2, FinalCommandStep<CreateGroupResponse>

public class CreateGroupCommandImpl
extends Object
implements CreateGroupCommandStep1, CreateGroupCommandStep1.CreateGroupCommandStep2

Nested Class Summary

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

CreateGroupCommandStep1.CreateGroupCommandStep2

Constructor Summary

Constructors

Constructor	Description
CreateGroupCommandImpl(HttpClient httpClient, JsonMapper jsonMapper)

Method Summary

Modifier and Type	Method	Description
CreateGroupCommandStep1.CreateGroupCommandStep2	description(String description)	Set the description for the group to be created..
CreateGroupCommandStep1.CreateGroupCommandStep2	groupId(String groupId)	Set the ID for the group to be created.
CreateGroupCommandStep1.CreateGroupCommandStep2	name(String name)	Set the name for the group to be created.
FinalCommandStep<CreateGroupResponse>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<CreateGroupResponse>	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

CreateGroupCommandImpl

public CreateGroupCommandImpl(HttpClient httpClient,
 JsonMapper jsonMapper)

Method Details

groupId

public CreateGroupCommandStep1.CreateGroupCommandStep2 groupId(String groupId)

Description copied from interface: CreateGroupCommandStep1

Set the ID for the group to be created.

Specified by:

groupId in interface CreateGroupCommandStep1

Parameters:

groupId - the group ID

Returns:

the builder for this command

name

public CreateGroupCommandStep1.CreateGroupCommandStep2 name(String name)

Description copied from interface: CreateGroupCommandStep1.CreateGroupCommandStep2

Set the name for the group to be created.

Specified by:

name in interface CreateGroupCommandStep1.CreateGroupCommandStep2

Parameters:

name - the group name

Returns:

the builder for this command

description

public CreateGroupCommandStep1.CreateGroupCommandStep2 description(String description)

Description copied from interface: CreateGroupCommandStep1.CreateGroupCommandStep2

Set the description for the group to be created..

Specified by:

description in interface CreateGroupCommandStep1.CreateGroupCommandStep2

Parameters:

description - the group description

Returns:

the builder for this command

requestTimeout

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

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

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

Returns:

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