Package ai.pipestream.data.v1

Class DocumentReference

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
ai.pipestream.data.v1.DocumentReference
All Implemented Interfaces:
DocumentReferenceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class DocumentReference extends com.google.protobuf.GeneratedMessage implements DocumentReferenceOrBuilder
 Reference to a document stored in the repository (S3 offload).

 Used when the full PipeDoc is stored in S3/repository and only a reference
 is needed in the stream for efficient message passing.
 Engine uses this to hydrate the document via repo-service.
Protobuf type ai.pipestream.data.v1.DocumentReference
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    DocumentReference.Builder
    Reference to a document stored in the repository (S3 offload).

    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
    ACCOUNT_ID_FIELD_NUMBER
     
    static final int
    DOC_ID_FIELD_NUMBER
     
    static final int
    SOURCE_NODE_ID_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)
     
    String
    getAccountId()
    Account context for multi-tenant lookup.
    com.google.protobuf.ByteString
    getAccountIdBytes()
    Account context for multi-tenant lookup.
    static DocumentReference
    getDefaultInstance()
     
    DocumentReference
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getDocId()
    Document identifier.
    com.google.protobuf.ByteString
    getDocIdBytes()
    Document identifier.
    com.google.protobuf.Parser<DocumentReference>
    getParserForType()
     
    int
    getSerializedSize()
     
    String
    getSourceNodeId()
    Node that produced this version (determines storage location).
    com.google.protobuf.ByteString
    getSourceNodeIdBytes()
    Node that produced this version (determines storage location).
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static DocumentReference.Builder
    newBuilder()
     
    static DocumentReference.Builder
    newBuilder(DocumentReference prototype)
     
    DocumentReference.Builder
    newBuilderForType()
     
    protected DocumentReference.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static DocumentReference
    parseDelimitedFrom(InputStream input)
     
    static DocumentReference
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DocumentReference
    parseFrom(byte[] data)
     
    static DocumentReference
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DocumentReference
    parseFrom(com.google.protobuf.ByteString data)
     
    static DocumentReference
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DocumentReference
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static DocumentReference
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DocumentReference
    parseFrom(InputStream input)
     
    static DocumentReference
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DocumentReference
    parseFrom(ByteBuffer data)
     
    static DocumentReference
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<DocumentReference>
    parser()
     
    DocumentReference.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:

    • SOURCE_NODE_ID_FIELD_NUMBER

      public static final int SOURCE_NODE_ID_FIELD_NUMBER
      See Also:

    • ACCOUNT_ID_FIELD_NUMBER

      public static final int ACCOUNT_ID_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()
       Document identifier.

 The logical document identifier that persists across all versions/hops.
 Deterministic: hash(datasource_id + source_doc_id)
      string doc_id = 1 [json_name = "docId"];
      Specified by:
      getDocId in interface DocumentReferenceOrBuilder
      Returns:
      The docId.

    • getDocIdBytes

      public com.google.protobuf.ByteString getDocIdBytes()
       Document identifier.

 The logical document identifier that persists across all versions/hops.
 Deterministic: hash(datasource_id + source_doc_id)
      string doc_id = 1 [json_name = "docId"];
      Specified by:
      getDocIdBytes in interface DocumentReferenceOrBuilder
      Returns:
      The bytes for docId.

    • getSourceNodeId

      public String getSourceNodeId()
       Node that produced this version (determines storage location).

 Identifies exactly which node produced the version of the document being referenced.
 This is critical for fetching the correct state from the Repository.
      string source_node_id = 2 [json_name = "sourceNodeId"];
      Specified by:
      getSourceNodeId in interface DocumentReferenceOrBuilder
      Returns:
      The sourceNodeId.

    • getSourceNodeIdBytes

      public com.google.protobuf.ByteString getSourceNodeIdBytes()
       Node that produced this version (determines storage location).

 Identifies exactly which node produced the version of the document being referenced.
 This is critical for fetching the correct state from the Repository.
      string source_node_id = 2 [json_name = "sourceNodeId"];
      Specified by:
      getSourceNodeIdBytes in interface DocumentReferenceOrBuilder
      Returns:
      The bytes for sourceNodeId.

    • getAccountId

      public String getAccountId()
       Account context for multi-tenant lookup.

 Ensures that hydration requests are scoped to the correct tenant,
 preventing cross-account data access.
      string account_id = 3 [json_name = "accountId"];
      Specified by:
      getAccountId in interface DocumentReferenceOrBuilder
      Returns:
      The accountId.

    • getAccountIdBytes

      public com.google.protobuf.ByteString getAccountIdBytes()
       Account context for multi-tenant lookup.

 Ensures that hydration requests are scoped to the correct tenant,
 preventing cross-account data access.
      string account_id = 3 [json_name = "accountId"];
      Specified by:
      getAccountIdBytes in interface DocumentReferenceOrBuilder
      Returns:
      The bytes for accountId.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static DocumentReference.Builder newBuilder()

    • newBuilder

      public static DocumentReference.Builder newBuilder(DocumentReference prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static DocumentReference getDefaultInstance()

    • parser

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

    • getParserForType

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