Class ServiceMetadata.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<ServiceMetadata.Builder>
com.google.protobuf.GeneratedMessage.Builder<ServiceMetadata.Builder>
ai.pipestream.data.module.v1.ServiceMetadata.Builder
All Implemented Interfaces:
ServiceMetadataOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ServiceMetadata

public static final class ServiceMetadata.Builder extends com.google.protobuf.GeneratedMessage.Builder<ServiceMetadata.Builder> 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
  • 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.Builder<ServiceMetadata.Builder>
    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<ServiceMetadata.Builder>
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ServiceMetadata.Builder>
    • clear

      public ServiceMetadata.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<ServiceMetadata.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ServiceMetadata.Builder>
    • getDefaultInstanceForType

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

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

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

      public ServiceMetadata.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ServiceMetadata.Builder>
    • mergeFrom

      public ServiceMetadata.Builder mergeFrom(ServiceMetadata other)
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ServiceMetadata.Builder>
    • mergeFrom

      public ServiceMetadata.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ServiceMetadata.Builder>
      Throws:
      IOException
    • 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.
    • setPipelineName

      public ServiceMetadata.Builder setPipelineName(String value)
       The 'pipelineName' from PipelineConfig providing context for this call.
       
      string pipeline_name = 1 [json_name = "pipelineName"];
      Parameters:
      value - The pipelineName to set.
      Returns:
      This builder for chaining.
    • clearPipelineName

      public ServiceMetadata.Builder clearPipelineName()
       The 'pipelineName' from PipelineConfig providing context for this call.
       
      string pipeline_name = 1 [json_name = "pipelineName"];
      Returns:
      This builder for chaining.
    • setPipelineNameBytes

      public ServiceMetadata.Builder setPipelineNameBytes(com.google.protobuf.ByteString value)
       The 'pipelineName' from PipelineConfig providing context for this call.
       
      string pipeline_name = 1 [json_name = "pipelineName"];
      Parameters:
      value - The bytes for pipelineName to set.
      Returns:
      This builder for chaining.
    • 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.
    • setPipeStepName

      public ServiceMetadata.Builder setPipeStepName(String value)
       The 'stepName' from PipelineStepConfig that this gRPC service instance is currently executing as.
       
      string pipe_step_name = 2 [json_name = "pipeStepName"];
      Parameters:
      value - The pipeStepName to set.
      Returns:
      This builder for chaining.
    • clearPipeStepName

      public ServiceMetadata.Builder clearPipeStepName()
       The 'stepName' from PipelineStepConfig that this gRPC service instance is currently executing as.
       
      string pipe_step_name = 2 [json_name = "pipeStepName"];
      Returns:
      This builder for chaining.
    • setPipeStepNameBytes

      public ServiceMetadata.Builder setPipeStepNameBytes(com.google.protobuf.ByteString value)
       The 'stepName' from PipelineStepConfig that this gRPC service instance is currently executing as.
       
      string pipe_step_name = 2 [json_name = "pipeStepName"];
      Parameters:
      value - The bytes for pipeStepName to set.
      Returns:
      This builder for chaining.
    • 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.
    • setStreamId

      public ServiceMetadata.Builder setStreamId(String value)
       Unique ID for the entire execution flow (equivalent to PipeStream.stream_id).
       
      string stream_id = 3 [json_name = "streamId"];
      Parameters:
      value - The streamId to set.
      Returns:
      This builder for chaining.
    • clearStreamId

      public ServiceMetadata.Builder clearStreamId()
       Unique ID for the entire execution flow (equivalent to PipeStream.stream_id).
       
      string stream_id = 3 [json_name = "streamId"];
      Returns:
      This builder for chaining.
    • setStreamIdBytes

      public ServiceMetadata.Builder setStreamIdBytes(com.google.protobuf.ByteString value)
       Unique ID for the entire execution flow (equivalent to PipeStream.stream_id).
       
      string stream_id = 3 [json_name = "streamId"];
      Parameters:
      value - The bytes for streamId to set.
      Returns:
      This builder for chaining.
    • 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.
    • setCurrentHopNumber

      public ServiceMetadata.Builder setCurrentHopNumber(long value)
       The current hop number in the pipeline for this step's execution.
       
      int64 current_hop_number = 4 [json_name = "currentHopNumber"];
      Parameters:
      value - The currentHopNumber to set.
      Returns:
      This builder for chaining.
    • clearCurrentHopNumber

      public ServiceMetadata.Builder clearCurrentHopNumber()
       The current hop number in the pipeline for this step's execution.
       
      int64 current_hop_number = 4 [json_name = "currentHopNumber"];
      Returns:
      This builder for chaining.
    • 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
    • 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
    • setHistory

      public ServiceMetadata.Builder setHistory(int index, StepExecutionRecord value)
       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"];
    • setHistory

      public ServiceMetadata.Builder setHistory(int index, StepExecutionRecord.Builder builderForValue)
       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"];
    • addHistory

      public ServiceMetadata.Builder addHistory(StepExecutionRecord value)
       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"];
    • addHistory

      public ServiceMetadata.Builder addHistory(int index, StepExecutionRecord value)
       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"];
    • addHistory

      public ServiceMetadata.Builder addHistory(StepExecutionRecord.Builder builderForValue)
       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"];
    • addHistory

      public ServiceMetadata.Builder addHistory(int index, StepExecutionRecord.Builder builderForValue)
       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"];
    • addAllHistory

      public ServiceMetadata.Builder addAllHistory(Iterable<? extends StepExecutionRecord> values)
       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"];
    • clearHistory

      public ServiceMetadata.Builder clearHistory()
       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"];
    • removeHistory

      public ServiceMetadata.Builder removeHistory(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"];
    • getHistoryBuilder

      public StepExecutionRecord.Builder getHistoryBuilder(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"];
    • 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
    • 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
    • addHistoryBuilder

      public StepExecutionRecord.Builder addHistoryBuilder()
       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"];
    • addHistoryBuilder

      public StepExecutionRecord.Builder addHistoryBuilder(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"];
    • getHistoryBuilderList

      public List<StepExecutionRecord.Builder> getHistoryBuilderList()
       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

      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.
    • setStreamErrorData

      public ServiceMetadata.Builder setStreamErrorData(ErrorData value)
       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"];
    • setStreamErrorData

      public ServiceMetadata.Builder setStreamErrorData(ErrorData.Builder builderForValue)
       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"];
    • mergeStreamErrorData

      public ServiceMetadata.Builder mergeStreamErrorData(ErrorData value)
       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"];
    • clearStreamErrorData

      public ServiceMetadata.Builder clearStreamErrorData()
       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"];
    • getStreamErrorDataBuilder

      public ErrorData.Builder getStreamErrorDataBuilder()
       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"];
    • 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.
      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
    • clearContextParams

      public ServiceMetadata.Builder clearContextParams()
    • removeContextParams

      public ServiceMetadata.Builder removeContextParams(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"];
    • getMutableContextParams

      @Deprecated public Map<String,String> getMutableContextParams()
      Deprecated.
      Use alternate mutation accessors instead.
    • putContextParams

      public ServiceMetadata.Builder putContextParams(String key, String value)
       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"];
    • putAllContextParams

      public ServiceMetadata.Builder putAllContextParams(Map<String,String> values)
       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"];