AsyncDataProcessor (javadoc 2024.12-174331 API)

All Superinterfaces:

AgentExtension, TeamCityExtension

All Known Subinterfaces:

BuildStepAsyncDataProcessor
```
public interface AsyncDataProcessor
extends AgentExtension
```
A contract for data processors that asynchronously process data and return an AsyncDataProcessingTask instance to control the execution of the processing.

Since:

2024.3

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`String`	`getType()`	Get the data processor type that uniquely identifies the data processor.
`AsyncDataProcessingTask`	`startDataProcessing(DataProcessorContext context)`	Starts asynchronously processing data and returns an `AsyncDataProcessingTask` instance to control the execution of the processing
`default void`	`validateArguments(Map<String,String> arguments)`	Validate arguments provided to the processor.

- Method Detail
  - getType
```
@NotNull
String getType()
```
    Get the data processor type that uniquely identifies the data processor.
    
    Returns:
    
    data processor type
  - validateArguments
```
default void validateArguments(@NotNull
                               Map<String,String> arguments)
                        throws IllegalArgumentException
```
    Validate arguments provided to the processor. The validation happens before the data processing is executed.
    
    Parameters:
    
    arguments - provided arguments
    
    Throws:
    
    IllegalArgumentException - implementation is expected to throw an IllegalArgumentException if a processor argument is invalid
  - startDataProcessing
```
@NotNull
AsyncDataProcessingTask startDataProcessing(@NotNull
                                            DataProcessorContext context)
                                     throws Exception
```
    Starts asynchronously processing data and returns an AsyncDataProcessingTask instance to control the execution of the processing
    
    Parameters:
    
    context - processing context
    
    Returns:
    
    an AsyncDataProcessingTask instance to control the execution of the processing
    
    Throws:
    
    Exception - implementation is expected to throw an Exception if an error was encountered while starting processing