Package ai.pipestream.data.module.v1

Interface ServiceMetadataOrBuilder

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

  • Method Details

    • getPipelineName

      String getPipelineName()
       The 'pipelineName' from PipelineConfig providing context for this call.
      string pipeline_name = 1 [json_name = "pipelineName"];
      Returns:
      The pipelineName.

    • getPipelineNameBytes

      com.google.protobuf.ByteString getPipelineNameBytes()
       The 'pipelineName' from PipelineConfig providing context for this call.
      string pipeline_name = 1 [json_name = "pipelineName"];
      Returns:
      The bytes for pipelineName.

    • getPipeStepName

      String getPipeStepName()
       The 'stepName' from PipelineStepConfig that this gRPC service instance is currently executing as.
      string pipe_step_name = 2 [json_name = "pipeStepName"];
      Returns:
      The pipeStepName.

    • getPipeStepNameBytes

      com.google.protobuf.ByteString getPipeStepNameBytes()
       The 'stepName' from PipelineStepConfig that this gRPC service instance is currently executing as.
      string pipe_step_name = 2 [json_name = "pipeStepName"];
      Returns:
      The bytes for pipeStepName.

    • getStreamId

      String getStreamId()
       Unique ID for the entire execution flow (equivalent to PipeStream.stream_id).
      string stream_id = 3 [json_name = "streamId"];
      Returns:
      The streamId.

    • getStreamIdBytes

      com.google.protobuf.ByteString getStreamIdBytes()
       Unique ID for the entire execution flow (equivalent to PipeStream.stream_id).
      string stream_id = 3 [json_name = "streamId"];
      Returns:
      The bytes for streamId.

    • getCurrentHopNumber

      long getCurrentHopNumber()
       The current hop number in the pipeline for this step's execution.
      int64 current_hop_number = 4 [json_name = "currentHopNumber"];
      Returns:
      The currentHopNumber.

    • getHistoryList

      List<StepExecutionRecord> getHistoryList()
       History of previously executed steps in this stream.
 Note: This can be large. Modules should use it judiciously.
      repeated .ai.pipestream.data.v1.StepExecutionRecord history = 5 [json_name = "history"];

    • getHistory

      StepExecutionRecord getHistory(int index)
       History of previously executed steps in this stream.
 Note: This can be large. Modules should use it judiciously.
      repeated .ai.pipestream.data.v1.StepExecutionRecord history = 5 [json_name = "history"];

    • getHistoryCount

      int getHistoryCount()
       History of previously executed steps in this stream.
 Note: This can be large. Modules should use it judiciously.
      repeated .ai.pipestream.data.v1.StepExecutionRecord history = 5 [json_name = "history"];

    • getHistoryOrBuilderList

      List<? extends StepExecutionRecordOrBuilder> getHistoryOrBuilderList()
       History of previously executed steps in this stream.
 Note: This can be large. Modules should use it judiciously.
      repeated .ai.pipestream.data.v1.StepExecutionRecord history = 5 [json_name = "history"];

    • getHistoryOrBuilder

      StepExecutionRecordOrBuilder getHistoryOrBuilder(int index)
       History of previously executed steps in this stream.
 Note: This can be large. Modules should use it judiciously.
      repeated .ai.pipestream.data.v1.StepExecutionRecord history = 5 [json_name = "history"];

    • hasStreamErrorData

      boolean hasStreamErrorData()
       If the overall stream was previously marked with a critical error.
 Modules might use this to alter behavior (e.g., skip processing if stream is already failed).
      optional .ai.pipestream.data.v1.ErrorData stream_error_data = 6 [json_name = "streamErrorData"];
      Returns:
      Whether the streamErrorData field is set.

    • getStreamErrorData

      ErrorData getStreamErrorData()
       If the overall stream was previously marked with a critical error.
 Modules might use this to alter behavior (e.g., skip processing if stream is already failed).
      optional .ai.pipestream.data.v1.ErrorData stream_error_data = 6 [json_name = "streamErrorData"];
      Returns:
      The streamErrorData.

    • getStreamErrorDataOrBuilder

      ErrorDataOrBuilder getStreamErrorDataOrBuilder()
       If the overall stream was previously marked with a critical error.
 Modules might use this to alter behavior (e.g., skip processing if stream is already failed).
      optional .ai.pipestream.data.v1.ErrorData stream_error_data = 6 [json_name = "streamErrorData"];

    • getContextParamsCount

      int getContextParamsCount()
       Key-value parameters for the entire run's context (e.g., tenant_id, user_id, correlation_id).
 Equivalent to PipeStream.context_params.
      map<string, string> context_params = 7 [json_name = "contextParams"];

    • containsContextParams

      boolean containsContextParams(String key)
       Key-value parameters for the entire run's context (e.g., tenant_id, user_id, correlation_id).
 Equivalent to PipeStream.context_params.
      map<string, string> context_params = 7 [json_name = "contextParams"];

    • getContextParams

      @Deprecated Map<String,String> getContextParams()
      Deprecated.
      Use getContextParamsMap() instead.

    • getContextParamsMap

      Map<String,String> getContextParamsMap()
       Key-value parameters for the entire run's context (e.g., tenant_id, user_id, correlation_id).
 Equivalent to PipeStream.context_params.
      map<string, string> context_params = 7 [json_name = "contextParams"];

    • getContextParamsOrDefault

      String getContextParamsOrDefault(String key, String defaultValue)
       Key-value parameters for the entire run's context (e.g., tenant_id, user_id, correlation_id).
 Equivalent to PipeStream.context_params.
      map<string, string> context_params = 7 [json_name = "contextParams"];

    • getContextParamsOrThrow

      String getContextParamsOrThrow(String key)
       Key-value parameters for the entire run's context (e.g., tenant_id, user_id, correlation_id).
 Equivalent to PipeStream.context_params.
      map<string, string> context_params = 7 [json_name = "contextParams"];