LogPhysicalSubscribeParams

Experimental

log/physicalSubscribe params.

Fields and variants

• after — Experimental
• chunkBytes — Experimental
• sessionId — Experimental

Source

schema/msp/experimental/msp.schema.json#/types/LogPhysicalSubscribeParams

{
  "description": "`log/physicalSubscribe` params.",
  "properties": {
    "after": {
      "$ref": "#/$defs/PhysicalCursor",
      "description": "Where delivery starts; required (`{0, 1}` is the file's start)."
    },
    "chunkBytes": {
      "description": "An upper bound on one chunk's raw UTF-8 bytes (default 1 MiB); at\nleast 4, the widest character.",
      "minimum": 4,
      "type": "integer"
    },
    "sessionId": {
      "description": "The session whose file is followed: a root or a child session.",
      "type": "string"
    }
  },
  "required": [
    "after",
    "sessionId"
  ],
  "type": "object",
  "x-msp-descriptor": "log/physicalSubscribe",
  "x-msp-stability": "experimental"
}