io.axoniq.axonserver.connector.event.transformation.impl

Interface EventTransformationService

All Known Implementing Classes:

GrpcEventTransformationService

public interface EventTransformationService

Service to interact with AxonServer in respect to the event transformations.

Since:

2023.1.0

Author:

Sara Pellegrini

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	EventTransformationService.TransformationStream The stream toward the transformation needed to register the required events' changes.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	cancel(String transformationId) Requests to AxonServer to cancel the transformation with the specified identifier.
CompletableFuture<String>	newTransformation(String description) Creates a new transformation.
CompletableFuture<Void>	startApplying(String transformationId, Long sequence) Requests to AxonServer to apply the transformation with the specified identifier.
CompletableFuture<Void>	startCompacting() Requests to AxonServer to compact the event store.
CompletableFuture<EventTransformation>	transformationById(String id) Returns the Event Transformations with the specified id.
CompletableFuture<Iterable<EventTransformation>>	transformations() Returns all the existing Event Transformations.
EventTransformationService.TransformationStream	transformationStream(String transformationId) Opens a EventTransformationService.TransformationStream towards the transformation, that can be used to register the required changes.

Method Detail

transformations

CompletableFuture<Iterable<EventTransformation>> transformations()

Returns all the existing Event Transformations.

Returns:

a CompletableFuture of the Event Transformations

transformationById

CompletableFuture<EventTransformation> transformationById(String id)

Returns the Event Transformations with the specified id.

Parameters:

id - the id of the EventTransformation to be returned.

Returns:

a CompletableFuture of the EventTransformation with the specified id.

newTransformation

CompletableFuture<String> newTransformation(String description)

Creates a new transformation.

Parameters:

description - the description of the transformation to create.

Returns:

a CompletableFuture of the identifier of the newly created transformation.

transformationStream

EventTransformationService.TransformationStream transformationStream(String transformationId)

Opens a EventTransformationService.TransformationStream towards the transformation, that can be used to register the required changes.

Parameters:

transformationId - the identifier of the transformation

Returns:

the EventTransformationService.TransformationStream

startApplying

CompletableFuture<Void> startApplying(String transformationId,
                                      Long sequence)

Requests to AxonServer to apply the transformation with the specified identifier.

Parameters:

transformationId - the identifier of the transformation to be applied

sequence - the expected last sequence of the transformation, used to check that no change request has been lost

Returns:

a CompletableFuture that completes when the request has been received by Axon Server.

cancel

CompletableFuture<Void> cancel(String transformationId)

Requests to AxonServer to cancel the transformation with the specified identifier.

Parameters:

transformationId - the identifier of the transformation to be cancelled

Returns:

a CompletableFuture that completes when the request has been received by Axon Server.

startCompacting

CompletableFuture<Void> startCompacting()

Requests to AxonServer to compact the event store. In other words, the request to delete all obsoleted version of the events from the event store.

Returns:

a CompletableFuture that completes when the request has been received by Axon Server.