Package ai.pipestream.data.module.v1

Interface ProcessDataResponseOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ProcessDataResponse, ProcessDataResponse.Builder
@Generated public interface ProcessDataResponseOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.Struct
    getErrorDetails()
    Error Details: Structured error information from *this processor* if success is false.
    com.google.protobuf.StructOrBuilder
    getErrorDetailsOrBuilder()
    Error Details: Structured error information from *this processor* if success is false.
    PipeDoc
    getOutputDoc()
    Output Data: The modified or newly created PipeDoc.
    PipeDocOrBuilder
    getOutputDocOrBuilder()
    Output Data: The modified or newly created PipeDoc.
    String
    getProcessorLogs(int index)
    Logging: Logs or summary information generated by this processor step.
    com.google.protobuf.ByteString
    getProcessorLogsBytes(int index)
    Logging: Logs or summary information generated by this processor step.
    int
    getProcessorLogsCount()
    Logging: Logs or summary information generated by this processor step.
    List<String>
    getProcessorLogsList()
    Logging: Logs or summary information generated by this processor step.
    boolean
    getSuccess()
    Outcome: True if this step's processing was successful, false otherwise.
    boolean
    hasErrorDetails()
    Error Details: Structured error information from *this processor* if success is false.
    boolean
    hasOutputDoc()
    Output Data: The modified or newly created PipeDoc.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getSuccess

      boolean getSuccess()
       Outcome: True if this step's processing was successful, false otherwise.
      bool success = 1 [json_name = "success"];
      Returns:
      The success.

    • hasOutputDoc

      boolean hasOutputDoc()
       Output Data: The modified or newly created PipeDoc.
 either remains unchanged or that this step does not modify the PipeDoc directly.
 The Blob is part of the PipeDoc.
      optional .ai.pipestream.data.v1.PipeDoc output_doc = 2 [json_name = "outputDoc"];
      Returns:
      Whether the outputDoc field is set.

    • getOutputDoc

      PipeDoc getOutputDoc()
       Output Data: The modified or newly created PipeDoc.
 either remains unchanged or that this step does not modify the PipeDoc directly.
 The Blob is part of the PipeDoc.
      optional .ai.pipestream.data.v1.PipeDoc output_doc = 2 [json_name = "outputDoc"];
      Returns:
      The outputDoc.

    • getOutputDocOrBuilder

      PipeDocOrBuilder getOutputDocOrBuilder()
       Output Data: The modified or newly created PipeDoc.
 either remains unchanged or that this step does not modify the PipeDoc directly.
 The Blob is part of the PipeDoc.
      optional .ai.pipestream.data.v1.PipeDoc output_doc = 2 [json_name = "outputDoc"];

    • hasErrorDetails

      boolean hasErrorDetails()
       Error Details: Structured error information from *this processor* if success is false.
 This is for errors specific to the processor's execution logic.
      optional .google.protobuf.Struct error_details = 3 [json_name = "errorDetails"];
      Returns:
      Whether the errorDetails field is set.

    • getErrorDetails

      com.google.protobuf.Struct getErrorDetails()
       Error Details: Structured error information from *this processor* if success is false.
 This is for errors specific to the processor's execution logic.
      optional .google.protobuf.Struct error_details = 3 [json_name = "errorDetails"];
      Returns:
      The errorDetails.

    • getErrorDetailsOrBuilder

      com.google.protobuf.StructOrBuilder getErrorDetailsOrBuilder()
       Error Details: Structured error information from *this processor* if success is false.
 This is for errors specific to the processor's execution logic.
      optional .google.protobuf.Struct error_details = 3 [json_name = "errorDetails"];

    • getProcessorLogsList

      List<String> getProcessorLogsList()
       Logging: Logs or summary information generated by this processor step.
      repeated string processor_logs = 4 [json_name = "processorLogs"];
      Returns:
      A list containing the processorLogs.

    • getProcessorLogsCount

      int getProcessorLogsCount()
       Logging: Logs or summary information generated by this processor step.
      repeated string processor_logs = 4 [json_name = "processorLogs"];
      Returns:
      The count of processorLogs.

    • getProcessorLogs

      String getProcessorLogs(int index)
       Logging: Logs or summary information generated by this processor step.
      repeated string processor_logs = 4 [json_name = "processorLogs"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The processorLogs at the given index.

    • getProcessorLogsBytes

      com.google.protobuf.ByteString getProcessorLogsBytes(int index)
       Logging: Logs or summary information generated by this processor step.
      repeated string processor_logs = 4 [json_name = "processorLogs"];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the processorLogs at the given index.