Package ai.pipestream.data.v1

Class OutputHints

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
ai.pipestream.data.v1.OutputHints
All Implemented Interfaces:
OutputHintsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class OutputHints extends com.google.protobuf.GeneratedMessage implements OutputHintsOrBuilder
 Output hints for downstream processing and routing.

 Contains routing information and hints for how the document should be
 processed by downstream modules and where it should ultimately be stored/indexed.
Protobuf type ai.pipestream.data.v1.OutputHints
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    OutputHints.Builder
    Output hints for downstream processing and routing.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DESIRED_COLLECTION_FIELD_NUMBER
     
    static final int
    ROUTING_HINTS_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsRoutingHints(String key)
    Routing hints for downstream modules.
    boolean
    equals(Object obj)
     
    static OutputHints
    getDefaultInstance()
     
    OutputHints
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getDesiredCollection()
    OpenSearch collection/index hint.
    com.google.protobuf.ByteString
    getDesiredCollectionBytes()
    OpenSearch collection/index hint.
    com.google.protobuf.Parser<OutputHints>
    getParserForType()
     
    Map<String,String>
    getRoutingHints()
    Deprecated.
    int
    getRoutingHintsCount()
    Routing hints for downstream modules.
    Map<String,String>
    getRoutingHintsMap()
    Routing hints for downstream modules.
    String
    getRoutingHintsOrDefault(String key, String defaultValue)
    Routing hints for downstream modules.
    String
    getRoutingHintsOrThrow(String key)
    Routing hints for downstream modules.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapFieldReflectionAccessor
    internalGetMapFieldReflection(int number)
     
    final boolean
    isInitialized()
     
    static OutputHints.Builder
    newBuilder()
     
    static OutputHints.Builder
    newBuilder(OutputHints prototype)
     
    OutputHints.Builder
    newBuilderForType()
     
    protected OutputHints.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static OutputHints
    parseDelimitedFrom(InputStream input)
     
    static OutputHints
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static OutputHints
    parseFrom(byte[] data)
     
    static OutputHints
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static OutputHints
    parseFrom(com.google.protobuf.ByteString data)
     
    static OutputHints
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static OutputHints
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static OutputHints
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static OutputHints
    parseFrom(InputStream input)
     
    static OutputHints
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static OutputHints
    parseFrom(ByteBuffer data)
     
    static OutputHints
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<OutputHints>
    parser()
     
    OutputHints.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • DESIRED_COLLECTION_FIELD_NUMBER

      public static final int DESIRED_COLLECTION_FIELD_NUMBER
      See Also:

    • ROUTING_HINTS_FIELD_NUMBER

      public static final int ROUTING_HINTS_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

    • getDesiredCollection

      public String getDesiredCollection()
       OpenSearch collection/index hint.

 Specifies the target collection or index where this document should be indexed.
      string desired_collection = 1 [json_name = "desiredCollection"];
      Specified by:
      getDesiredCollection in interface OutputHintsOrBuilder
      Returns:
      The desiredCollection.

    • getDesiredCollectionBytes

      public com.google.protobuf.ByteString getDesiredCollectionBytes()
       OpenSearch collection/index hint.

 Specifies the target collection or index where this document should be indexed.
      string desired_collection = 1 [json_name = "desiredCollection"];
      Specified by:
      getDesiredCollectionBytes in interface OutputHintsOrBuilder
      Returns:
      The bytes for desiredCollection.

    • getRoutingHintsCount

      public int getRoutingHintsCount()
      Description copied from interface: OutputHintsOrBuilder
       Routing hints for downstream modules.

 Key-value pairs that modules can use to make routing or processing decisions.
      map<string, string> routing_hints = 2 [json_name = "routingHints"];
      Specified by:
      getRoutingHintsCount in interface OutputHintsOrBuilder

    • containsRoutingHints

      public boolean containsRoutingHints(String key)
       Routing hints for downstream modules.

 Key-value pairs that modules can use to make routing or processing decisions.
      map<string, string> routing_hints = 2 [json_name = "routingHints"];
      Specified by:
      containsRoutingHints in interface OutputHintsOrBuilder

    • getRoutingHints

      @Deprecated public Map<String,String> getRoutingHints()
      Deprecated.
      Use getRoutingHintsMap() instead.
      Specified by:
      getRoutingHints in interface OutputHintsOrBuilder

    • getRoutingHintsMap

      public Map<String,String> getRoutingHintsMap()
       Routing hints for downstream modules.

 Key-value pairs that modules can use to make routing or processing decisions.
      map<string, string> routing_hints = 2 [json_name = "routingHints"];
      Specified by:
      getRoutingHintsMap in interface OutputHintsOrBuilder

    • getRoutingHintsOrDefault

      public String getRoutingHintsOrDefault(String key, String defaultValue)
       Routing hints for downstream modules.

 Key-value pairs that modules can use to make routing or processing decisions.
      map<string, string> routing_hints = 2 [json_name = "routingHints"];
      Specified by:
      getRoutingHintsOrDefault in interface OutputHintsOrBuilder

    • getRoutingHintsOrThrow

      public String getRoutingHintsOrThrow(String key)
       Routing hints for downstream modules.

 Key-value pairs that modules can use to make routing or processing decisions.
      map<string, string> routing_hints = 2 [json_name = "routingHints"];
      Specified by:
      getRoutingHintsOrThrow in interface OutputHintsOrBuilder

    • 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 OutputHints parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static OutputHints.Builder newBuilder()

    • newBuilder

      public static OutputHints.Builder newBuilder(OutputHints prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static OutputHints getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<OutputHints> 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 OutputHints getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder