cloud.pyroclastic.status.component Documentation (EN)

main record

The stable key of the component

Record Key any Any valid record key

Properties

createdAt string datetime Required

When the component is first listed.

host string Optional

An optional hostname for the component.

maxLength: 253 bytes

name string Required

The display name of the component.

maxLength: 640 bytesmaxGraphemes: 64 graphemes

state string Required

The current state of the component.

maxLength: 64 bytes

Known values: ok, maintenance, incident, recovering

updatedAt string datetime Required

The time the component record was updated.

View raw schema

{
  "key": "any",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "name",
      "state",
      "createdAt",
      "updatedAt"
    ],
    "properties": {
      "host": {
        "type": "string",
        "maxLength": 253,
        "description": "An optional hostname for the component."
      },
      "name": {
        "type": "string",
        "maxLength": 640,
        "description": "The display name of the component.",
        "maxGraphemes": 64
      },
      "state": {
        "type": "string",
        "maxLength": 64,
        "description": "The current state of the component.",
        "knownValues": [
          "ok",
          "maintenance",
          "incident",
          "recovering"
        ]
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "When the component is first listed."
      },
      "updatedAt": {
        "type": "string",
        "format": "datetime",
        "description": "The time the component record was updated."
      }
    }
  },
  "description": "The stable key of the component"
}