Package ai.pipestream.api.annotation

Annotation Interface ProcessingBuffered

@InterceptorBinding @Retention(RUNTIME) @Target({METHOD,TYPE}) public @interface ProcessingBuffered
Annotation to enable automatic processing buffer capture for pipeline methods.

When applied to a method that returns ProcessResponse, this annotation will: 1. Automatically capture the output document (PipeDoc) from ProcessResponse 2. Store it in a ProcessingBuffer when enabled via configuration 3. Provide seamless test data capture without manual buffer management

Configuration is controlled via properties: - processing.buffer.enabled: Enable/disable buffer capture (default: false) - processing.buffer.capacity: Buffer capacity (default: 100) - processing.buffer.directory: Save directory (default: target/test-data)

Example usage: 

 
 @ProcessingBuffered(type = PipeDoc.class, enabled = "${processing.buffer.enabled:false}")
 public Uni<ProcessResponse> processData(ProcessRequest request) {
     // Normal processing logic - buffer capture is automatic
     return Uni.createFrom().item(response);
 }

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    Class<? extends com.google.protobuf.Message>
    type
    The type of protobuf message to capture from the ProcessResponse.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    capacity
    Buffer capacity override.
    String
    directory
    Buffer save directory override.
    String
    enabled
    Whether buffer capture is enabled.
    String
    prefix
    Buffer file prefix for saved files.

  • Element Details

    • type

      Class<? extends com.google.protobuf.Message> type
      The type of protobuf message to capture from the ProcessResponse. Currently supports PipeDoc.class for output document capture.

    • enabled

      String enabled
      Whether buffer capture is enabled. Supports configuration expressions like "${processing.buffer.enabled:false}". Default is false to avoid unexpected buffer usage.
      Default:
      "false"

    • capacity

      String capacity
      Buffer capacity override. Supports configuration expressions like "${processing.buffer.capacity:100}". If not specified, uses the global configuration or default value.
      Default:
      ""

    • directory

      String directory
      Buffer save directory override. Supports configuration expressions like "${processing.buffer.directory:target/test-data}". If not specified, uses the global configuration or default value.
      Default:
      ""

    • prefix

      String prefix
      Buffer file prefix for saved files. Supports configuration expressions like "${processing.buffer.prefix:processed}". If not specified, uses the module name as prefix.
      Default:
      ""