SearchHit

Resume point strictly past this hit, in the query's order.

The document the hit is in.

The key of the hit's document in a store with CreationOptions.documentKey, null in a store without one. Known already for a DocumentKeyQuery hit, and looked up in the key index when first read for others.

Payload bytes that store the node, including the fragments it refers to, before compression. It predicts the size of the JSON output roughly, not exactly.

What the hit stands for: the containing object, or the document's root (SPEC.md §4.3).

Where node is in its document, as an RFC 9535 Normalized Path from the document root (SPEC.md §3.2): $['orders'][3], and $ for the root. Computed when first read: a JSONPath hit's is known already, a key–value hit's is found by reading the fragments from the root down to the node.

The type of node as the result's snapshot sees it, or null.

The node as a JSON string; throws ResultTooLargeException if it has more than maxChars characters.

The node as a JSON string laid out in format; throws ResultTooLargeException if the text has more than maxChars characters, its whitespace included.

Writes the node as JSON (SPEC.md §5) with memory independent of its size. Doesn't close out.

Writes the node as JSON laid out in format (SPEC.md §5.1) with memory independent of its size. Doesn't close out.