Package ai.pipestream.data.v1

Class PipeDoc

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
ai.pipestream.data.v1.PipeDoc
All Implemented Interfaces:
PipeDocOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class PipeDoc extends com.google.protobuf.GeneratedMessage implements PipeDocOrBuilder
 Core document container for the pipeline processing system.

 PipeDoc is the primary data structure flowing through the pipeline. It contains standardized
 search metadata, binary content (blobs), and flexible structured data for custom use cases.
Protobuf type ai.pipestream.data.v1.PipeDoc
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    PipeDoc.Builder
    Core document container for the pipeline processing system.

    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
    BLOB_BAG_FIELD_NUMBER
     
    static final int
    DOC_ID_FIELD_NUMBER
     
    static final int
    SEARCH_METADATA_FIELD_NUMBER
     
    static final int
    STRUCTURED_DATA_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
    equals(Object obj)
     
    BlobBag
    getBlobBag()
    Binary content container for document parsing.
    BlobBagOrBuilder
    getBlobBagOrBuilder()
    Binary content container for document parsing.
    static PipeDoc
    getDefaultInstance()
     
    PipeDoc
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getDocId()
    Unique identifier for this document across the entire system.
    com.google.protobuf.ByteString
    getDocIdBytes()
    Unique identifier for this document across the entire system.
    com.google.protobuf.Parser<PipeDoc>
    getParserForType()
     
    SearchMetadata
    getSearchMetadata()
    Standardized search engine metadata for OOTB indexing and querying.
    SearchMetadataOrBuilder
    getSearchMetadataOrBuilder()
    Standardized search engine metadata for OOTB indexing and querying.
    int
    getSerializedSize()
     
    com.google.protobuf.Any
    getStructuredData()
    Customer-provided structured data in any protobuf format.
    com.google.protobuf.AnyOrBuilder
    getStructuredDataOrBuilder()
    Customer-provided structured data in any protobuf format.
    boolean
    hasBlobBag()
    Binary content container for document parsing.
    int
    hashCode()
     
    boolean
    hasSearchMetadata()
    Standardized search engine metadata for OOTB indexing and querying.
    boolean
    hasStructuredData()
    Customer-provided structured data in any protobuf format.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static PipeDoc.Builder
    newBuilder()
     
    static PipeDoc.Builder
    newBuilder(PipeDoc prototype)
     
    PipeDoc.Builder
    newBuilderForType()
     
    protected PipeDoc.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static PipeDoc
    parseDelimitedFrom(InputStream input)
     
    static PipeDoc
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PipeDoc
    parseFrom(byte[] data)
     
    static PipeDoc
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PipeDoc
    parseFrom(com.google.protobuf.ByteString data)
     
    static PipeDoc
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PipeDoc
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static PipeDoc
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PipeDoc
    parseFrom(InputStream input)
     
    static PipeDoc
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PipeDoc
    parseFrom(ByteBuffer data)
     
    static PipeDoc
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<PipeDoc>
    parser()
     
    PipeDoc.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, internalGetMapFieldReflection, 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

    • DOC_ID_FIELD_NUMBER

      public static final int DOC_ID_FIELD_NUMBER
      See Also:

    • SEARCH_METADATA_FIELD_NUMBER

      public static final int SEARCH_METADATA_FIELD_NUMBER
      See Also:

    • BLOB_BAG_FIELD_NUMBER

      public static final int BLOB_BAG_FIELD_NUMBER
      See Also:

    • STRUCTURED_DATA_FIELD_NUMBER

      public static final int STRUCTURED_DATA_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • getDocId

      public String getDocId()
       Unique identifier for this document across the entire system.
      string doc_id = 1;
      Specified by:
      getDocId in interface PipeDocOrBuilder
      Returns:
      The docId.

    • getDocIdBytes

      public com.google.protobuf.ByteString getDocIdBytes()
       Unique identifier for this document across the entire system.
      string doc_id = 1;
      Specified by:
      getDocIdBytes in interface PipeDocOrBuilder
      Returns:
      The bytes for docId.

    • hasSearchMetadata

      public boolean hasSearchMetadata()
       Standardized search engine metadata for OOTB indexing and querying.

 This is intentionally less flexible to maintain a common API layer that all
 out-of-the-box indexing steps can rely on.
      .ai.pipestream.data.v1.SearchMetadata search_metadata = 2;
      Specified by:
      hasSearchMetadata in interface PipeDocOrBuilder
      Returns:
      Whether the searchMetadata field is set.

    • getSearchMetadata

      public SearchMetadata getSearchMetadata()
       Standardized search engine metadata for OOTB indexing and querying.

 This is intentionally less flexible to maintain a common API layer that all
 out-of-the-box indexing steps can rely on.
      .ai.pipestream.data.v1.SearchMetadata search_metadata = 2;
      Specified by:
      getSearchMetadata in interface PipeDocOrBuilder
      Returns:
      The searchMetadata.

    • getSearchMetadataOrBuilder

      public SearchMetadataOrBuilder getSearchMetadataOrBuilder()
       Standardized search engine metadata for OOTB indexing and querying.

 This is intentionally less flexible to maintain a common API layer that all
 out-of-the-box indexing steps can rely on.
      .ai.pipestream.data.v1.SearchMetadata search_metadata = 2;
      Specified by:
      getSearchMetadataOrBuilder in interface PipeDocOrBuilder

    • hasBlobBag

      public boolean hasBlobBag()
       Binary content container for document parsing.

 Useful for storing files that need parsing (images, PDFs, videos, etc.).
      .ai.pipestream.data.v1.BlobBag blob_bag = 3;
      Specified by:
      hasBlobBag in interface PipeDocOrBuilder
      Returns:
      Whether the blobBag field is set.

    • getBlobBag

      public BlobBag getBlobBag()
       Binary content container for document parsing.

 Useful for storing files that need parsing (images, PDFs, videos, etc.).
      .ai.pipestream.data.v1.BlobBag blob_bag = 3;
      Specified by:
      getBlobBag in interface PipeDocOrBuilder
      Returns:
      The blobBag.

    • getBlobBagOrBuilder

      public BlobBagOrBuilder getBlobBagOrBuilder()
       Binary content container for document parsing.

 Useful for storing files that need parsing (images, PDFs, videos, etc.).
      .ai.pipestream.data.v1.BlobBag blob_bag = 3;
      Specified by:
      getBlobBagOrBuilder in interface PipeDocOrBuilder

    • hasStructuredData

      public boolean hasStructuredData()
       Customer-provided structured data in any protobuf format.

 Types registered in the schema registry with JARs in the classpath will deserialize
 to their actual type. Unknown types fall back to dynamic messages. All data here
 will be indexed into the search engine unless configured otherwise.
      .google.protobuf.Any structured_data = 4;
      Specified by:
      hasStructuredData in interface PipeDocOrBuilder
      Returns:
      Whether the structuredData field is set.

    • getStructuredData

      public com.google.protobuf.Any getStructuredData()
       Customer-provided structured data in any protobuf format.

 Types registered in the schema registry with JARs in the classpath will deserialize
 to their actual type. Unknown types fall back to dynamic messages. All data here
 will be indexed into the search engine unless configured otherwise.
      .google.protobuf.Any structured_data = 4;
      Specified by:
      getStructuredData in interface PipeDocOrBuilder
      Returns:
      The structuredData.

    • getStructuredDataOrBuilder

      public com.google.protobuf.AnyOrBuilder getStructuredDataOrBuilder()
       Customer-provided structured data in any protobuf format.

 Types registered in the schema registry with JARs in the classpath will deserialize
 to their actual type. Unknown types fall back to dynamic messages. All data here
 will be indexed into the search engine unless configured otherwise.
      .google.protobuf.Any structured_data = 4;
      Specified by:
      getStructuredDataOrBuilder in interface PipeDocOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static PipeDoc.Builder newBuilder()

    • newBuilder

      public static PipeDoc.Builder newBuilder(PipeDoc prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static PipeDoc getDefaultInstance()

    • parser

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

    • getParserForType

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