Package io.camunda.client.impl.command

Class UpdateGroupCommandImpl

java.lang.Object

io.camunda.client.impl.command.UpdateGroupCommandImpl

All Implemented Interfaces:

FinalCommandStep<UpdateGroupResponse>, UpdateGroupCommandStep1

public class UpdateGroupCommandImpl
extends Object
implements UpdateGroupCommandStep1

Constructor Summary

Constructors

Constructor	Description
UpdateGroupCommandImpl(String groupId, HttpClient httpClient, JsonMapper jsonMapper)

Method Summary

Modifier and Type	Method	Description
UpdateGroupCommandStep1	description(String description)	Sets the description for the group to be updated.
UpdateGroupCommandStep1	name(String name)	Sets the name for the group to be updated.
FinalCommandStep<UpdateGroupResponse>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<UpdateGroupResponse>	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

UpdateGroupCommandImpl

public UpdateGroupCommandImpl(String groupId,
 HttpClient httpClient,
 JsonMapper jsonMapper)

Method Details

name

public UpdateGroupCommandStep1 name(String name)

Description copied from interface: UpdateGroupCommandStep1

Sets the name for the group to be updated.

Specified by:

name in interface UpdateGroupCommandStep1

Parameters:

name - the group name to be updated

Returns:

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

description

public UpdateGroupCommandStep1 description(String description)

Description copied from interface: UpdateGroupCommandStep1

Sets the description for the group to be updated.

Specified by:

description in interface UpdateGroupCommandStep1

Parameters:

description - the group description to be updated

Returns:

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

requestTimeout

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

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

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

Returns:

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