org.apache.kafka.clients.admin

Class BrokerRemovalDescription

java.lang.Object

org.apache.kafka.clients.admin.BrokerRemovalDescription

public class BrokerRemovalDescription
extends java.lang.Object

A description of a broker removal, which has been listed via ConfluentAdmin.describeBrokerRemovals(DescribeBrokerRemovalsOptions). The status of the removal is tracked by two separate status fields: 1. #brokerShutdownStatus(), a #BrokerRemovalDescription.BrokerShutdownStatus denoting the status of the shutdown operation 2. #partitionReassignmentsStatus(), a #BrokerRemovalDescription.PartitionReassignmentsStatus denoting the status of the partition reassignments operation When at least one of the two has a failed status, the broker removal operation is considered failed. The user is expected to retry the removal via #ConfluentAdmin.removeBrokers(List). When both have a completed status, the broker removal operation is considered a success.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BrokerRemovalDescription.BrokerShutdownStatus The status of the broker shutdown.
static class	BrokerRemovalDescription.PartitionReassignmentsStatus The status of the partition reassignments, draining replicas out of the to be removed broker.

Constructor Summary

Constructors

Constructor and Description
BrokerRemovalDescription(java.lang.Integer brokerId, BrokerRemovalDescription.BrokerShutdownStatus brokerShutdownStatus, BrokerRemovalDescription.PartitionReassignmentsStatus partitionReassignmentsStatus, java.util.Optional<BrokerRemovalError> removalError)

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	brokerId()
BrokerRemovalDescription.BrokerShutdownStatus	brokerShutdownStatus()
BrokerRemovalDescription.PartitionReassignmentsStatus	partitionReassignmentsStatus()
java.util.Optional<BrokerRemovalError>	removalError() The error that failed the broker removal operation
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BrokerRemovalDescription

public BrokerRemovalDescription(java.lang.Integer brokerId,
                                BrokerRemovalDescription.BrokerShutdownStatus brokerShutdownStatus,
                                BrokerRemovalDescription.PartitionReassignmentsStatus partitionReassignmentsStatus,
                                java.util.Optional<BrokerRemovalError> removalError)

Method Detail

brokerId

public java.lang.Integer brokerId()

brokerShutdownStatus

public BrokerRemovalDescription.BrokerShutdownStatus brokerShutdownStatus()

partitionReassignmentsStatus

public BrokerRemovalDescription.PartitionReassignmentsStatus partitionReassignmentsStatus()

removalError

public java.util.Optional<BrokerRemovalError> removalError()

The error that failed the broker removal operation

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object