EventTransformationChannel (AxonServer Connector 2023.1.1 API)

All Known Implementing Classes:

EventTransformationChannelImpl
```
public interface EventTransformationChannel
```
Communication channel for Event Transformation related interactions with AxonServer.

Since:

2023.1.0

Author:

Sara Pellegrini

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`CompletableFuture<ActiveTransformation>`	`activeTransformation()` Returns the completable future of the active transformation.
`CompletableFuture<ActiveTransformation>`	`newTransformation(String description)` Starts a new transformation to append events change actions.
`CompletableFuture<Void>`	`startCompacting()` Starts the compaction of the event store.
`default CompletableFuture<EventTransformation>`	`transform(String description, Transformer transformer)` This method conveniently composes the creation of a new transformation, the registration of all required changes and the request to apply them to the event store, in a single invocation.
`CompletableFuture<Iterable<EventTransformation>>`	`transformations()` Returns the completable future of the all transformations.

- Method Detail
  - transformations
```
CompletableFuture<Iterable<EventTransformation>> transformations()
```
    Returns the completable future of the all transformations.
    
    Returns:
    
    the completable future of the all transformations.
  - activeTransformation
```
CompletableFuture<ActiveTransformation> activeTransformation()
```
    Returns the completable future of the active transformation.
    
    Returns:
    
    The completable future of the active transformation.
  - newTransformation
```
CompletableFuture<ActiveTransformation> newTransformation(String description)
```
    Starts a new transformation to append events change actions. It
    
    Parameters:
    
    description - the description of the transformation to start.
    
    Returns:
    
    The completable future of the active transformation reference onto which to register events transformation actions.
  - startCompacting
```
CompletableFuture<Void> startCompacting()
```
    Starts the compaction of the event store. The invocation of this method requests Axon Server to permanently delete all the obsoleted version of the event store, in order to save storage space.
    
    Returns:
    
    a CompletableFuture that completes when the compaction request has been received by Axon Server.
  - transform
```
default CompletableFuture<EventTransformation> transform(String description,
                                                         Transformer transformer)
```
    This method conveniently composes the creation of a new transformation, the registration of all required changes and the request to apply them to the event store, in a single invocation.
    
    Parameters:
    
    description - the description of the transformation
    
    transformer - the transformer used to register the required changes
    
    Returns:
    
    a CompletableFuture of the EventTransformation

Interface EventTransformationChannel

Method Summary

Method Detail

transformations

activeTransformation

newTransformation

startCompacting

transform