Kong · Schema

ConsumeFailureMode

Describes how to handle a failure in a policy applied to consumed records. * `error` - the batch is not delivered to the client. Use sparingly: erroring on a batch causes clients to get stuck on the problematic offset and requires manual intervention to skip it. * `skip` - the record is not delivered to the client. * `passthrough` - passes the record to the client even though policy execution failed. * `mark` - passes the record to the client but marks it with a `kong/policy-failure-` header whose value is the reason for the policy failure (truncated to 512 characters).

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ConsumeFailureMode",
  "title": "ConsumeFailureMode",
  "description": "Describes how to handle a failure in a policy applied to consumed records.\n* `error` - the batch is not delivered to the client. Use sparingly: erroring on a batch causes clients to get stuck on the problematic offset and requires manual intervention to skip it.\n* `skip` - the record is not delivered to the client.\n* `passthrough` - passes the record to the client even though policy execution failed.\n* `mark` - passes the record to the client but marks it with a `kong/policy-failure-<id>` header whose value is the reason for the policy failure (truncated to 512 characters).\n",
  "type": "string",
  "enum": [
    "error",
    "skip",
    "passthrough",
    "mark"
  ],
  "x-speakeasy-unknown-values": "allow"
}