Package ai.pipestream.data.module.v1

Class ServiceMetadata

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
ai.pipestream.data.module.v1.ServiceMetadata
All Implemented Interfaces:
ServiceMetadataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ServiceMetadata extends com.google.protobuf.GeneratedMessage implements ServiceMetadataOrBuilder
 Contains metadata provided by the pipeline engine for context.
 This data is generally for informational purposes, logging, tracing, or advanced conditional logic.
Protobuf type ai.pipestream.data.module.v1.ServiceMetadata
See Also:

  • Field Details

    • PIPELINE_NAME_FIELD_NUMBER

      public static final int PIPELINE_NAME_FIELD_NUMBER
      See Also:

    • PIPE_STEP_NAME_FIELD_NUMBER

      public static final int PIPE_STEP_NAME_FIELD_NUMBER
      See Also:

    • STREAM_ID_FIELD_NUMBER

      public static final int STREAM_ID_FIELD_NUMBER
      See Also:

    • CURRENT_HOP_NUMBER_FIELD_NUMBER

      public static final int CURRENT_HOP_NUMBER_FIELD_NUMBER
      See Also:

    • HISTORY_FIELD_NUMBER

      public static final int HISTORY_FIELD_NUMBER
      See Also:

    • STREAM_ERROR_DATA_FIELD_NUMBER

      public static final int STREAM_ERROR_DATA_FIELD_NUMBER
      See Also:

    • CONTEXT_PARAMS_FIELD_NUMBER

      public static final int CONTEXT_PARAMS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getPipelineName

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

    • getPipelineNameBytes

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

    • getPipeStepName

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

    • getPipeStepNameBytes

      public 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"];
      Specified by:
      getPipeStepNameBytes in interface ServiceMetadataOrBuilder
      Returns:
      The bytes for pipeStepName.

    • getStreamId

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

    • getStreamIdBytes

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

    • getCurrentHopNumber

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

    • getHistoryList

      public 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"];
      Specified by:
      getHistoryList in interface ServiceMetadataOrBuilder

    • getHistoryOrBuilderList

      public 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"];
      Specified by:
      getHistoryOrBuilderList in interface ServiceMetadataOrBuilder

    • getHistoryCount

      public 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"];
      Specified by:
      getHistoryCount in interface ServiceMetadataOrBuilder

    • getHistory

      public 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"];
      Specified by:
      getHistory in interface ServiceMetadataOrBuilder

    • getHistoryOrBuilder

      public 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"];
      Specified by:
      getHistoryOrBuilder in interface ServiceMetadataOrBuilder

    • hasStreamErrorData

      public 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"];
      Specified by:
      hasStreamErrorData in interface ServiceMetadataOrBuilder
      Returns:
      Whether the streamErrorData field is set.

    • getStreamErrorData

      public 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"];
      Specified by:
      getStreamErrorData in interface ServiceMetadataOrBuilder
      Returns:
      The streamErrorData.

    • getStreamErrorDataOrBuilder

      public 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"];
      Specified by:
      getStreamErrorDataOrBuilder in interface ServiceMetadataOrBuilder

    • getContextParamsCount

      public int getContextParamsCount()
      Description copied from interface: ServiceMetadataOrBuilder
       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"];
      Specified by:
      getContextParamsCount in interface ServiceMetadataOrBuilder

    • containsContextParams

      public 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"];
      Specified by:
      containsContextParams in interface ServiceMetadataOrBuilder

    • getContextParams

      @Deprecated public Map<String,String> getContextParams()
      Deprecated.
      Use getContextParamsMap() instead.
      Specified by:
      getContextParams in interface ServiceMetadataOrBuilder

    • getContextParamsMap

      public 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"];
      Specified by:
      getContextParamsMap in interface ServiceMetadataOrBuilder

    • getContextParamsOrDefault

      public 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"];
      Specified by:
      getContextParamsOrDefault in interface ServiceMetadataOrBuilder

    • getContextParamsOrThrow

      public 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"];
      Specified by:
      getContextParamsOrThrow in interface ServiceMetadataOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ServiceMetadata parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ServiceMetadata parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ServiceMetadata parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ServiceMetadata parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ServiceMetadata parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ServiceMetadata parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ServiceMetadata parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ServiceMetadata parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ServiceMetadata parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ServiceMetadata parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ServiceMetadata parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ServiceMetadata parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ServiceMetadata.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ServiceMetadata.Builder newBuilder()

    • newBuilder

      public static ServiceMetadata.Builder newBuilder(ServiceMetadata prototype)

    • toBuilder

      public ServiceMetadata.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ServiceMetadata.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ServiceMetadata getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ServiceMetadata> parser()

    • getParserForType

      public com.google.protobuf.Parser<ServiceMetadata> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public ServiceMetadata getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder