Package ai.pipestream.data.v1

Enum Class DocIdDerivationMethod

java.lang.Object
java.lang.Enum<DocIdDerivationMethod>
ai.pipestream.data.v1.DocIdDerivationMethod
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<DocIdDerivationMethod>, Constable
@Generated public enum DocIdDerivationMethod extends Enum<DocIdDerivationMethod> implements com.google.protobuf.ProtocolMessageEnum
 Document ID derivation method and details.

 Records how the doc_id was determined for auditability, debugging,
 and understanding idempotency semantics.
Protobuf enum ai.pipestream.data.v1.DocIdDerivationMethod

  • Enum Constant Details

    • DOC_ID_DERIVATION_METHOD_UNSPECIFIED

      public static final DocIdDerivationMethod DOC_ID_DERIVATION_METHOD_UNSPECIFIED
      DOC_ID_DERIVATION_METHOD_UNSPECIFIED = 0;

    • DOC_ID_DERIVATION_METHOD_CLIENT_PROVIDED

      public static final DocIdDerivationMethod DOC_ID_DERIVATION_METHOD_CLIENT_PROVIDED
       doc_id was already set by the client in PipeDoc.
      DOC_ID_DERIVATION_METHOD_CLIENT_PROVIDED = 1;

    • DOC_ID_DERIVATION_METHOD_SOURCE_DOC_ID

      public static final DocIdDerivationMethod DOC_ID_DERIVATION_METHOD_SOURCE_DOC_ID
       doc_id derived from intake request source_doc_id.
      DOC_ID_DERIVATION_METHOD_SOURCE_DOC_ID = 2;

    • DOC_ID_DERIVATION_METHOD_SOURCE_URI

      public static final DocIdDerivationMethod DOC_ID_DERIVATION_METHOD_SOURCE_URI
       doc_id derived from PipeDoc.search_metadata.source_uri (canonicalized).
      DOC_ID_DERIVATION_METHOD_SOURCE_URI = 3;

    • DOC_ID_DERIVATION_METHOD_SOURCE_PATH

      public static final DocIdDerivationMethod DOC_ID_DERIVATION_METHOD_SOURCE_PATH
       doc_id derived from PipeDoc.search_metadata.source_path (normalized).
      DOC_ID_DERIVATION_METHOD_SOURCE_PATH = 4;

    • DOC_ID_DERIVATION_METHOD_SERVER_GENERATED

      public static final DocIdDerivationMethod DOC_ID_DERIVATION_METHOD_SERVER_GENERATED
       doc_id was generated by the server (explicit opt-in only).
      DOC_ID_DERIVATION_METHOD_SERVER_GENERATED = 5;

    • UNRECOGNIZED

      public static final DocIdDerivationMethod UNRECOGNIZED

  • Field Details

    • DOC_ID_DERIVATION_METHOD_UNSPECIFIED_VALUE

      public static final int DOC_ID_DERIVATION_METHOD_UNSPECIFIED_VALUE
      DOC_ID_DERIVATION_METHOD_UNSPECIFIED = 0;
      See Also:

    • DOC_ID_DERIVATION_METHOD_CLIENT_PROVIDED_VALUE

      public static final int DOC_ID_DERIVATION_METHOD_CLIENT_PROVIDED_VALUE
       doc_id was already set by the client in PipeDoc.
      DOC_ID_DERIVATION_METHOD_CLIENT_PROVIDED = 1;
      See Also:

    • DOC_ID_DERIVATION_METHOD_SOURCE_DOC_ID_VALUE

      public static final int DOC_ID_DERIVATION_METHOD_SOURCE_DOC_ID_VALUE
       doc_id derived from intake request source_doc_id.
      DOC_ID_DERIVATION_METHOD_SOURCE_DOC_ID = 2;
      See Also:

    • DOC_ID_DERIVATION_METHOD_SOURCE_URI_VALUE

      public static final int DOC_ID_DERIVATION_METHOD_SOURCE_URI_VALUE
       doc_id derived from PipeDoc.search_metadata.source_uri (canonicalized).
      DOC_ID_DERIVATION_METHOD_SOURCE_URI = 3;
      See Also:

    • DOC_ID_DERIVATION_METHOD_SOURCE_PATH_VALUE

      public static final int DOC_ID_DERIVATION_METHOD_SOURCE_PATH_VALUE
       doc_id derived from PipeDoc.search_metadata.source_path (normalized).
      DOC_ID_DERIVATION_METHOD_SOURCE_PATH = 4;
      See Also:

    • DOC_ID_DERIVATION_METHOD_SERVER_GENERATED_VALUE

      public static final int DOC_ID_DERIVATION_METHOD_SERVER_GENERATED_VALUE
       doc_id was generated by the server (explicit opt-in only).
      DOC_ID_DERIVATION_METHOD_SERVER_GENERATED = 5;
      See Also:

  • Method Details

    • values

      public static DocIdDerivationMethod[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static DocIdDerivationMethod valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum

    • valueOf

      @Deprecated public static DocIdDerivationMethod valueOf(int value)
      Deprecated.
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      value - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • forNumber

      public static DocIdDerivationMethod forNumber(int value)
      Parameters:
      value - The numeric wire value of the corresponding enum entry.
      Returns:
      The enum associated with the given numeric wire value.

    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<DocIdDerivationMethod> internalGetValueMap()

    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptor

      public static com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

    • valueOf

      public static DocIdDerivationMethod valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      desc - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null