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(long groupKey, HttpClient httpClient, JsonMapper jsonMapper)

Method Summary

Modifier and Type	Method	Description
FinalCommandStep<UpdateGroupResponse>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<UpdateGroupResponse>	send()	Sends the command to the Camunda gateway.
UpdateGroupCommandStep1	update(GroupChangeset groupChangeset)	Updates the name of this group.
UpdateGroupCommandStep1	updateName(String name)	Sets the name for the group to be updated.

Methods inherited from class java.lang.Object

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

Constructor Details

UpdateGroupCommandImpl

public UpdateGroupCommandImpl(long groupKey,
 HttpClient httpClient,
 JsonMapper jsonMapper)

Method Details

update

public UpdateGroupCommandStep1 update(GroupChangeset groupChangeset)

Description copied from interface: UpdateGroupCommandStep1

Updates the name of this group.

Specified by:

update in interface UpdateGroupCommandStep1

Parameters:

groupChangeset - the changeset of this group, if a field is not provided (equals to null) it will be not updated

Returns:

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

updateName

public UpdateGroupCommandStep1 updateName(String name)

Description copied from interface: UpdateGroupCommandStep1

Sets the name for the group to be updated.

Specified by:

updateName 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.

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.