# Cheatsheets

## Node

Information about a Kafka cluster node

Name | Type | Description
`@empty` | `Boolean` |
`@hasRack` | `Boolean` | Set if this node has a defined rack
`@host` | `String` | Set the host name for this node
`@id` | `Number (int)` | Set the node id of this node
`@idString` | `String` | Set the string representation of the node id
`@isEmpty` | `Boolean` | Set if this node is empty
`@port` | `Number (int)` | Set the port for this node
`@rack` | `String` | Set the rack for this node

## OffsetAndMetadata

Provide additional metadata when an offset is committed

Name | Type | Description
`@metadata` | `String` | Set additional metadata for the offset committed
`@offset` | `Number (long)` | Set the offset to commit

## OffsetAndTimestamp

Represent information related to a Offset with timestamp information

Name | Type | Description
`@offset` | `Number (long)` | Set the offset
`@timestamp` | `Number (long)` | Set the timestamp

## PartitionInfo

Information about a specific Kafka topic partition

Name | Type | Description
`@inSyncReplicas` | `Array of Node` | Set the subset of the replicas that are in sync
`@leader` | `Node` | Set the node id of the node currently acting as a leader
`@partition` | `Number (int)` | Set the partition id
`@replicas` | `Array of Node` | Set the complete set of replicas for this partition
`@topic` | `String` | Set the topic name

## RecordMetadata

Metadata related to a Kafka record

Name | Type | Description
`@checksum` | `Number (long)` | Set the checksum (CRC32) of the record.
`@offset` | `Number (long)` | Set the offset of the record in the topic/partition.
`@partition` | `Number (int)` | Set the partition the record was sent to
`@timestamp` | `Number (long)` | Set the timestamp of the record in the topic/partition
`@topic` | `String` | Set the topic the record was appended to

## TopicPartition

Represent information related to a partition for a topic

Name | Type | Description
`@partition` | `Number (int)` | Set the partition number
`@topic` | `String` | Set the topic name