Class ClusterLinkDescription

java.lang.Object

org.apache.kafka.clients.admin.ClusterLinkDescription

public class ClusterLinkDescription
extends Object

A description of a cluster that's linked.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClusterLinkDescription.Builder
static enum	ClusterLinkDescription.ConnectionMode
static enum	ClusterLinkDescription.LinkMode
static enum	ClusterLinkDescription.LinkState

Constructor Summary

Constructors

Constructor	Description
ClusterLinkDescription(String linkName, Uuid linkId, String remoteClusterId, String localClusterId, Collection<String> topics, ClusterLinkDescription.LinkState linkState, ClusterLinkDescription.LinkMode linkMode, ClusterLinkDescription.ConnectionMode connectionMode, ClusterLinkError clusterLinkError, String linkErrorMessage)
ClusterLinkDescription(String linkName, Uuid linkId, String remoteClusterId, String localClusterId, Collection<String> topics, ClusterLinkDescription.LinkState linkState, ClusterLinkDescription.LinkMode linkMode, ClusterLinkDescription.ConnectionMode connectionMode, ClusterLinkError clusterLinkError, String linkErrorMessage, int linkCoordinatorId, String linkCoordinatorHost, int linkCoordinatorPort)
ClusterLinkDescription(String linkName, Uuid linkId, String remoteClusterId, String localClusterId, Collection<String> topics, ClusterLinkDescription.LinkState linkState, ClusterLinkDescription.LinkMode linkMode, ClusterLinkDescription.ConnectionMode connectionMode, ClusterLinkError clusterLinkError, String linkErrorMessage, int linkCoordinatorId, String linkCoordinatorHost, int linkCoordinatorPort, ClusterLinkDescription.LinkState remoteLinkState, ClusterLinkError remoteLinkError, String remoteLinkErrorMessage, long remoteLinkStateTimeMs)
ClusterLinkDescription(String linkName, Uuid linkId, String remoteClusterId, String localClusterId, Collection<String> topics, ClusterLinkDescription.LinkState linkState, ClusterLinkDescription.LinkMode linkMode, ClusterLinkDescription.ConnectionMode connectionMode, ClusterLinkError clusterLinkError, String linkErrorMessage, int linkCoordinatorId, String linkCoordinatorHost, int linkCoordinatorPort, ClusterLinkDescription.LinkState remoteLinkState, ClusterLinkError remoteLinkError, String remoteLinkErrorMessage, long remoteLinkStateTimeMs, int linkCoordinatorPartitionId)
ClusterLinkDescription(String linkName, Uuid linkId, String remoteClusterId, String localClusterId, Collection<String> topics, ClusterLinkDescription.LinkState linkState, ClusterLinkDescription.LinkMode linkMode, ClusterLinkDescription.ConnectionMode connectionMode, ClusterLinkError clusterLinkError, String linkErrorMessage, List<ClusterLinkTaskDescription> taskDescriptions, Map<org.apache.kafka.common.replica.ReplicaStatus.MirrorInfo.StateCategory, Integer> partitionStateCategoryCounts)
ClusterLinkDescription(String linkName, Uuid linkId, String remoteClusterId, String localClusterId, Collection<String> topics, ClusterLinkDescription.LinkState linkState, ClusterLinkDescription.LinkMode linkMode, ClusterLinkDescription.ConnectionMode connectionMode, ClusterLinkError clusterLinkError, String linkErrorMessage, Node linkCoordinator)	Creates a cluster link description.

Method Summary

Modifier and Type	Method	Description
ClusterLinkError	clusterLinkError()
Uuid	clusterLinkId()
ClusterLinkDescription.ConnectionMode	connectionMode()	Connection mode.
boolean	equals(Object o)
int	hashCode()
String	linkCoordinatorHost()
int	linkCoordinatorId()
int	linkCoordinatorPartitionId()
int	linkCoordinatorPort()
String	linkErrorMessage()
ClusterLinkDescription.LinkMode	linkMode()	Link mode.
String	linkName()	The link name for the cluster link.
ClusterLinkDescription.LinkState	linkState()
String	localClusterId()
Map<org.apache.kafka.common.replica.ReplicaStatus.MirrorInfo.StateCategory, Integer>	partitionStateCategoryCounts()
String	remoteClusterId()
ClusterLinkError	remoteLinkError()
String	remoteLinkErrorMessage()
ClusterLinkDescription.LinkState	remoteLinkState()
long	remoteLinkStateTimeMs()
List<ClusterLinkTaskDescription>	taskDescriptions()
Optional<Collection<String>>	topics()	The topics that are linked with the cluster link, otherwise if empty, then the topics weren't requested.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ClusterLinkDescription

public ClusterLinkDescription(String linkName,
 Uuid linkId,
 String remoteClusterId,
 String localClusterId,
 Collection<String> topics,
 ClusterLinkDescription.LinkState linkState,
 ClusterLinkDescription.LinkMode linkMode,
 ClusterLinkDescription.ConnectionMode connectionMode,
 ClusterLinkError clusterLinkError,
 String linkErrorMessage,
 Node linkCoordinator)

Creates a cluster link description.

Parameters:

linkName - The link name for the cluster link

linkId - The Uuid associated with the cluster link

remoteClusterId - linked cluster's ID, or null if not known.

localClusterId - Local cluster id.

topics - The topics that are linked with the cluster link, otherwise if null, then the topics weren't requested.

linkState - The link state.

linkMode - The link mode. Can be unknown if link state is failed.

connectionMode - The connection mode. Can be unknown if the link state is failed.

clusterLinkError - The error reason for why a link is in an error state. It's value will be NO_ERROR if the link is not in an error state.

linkErrorMessage - Error message describing why a link is in an error state, if it is in fact in an error state.

linkCoordinator - LinkCoordinator information for the link representing the broker id, host and port number.

ClusterLinkDescription

public ClusterLinkDescription(String linkName,
 Uuid linkId,
 String remoteClusterId,
 String localClusterId,
 Collection<String> topics,
 ClusterLinkDescription.LinkState linkState,
 ClusterLinkDescription.LinkMode linkMode,
 ClusterLinkDescription.ConnectionMode connectionMode,
 ClusterLinkError clusterLinkError,
 String linkErrorMessage)

ClusterLinkDescription

public ClusterLinkDescription(String linkName,
 Uuid linkId,
 String remoteClusterId,
 String localClusterId,
 Collection<String> topics,
 ClusterLinkDescription.LinkState linkState,
 ClusterLinkDescription.LinkMode linkMode,
 ClusterLinkDescription.ConnectionMode connectionMode,
 ClusterLinkError clusterLinkError,
 String linkErrorMessage,
 int linkCoordinatorId,
 String linkCoordinatorHost,
 int linkCoordinatorPort)

ClusterLinkDescription

public ClusterLinkDescription(String linkName,
 Uuid linkId,
 String remoteClusterId,
 String localClusterId,
 Collection<String> topics,
 ClusterLinkDescription.LinkState linkState,
 ClusterLinkDescription.LinkMode linkMode,
 ClusterLinkDescription.ConnectionMode connectionMode,
 ClusterLinkError clusterLinkError,
 String linkErrorMessage,
 int linkCoordinatorId,
 String linkCoordinatorHost,
 int linkCoordinatorPort,
 ClusterLinkDescription.LinkState remoteLinkState,
 ClusterLinkError remoteLinkError,
 String remoteLinkErrorMessage,
 long remoteLinkStateTimeMs)

ClusterLinkDescription

public ClusterLinkDescription(String linkName,
 Uuid linkId,
 String remoteClusterId,
 String localClusterId,
 Collection<String> topics,
 ClusterLinkDescription.LinkState linkState,
 ClusterLinkDescription.LinkMode linkMode,
 ClusterLinkDescription.ConnectionMode connectionMode,
 ClusterLinkError clusterLinkError,
 String linkErrorMessage,
 int linkCoordinatorId,
 String linkCoordinatorHost,
 int linkCoordinatorPort,
 ClusterLinkDescription.LinkState remoteLinkState,
 ClusterLinkError remoteLinkError,
 String remoteLinkErrorMessage,
 long remoteLinkStateTimeMs,
 int linkCoordinatorPartitionId)

ClusterLinkDescription

public ClusterLinkDescription(String linkName,
 Uuid linkId,
 String remoteClusterId,
 String localClusterId,
 Collection<String> topics,
 ClusterLinkDescription.LinkState linkState,
 ClusterLinkDescription.LinkMode linkMode,
 ClusterLinkDescription.ConnectionMode connectionMode,
 ClusterLinkError clusterLinkError,
 String linkErrorMessage,
 List<ClusterLinkTaskDescription> taskDescriptions,
 Map<org.apache.kafka.common.replica.ReplicaStatus.MirrorInfo.StateCategory, Integer> partitionStateCategoryCounts)

Method Details

linkName

public String linkName()

The link name for the cluster link.

clusterLinkId

public Uuid clusterLinkId()

remoteClusterId

public String remoteClusterId()

localClusterId

public String localClusterId()

topics

public Optional<Collection<String>> topics()

The topics that are linked with the cluster link, otherwise if empty, then the topics weren't requested.

linkState

public ClusterLinkDescription.LinkState linkState()

linkMode

public ClusterLinkDescription.LinkMode linkMode()

Link mode. Can be unknown if link state is failed.

connectionMode

public ClusterLinkDescription.ConnectionMode connectionMode()

Connection mode. Can be unknown if link state is failed.

clusterLinkError

public ClusterLinkError clusterLinkError()

linkErrorMessage

public String linkErrorMessage()

linkCoordinatorId

public int linkCoordinatorId()

linkCoordinatorHost

public String linkCoordinatorHost()

linkCoordinatorPort

public int linkCoordinatorPort()

remoteLinkState

public ClusterLinkDescription.LinkState remoteLinkState()

remoteLinkError

public ClusterLinkError remoteLinkError()

remoteLinkErrorMessage

public String remoteLinkErrorMessage()

remoteLinkStateTimeMs

public long remoteLinkStateTimeMs()

taskDescriptions

public List<ClusterLinkTaskDescription> taskDescriptions()

partitionStateCategoryCounts

public Map<org.apache.kafka.common.replica.ReplicaStatus.MirrorInfo.StateCategory, Integer> partitionStateCategoryCounts()

linkCoordinatorPartitionId

public int linkCoordinatorPartitionId()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object