View Source KafkaEx.Cluster.PartitionInfo (kafka_ex v1.0.0-rc.1)

Information about a topic partition.

Contains metadata about a specific partition including its leader broker, replica assignments, and in-sync replica (ISR) list.

Java equivalent: org.apache.kafka.common.PartitionInfo

Summary

t()

build(opts)

Builds a PartitionInfo struct from keyword options.

Builds a PartitionInfo struct from partition metadata response.

Returns the list of in-sync replica node IDs.

Returns the leader node ID.

Returns the partition number.

Returns the list of replica node IDs.

@type t() :: %KafkaEx.Cluster.PartitionInfo{
  isr: [integer()],
  leader: integer(),
  partition_id: integer(),
  replicas: [integer()]
}

@spec build(Keyword.t()) :: t()

Builds a PartitionInfo struct from keyword options.

@spec from_partition_metadata(map()) :: t()

Builds a PartitionInfo struct from partition metadata response.

The metadata map should contain:

@spec in_sync_replicas(t()) :: [integer()]

Returns the list of in-sync replica node IDs.

Provided for API compatibility with Java's PartitionInfo.inSyncReplicas().

@spec leader(t()) :: integer()

Returns the leader node ID.

Provided for API compatibility with Java's PartitionInfo.leader(). Returns -1 if no leader is available.

@spec partition(t()) :: integer()

Returns the partition number.

Provided for API compatibility with Java's PartitionInfo.partition().

@spec replicas(t()) :: [integer()]

Returns the list of replica node IDs.

Provided for API compatibility with Java's PartitionInfo.replicas().