Etcd · Schema

WatchResponse

A streaming response from the watch endpoint

Cloud NativeConsensusDistributed SystemsGraduatedKey-Value StoreKubernetes

Properties

Name Type Description
header object
watch_id string ID of the watch that generated this response
created boolean True if this response confirms the creation of a new watch
canceled boolean True if this response confirms the cancellation of a watch
compact_revision string Set when a watch is canceled because the requested start revision has been compacted
cancel_reason string Reason the watch was canceled
fragment boolean True if this is a fragment of a larger watch response
events array List of events in this watch response
View JSON Schema on GitHub

JSON Schema

etcd-watchresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/WatchResponse",
  "title": "WatchResponse",
  "type": "object",
  "description": "A streaming response from the watch endpoint",
  "properties": {
    "header": {
      "$ref": "#/components/schemas/ResponseHeader"
    },
    "watch_id": {
      "type": "string",
      "description": "ID of the watch that generated this response"
    },
    "created": {
      "type": "boolean",
      "description": "True if this response confirms the creation of a new watch"
    },
    "canceled": {
      "type": "boolean",
      "description": "True if this response confirms the cancellation of a watch"
    },
    "compact_revision": {
      "type": "string",
      "description": "Set when a watch is canceled because the requested start revision has been compacted"
    },
    "cancel_reason": {
      "type": "string",
      "description": "Reason the watch was canceled"
    },
    "fragment": {
      "type": "boolean",
      "description": "True if this is a fragment of a larger watch response"
    },
    "events": {
      "type": "array",
      "description": "List of events in this watch response",
      "items": {
        "$ref": "#/components/schemas/WatchEvent"
      }
    }
  }
}