org.apache.kafka.clients.admin

Class BrokerAdditionDescription

java.lang.Object

org.apache.kafka.clients.admin.BrokerAdditionDescription

public class BrokerAdditionDescription
extends Object

A description of a broker addition operation, which has been listed via ConfluentAdmin.describeBrokerAdditions(DescribeBrokerAdditionsOptions). The status of the addition is tracked by one status field: #partitionReassignmentsStatus(), a #PartitionReassignmentsStatus denoting the status of the addition operation. Additionally, the #additionError() helps give context to the status - it can shed light on why the operation failed, why it's stuck in pending for a long time and etc.

Constructor Summary

Constructors

Constructor and Description
BrokerAdditionDescription(int brokerId, BalancerOperationStatus balancerOperationGeneralStatus, PartitionReassignmentsStatus partitionReassignmentsStatus, Optional<BalancerOperationError> additionError, long createTimeMs, long lastUpdateTimestamp)

Method Summary

Modifier and Type	Method and Description
Optional<BalancerOperationError>	additionError() An optional error that gives context as to why the operation is in the given status.
int	brokerId()
long	createTimeMs() The timestamp at which this broker addition operation was created
BalancerOperationStatus	generalOperationStatus() The current high-level status of the broker addition operation
long	lastUpdateTimeMs() The timestamp at which this broker addition operation was last updated
PartitionReassignmentsStatus	partitionReassignmentsStatus() The detailed, current status of the broker addition operation's status.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BrokerAdditionDescription

public BrokerAdditionDescription(int brokerId,
                                 BalancerOperationStatus balancerOperationGeneralStatus,
                                 PartitionReassignmentsStatus partitionReassignmentsStatus,
                                 Optional<BalancerOperationError> additionError,
                                 long createTimeMs,
                                 long lastUpdateTimestamp)

Method Detail

generalOperationStatus

public BalancerOperationStatus generalOperationStatus()

The current high-level status of the broker addition operation

partitionReassignmentsStatus

public PartitionReassignmentsStatus partitionReassignmentsStatus()

The detailed, current status of the broker addition operation's status. They can be in one of the following states: 1. PartitionReassignmentsStatus.ERROR - when the broker addition operation failed 2. PartitionReassignmentsStatus.PENDING - when the intent of addition is registered but the balancer is yet to start on it (e.g still collecting metrics for computing a reassignment plan) 3. PartitionReassignmentsStatus.CANCELED - when the broker addition operation was canceled (e.g a higher-priority operation overriding it) 4. PartitionReassignmentsStatus.IN_PROGRESS - when the addition is in progress (replicas are being reassigned) 5. PartitionReassignmentsStatus.COMPLETED - when the broker has successfully been added to the cluster

brokerId

public int brokerId()

createTimeMs

public long createTimeMs()

The timestamp at which this broker addition operation was created

lastUpdateTimeMs

public long lastUpdateTimeMs()

The timestamp at which this broker addition operation was last updated

additionError

public Optional<BalancerOperationError> additionError()

An optional error that gives context as to why the operation is in the given status.

toString

public String toString()

Overrides:

toString in class Object