Package org.apache.kafka.clients.admin

Class ClusterLinkListing

java.lang.Object

org.apache.kafka.clients.admin.ClusterLinkListing

public class ClusterLinkListing
extends Object

A listing of a cluster that's linked.

Constructor Summary

Constructors

Constructor	Description
ClusterLinkListing(String linkName, Uuid linkId, String remoteClusterId, String localClusterId, Optional<Collection<String>> topics, ClusterLinkError clusterLinkError, String linkErrorMessage, ClusterLinkDescription.LinkState linkState)	Creates a cluster link listing.

Method Summary

Modifier and Type	Method	Description
boolean	available()
String	clusterId()	The linked cluster's ID, or null if none.
ClusterLinkError	clusterLinkError()
Uuid	clusterLinkId()	The Uuid of the cluster link that uniquely represents this cluster link.
boolean	equals(Object o)
int	hashCode()
String	linkErrorMessage()
String	linkName()	The link name for the cluster link.
ClusterLinkDescription.LinkState	linkState()
String	localClusterId()
String	remoteClusterId()
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

ClusterLinkListing

public ClusterLinkListing(String linkName,
 Uuid linkId,
 String remoteClusterId,
 String localClusterId,
 Optional<Collection<String>> topics,
 ClusterLinkError clusterLinkError,
 String linkErrorMessage,
 ClusterLinkDescription.LinkState linkState)

Creates a cluster link listing.

Parameters:

linkName - The link name for the cluster link

linkId - The Uuid that uniquely identifies this 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 none, then the topics weren't requested.

clusterLinkError - The reason for why a link is unavailable, if it is in fact unavailable.

linkErrorMessage - Error message describing why a link is unavailable, if it is in fact unavailable.

linkState - State of link

Method Details

linkName

public String linkName()

The link name for the cluster link.

clusterLinkId

public Uuid clusterLinkId()

The Uuid of the cluster link that uniquely represents this cluster link.

clusterId

public String clusterId()

The linked cluster's ID, or null if none. Note that this method will be deprecated soon, use remoteClusterId()

remoteClusterId

public String remoteClusterId()

localClusterId

public String localClusterId()

available

public boolean available()

Returns:

whether the link is available or not.

linkErrorMessage

public String linkErrorMessage()

clusterLinkError

public ClusterLinkError clusterLinkError()

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()

Returns:

state of the link.

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