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 ClassesModifier and TypeClassDescriptionstatic final classCore 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.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanImmutable parsed metadata from document parsers (Tika, Docling, etc.).booleanBinary content container for document parsing.Binary content container for document parsing.static PipeDocstatic final com.google.protobuf.Descriptors.DescriptorgetDocId()Unique identifier for this document across the entire system.com.google.protobuf.ByteStringUnique identifier for this document across the entire system.Ownership tracking for security, auditing, and access control.Ownership tracking for security, auditing, and access control.Deprecated.intImmutable parsed metadata from document parsers (Tika, Docling, etc.).Immutable parsed metadata from document parsers (Tika, Docling, etc.).getParsedMetadataOrDefault(String key, ParsedMetadata defaultValue) Immutable parsed metadata from document parsers (Tika, Docling, etc.).Immutable parsed metadata from document parsers (Tika, Docling, etc.).com.google.protobuf.Parser<PipeDoc> Standardized search engine metadata for OOTB indexing and querying.Standardized search engine metadata for OOTB indexing and querying.intcom.google.protobuf.AnyCustomer-provided structured data in any protobuf format.com.google.protobuf.AnyOrBuilderCustomer-provided structured data in any protobuf format.booleanBinary content container for document parsing.inthashCode()booleanOwnership tracking for security, auditing, and access control.booleanStandardized search engine metadata for OOTB indexing and querying.booleanCustomer-provided structured data in any protobuf format.protected com.google.protobuf.GeneratedMessage.FieldAccessorTableprotected com.google.protobuf.MapFieldReflectionAccessorinternalGetMapFieldReflection(int number) final booleanstatic PipeDoc.Builderstatic PipeDoc.BuildernewBuilder(PipeDoc prototype) protected PipeDoc.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static PipeDocparseDelimitedFrom(InputStream input) static PipeDocparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PipeDocparseFrom(byte[] data) static PipeDocparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PipeDocparseFrom(com.google.protobuf.ByteString data) static PipeDocparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PipeDocparseFrom(com.google.protobuf.CodedInputStream input) static PipeDocparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PipeDocparseFrom(InputStream input) static PipeDocparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PipeDocparseFrom(ByteBuffer data) static PipeDocparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<PipeDoc> parser()voidwriteTo(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, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods 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:
-
PARSED_METADATA_FIELD_NUMBER
public static final int PARSED_METADATA_FIELD_NUMBER- See Also:
-
OWNERSHIP_FIELD_NUMBER
public static final int OWNERSHIP_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:
internalGetMapFieldReflectionin classcom.google.protobuf.GeneratedMessage
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
getDocId
Unique identifier for this document across the entire system. Deterministic: hash(datasource_id + source_doc_id)
string doc_id = 1 [json_name = "docId"];- Specified by:
getDocIdin interfacePipeDocOrBuilder- Returns:
- The docId.
-
getDocIdBytes
public com.google.protobuf.ByteString getDocIdBytes()Unique identifier for this document across the entire system. Deterministic: hash(datasource_id + source_doc_id)
string doc_id = 1 [json_name = "docId"];- Specified by:
getDocIdBytesin interfacePipeDocOrBuilder- 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 [json_name = "searchMetadata"];- Specified by:
hasSearchMetadatain interfacePipeDocOrBuilder- Returns:
- Whether the searchMetadata field is set.
-
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 [json_name = "searchMetadata"];- Specified by:
getSearchMetadatain interfacePipeDocOrBuilder- Returns:
- The searchMetadata.
-
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 [json_name = "searchMetadata"];- Specified by:
getSearchMetadataOrBuilderin interfacePipeDocOrBuilder
-
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 [json_name = "blobBag"];- Specified by:
hasBlobBagin interfacePipeDocOrBuilder- Returns:
- Whether the blobBag field is set.
-
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 [json_name = "blobBag"];- Specified by:
getBlobBagin interfacePipeDocOrBuilder- Returns:
- The blobBag.
-
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 [json_name = "blobBag"];- Specified by:
getBlobBagOrBuilderin interfacePipeDocOrBuilder
-
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 [json_name = "structuredData"];- Specified by:
hasStructuredDatain interfacePipeDocOrBuilder- 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 [json_name = "structuredData"];- Specified by:
getStructuredDatain interfacePipeDocOrBuilder- 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 [json_name = "structuredData"];- Specified by:
getStructuredDataOrBuilderin interfacePipeDocOrBuilder
-
getParsedMetadataCount
public int getParsedMetadataCount()Description copied from interface:PipeDocOrBuilderImmutable 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 [json_name = "parsedMetadata"];- Specified by:
getParsedMetadataCountin interfacePipeDocOrBuilder
-
containsParsedMetadata
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 [json_name = "parsedMetadata"];- Specified by:
containsParsedMetadatain interfacePipeDocOrBuilder
-
getParsedMetadata
Deprecated.UsegetParsedMetadataMap()instead.- Specified by:
getParsedMetadatain interfacePipeDocOrBuilder
-
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 [json_name = "parsedMetadata"];- Specified by:
getParsedMetadataMapin interfacePipeDocOrBuilder
-
getParsedMetadataOrDefault
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 [json_name = "parsedMetadata"];- Specified by:
getParsedMetadataOrDefaultin interfacePipeDocOrBuilder
-
getParsedMetadataOrThrow
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 [json_name = "parsedMetadata"];- Specified by:
getParsedMetadataOrThrowin interfacePipeDocOrBuilder
-
hasOwnership
public boolean hasOwnership()Ownership tracking for security, auditing, and access control. Captures which account and datasource produced this document.
optional .ai.pipestream.data.v1.OwnershipContext ownership = 6 [json_name = "ownership"];- Specified by:
hasOwnershipin interfacePipeDocOrBuilder- Returns:
- Whether the ownership field is set.
-
getOwnership
Ownership tracking for security, auditing, and access control. Captures which account and datasource produced this document.
optional .ai.pipestream.data.v1.OwnershipContext ownership = 6 [json_name = "ownership"];- Specified by:
getOwnershipin interfacePipeDocOrBuilder- Returns:
- The ownership.
-
getOwnershipOrBuilder
Ownership tracking for security, auditing, and access control. Captures which account and datasource produced this document.
optional .ai.pipestream.data.v1.OwnershipContext ownership = 6 [json_name = "ownership"];- Specified by:
getOwnershipOrBuilderin interfacePipeDocOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.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
- Throws:
IOException
-
parseFrom
public static PipeDoc parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static PipeDoc parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static PipeDoc parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected PipeDoc.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-