js-bao-wss-client

---

js-bao-wss-client / DocumentSnapshotBuild

Interface: DocumentSnapshotBuild

One snapshot build of a large document, as the server describes it.

Properties

baseBuildId?

optional baseBuildId?: string | null

The build this one carried chunks forward from, when it is incremental.

---

buildId

buildId: string

---

bytes

bytes: number

---

chunks

chunks: number

---

chunksReused?

optional chunksReused?: number

---

completedAt?

optional completedAt?: number | null

---

epoch

epoch: number

---

failure?

optional failure?: unknown

---

ingestSessionId?

optional ingestSessionId?: string | null

The bulk-load session this base was built for, or null.

---

manifestVersion?

optional manifestVersion?: number

---

rows

rows: number

---

rowsWalked?

optional rowsWalked?: number

---

source?

optional source?: "builder" | "import" | "ingest"

What produced it: the ordinary builder, an import, or a bulk load.

---

startedAt?

optional startedAt?: number | null

---

state

state: "failed" | "complete" | "building" | "verifying" | "abandoned"

---

timings?

optional timings?: unknown

---

verification?

optional verification?: unknown