Package ai.pipestream.data.v1

Class PipeDoc.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<PipeDoc.Builder>
com.google.protobuf.GeneratedMessage.Builder<PipeDoc.Builder>
ai.pipestream.data.v1.PipeDoc.Builder
All Implemented Interfaces:
PipeDocOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
PipeDoc
public static final class PipeDoc.Builder extends com.google.protobuf.GeneratedMessage.Builder<PipeDoc.Builder> 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

  • 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<PipeDoc.Builder>

    • internalGetMutableMapFieldReflection

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

    • internalGetFieldAccessorTable

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

    • clear

      public PipeDoc.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<PipeDoc.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<PipeDoc.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public PipeDoc.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<PipeDoc.Builder>

    • mergeFrom

      public PipeDoc.Builder mergeFrom(PipeDoc other)

    • isInitialized

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

    • mergeFrom

      public PipeDoc.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<PipeDoc.Builder>
      Throws:
      IOException

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

    • setDocId

      public PipeDoc.Builder setDocId(String value)
       Unique identifier for this document across the entire system.
      string doc_id = 1;
      Parameters:
      value - The docId to set.
      Returns:
      This builder for chaining.

    • clearDocId

      public PipeDoc.Builder clearDocId()
       Unique identifier for this document across the entire system.
      string doc_id = 1;
      Returns:
      This builder for chaining.

    • setDocIdBytes

      public PipeDoc.Builder setDocIdBytes(com.google.protobuf.ByteString value)
       Unique identifier for this document across the entire system.
      string doc_id = 1;
      Parameters:
      value - The bytes for docId to set.
      Returns:
      This builder for chaining.

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

    • setSearchMetadata

      public PipeDoc.Builder setSearchMetadata(SearchMetadata value)
       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;

    • setSearchMetadata

      public PipeDoc.Builder setSearchMetadata(SearchMetadata.Builder builderForValue)
       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;

    • mergeSearchMetadata

      public PipeDoc.Builder mergeSearchMetadata(SearchMetadata value)
       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;

    • clearSearchMetadata

      public PipeDoc.Builder clearSearchMetadata()
       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;

    • getSearchMetadataBuilder

      public SearchMetadata.Builder getSearchMetadataBuilder()
       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;

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

    • setBlobBag

      public PipeDoc.Builder setBlobBag(BlobBag value)
       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;

    • setBlobBag

      public PipeDoc.Builder setBlobBag(BlobBag.Builder builderForValue)
       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;

    • mergeBlobBag

      public PipeDoc.Builder mergeBlobBag(BlobBag value)
       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;

    • clearBlobBag

      public PipeDoc.Builder clearBlobBag()
       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;

    • getBlobBagBuilder

      public BlobBag.Builder getBlobBagBuilder()
       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;

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

    • setStructuredData

      public PipeDoc.Builder setStructuredData(com.google.protobuf.Any value)
       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;

    • setStructuredData

      public PipeDoc.Builder setStructuredData(com.google.protobuf.Any.Builder builderForValue)
       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;

    • mergeStructuredData

      public PipeDoc.Builder mergeStructuredData(com.google.protobuf.Any value)
       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;

    • clearStructuredData

      public PipeDoc.Builder clearStructuredData()
       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;

    • getStructuredDataBuilder

      public com.google.protobuf.Any.Builder getStructuredDataBuilder()
       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;

    • 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

    • getParsedMetadataCount

      public int getParsedMetadataCount()
      Description copied from interface: PipeDocOrBuilder
       Immutable parsed metadata from document parsers (Tika, Docling, etc.).

 This field is append-only - parsers can add new entries but should never modify
 or delete existing ones. Keys are parser-specific identifiers (e.g., "tika", "docling").
 The actual parsed data is stored in ParsedMetadata.data as an Any type containing
 parser-specific protobuf messages (e.g., TikaResponse, DoclingResponse).
      map<string, .ai.pipestream.data.v1.ParsedMetadata> parsed_metadata = 5;
      Specified by:
      getParsedMetadataCount in interface PipeDocOrBuilder

    • containsParsedMetadata

      public boolean containsParsedMetadata(String key)
       Immutable parsed metadata from document parsers (Tika, Docling, etc.).

 This field is append-only - parsers can add new entries but should never modify
 or delete existing ones. Keys are parser-specific identifiers (e.g., "tika", "docling").
 The actual parsed data is stored in ParsedMetadata.data as an Any type containing
 parser-specific protobuf messages (e.g., TikaResponse, DoclingResponse).
      map<string, .ai.pipestream.data.v1.ParsedMetadata> parsed_metadata = 5;
      Specified by:
      containsParsedMetadata in interface PipeDocOrBuilder

    • getParsedMetadata

      @Deprecated public Map<String,ParsedMetadata> getParsedMetadata()
      Deprecated.
      Use getParsedMetadataMap() instead.
      Specified by:
      getParsedMetadata in interface PipeDocOrBuilder

    • getParsedMetadataMap

      public Map<String,ParsedMetadata> getParsedMetadataMap()
       Immutable parsed metadata from document parsers (Tika, Docling, etc.).

 This field is append-only - parsers can add new entries but should never modify
 or delete existing ones. Keys are parser-specific identifiers (e.g., "tika", "docling").
 The actual parsed data is stored in ParsedMetadata.data as an Any type containing
 parser-specific protobuf messages (e.g., TikaResponse, DoclingResponse).
      map<string, .ai.pipestream.data.v1.ParsedMetadata> parsed_metadata = 5;
      Specified by:
      getParsedMetadataMap in interface PipeDocOrBuilder

    • getParsedMetadataOrDefault

      public ParsedMetadata getParsedMetadataOrDefault(String key, ParsedMetadata defaultValue)
       Immutable parsed metadata from document parsers (Tika, Docling, etc.).

 This field is append-only - parsers can add new entries but should never modify
 or delete existing ones. Keys are parser-specific identifiers (e.g., "tika", "docling").
 The actual parsed data is stored in ParsedMetadata.data as an Any type containing
 parser-specific protobuf messages (e.g., TikaResponse, DoclingResponse).
      map<string, .ai.pipestream.data.v1.ParsedMetadata> parsed_metadata = 5;
      Specified by:
      getParsedMetadataOrDefault in interface PipeDocOrBuilder

    • getParsedMetadataOrThrow

      public ParsedMetadata getParsedMetadataOrThrow(String key)
       Immutable parsed metadata from document parsers (Tika, Docling, etc.).

 This field is append-only - parsers can add new entries but should never modify
 or delete existing ones. Keys are parser-specific identifiers (e.g., "tika", "docling").
 The actual parsed data is stored in ParsedMetadata.data as an Any type containing
 parser-specific protobuf messages (e.g., TikaResponse, DoclingResponse).
      map<string, .ai.pipestream.data.v1.ParsedMetadata> parsed_metadata = 5;
      Specified by:
      getParsedMetadataOrThrow in interface PipeDocOrBuilder

    • clearParsedMetadata

      public PipeDoc.Builder clearParsedMetadata()

    • removeParsedMetadata

      public PipeDoc.Builder removeParsedMetadata(String key)
       Immutable parsed metadata from document parsers (Tika, Docling, etc.).

 This field is append-only - parsers can add new entries but should never modify
 or delete existing ones. Keys are parser-specific identifiers (e.g., "tika", "docling").
 The actual parsed data is stored in ParsedMetadata.data as an Any type containing
 parser-specific protobuf messages (e.g., TikaResponse, DoclingResponse).
      map<string, .ai.pipestream.data.v1.ParsedMetadata> parsed_metadata = 5;

    • getMutableParsedMetadata

      @Deprecated public Map<String,ParsedMetadata> getMutableParsedMetadata()
      Deprecated.
      Use alternate mutation accessors instead.

    • putParsedMetadata

      public PipeDoc.Builder putParsedMetadata(String key, ParsedMetadata value)
       Immutable parsed metadata from document parsers (Tika, Docling, etc.).

 This field is append-only - parsers can add new entries but should never modify
 or delete existing ones. Keys are parser-specific identifiers (e.g., "tika", "docling").
 The actual parsed data is stored in ParsedMetadata.data as an Any type containing
 parser-specific protobuf messages (e.g., TikaResponse, DoclingResponse).
      map<string, .ai.pipestream.data.v1.ParsedMetadata> parsed_metadata = 5;

    • putAllParsedMetadata

      public PipeDoc.Builder putAllParsedMetadata(Map<String,ParsedMetadata> values)
       Immutable parsed metadata from document parsers (Tika, Docling, etc.).

 This field is append-only - parsers can add new entries but should never modify
 or delete existing ones. Keys are parser-specific identifiers (e.g., "tika", "docling").
 The actual parsed data is stored in ParsedMetadata.data as an Any type containing
 parser-specific protobuf messages (e.g., TikaResponse, DoclingResponse).
      map<string, .ai.pipestream.data.v1.ParsedMetadata> parsed_metadata = 5;

    • putParsedMetadataBuilderIfAbsent

      public ParsedMetadata.Builder putParsedMetadataBuilderIfAbsent(String key)
       Immutable parsed metadata from document parsers (Tika, Docling, etc.).

 This field is append-only - parsers can add new entries but should never modify
 or delete existing ones. Keys are parser-specific identifiers (e.g., "tika", "docling").
 The actual parsed data is stored in ParsedMetadata.data as an Any type containing
 parser-specific protobuf messages (e.g., TikaResponse, DoclingResponse).
      map<string, .ai.pipestream.data.v1.ParsedMetadata> parsed_metadata = 5;