Package org.apache.kafka.connect.health

Interface ConnectClusterState

public interface ConnectClusterState

Provides the ability to lookup connector metadata and its health. This is made available to the ConnectRestExtension implementations. The Connect framework provides the implementation for this interface.

Method Summary

Modifier and Type	Method	Description
ConnectorHealth	connectorHealth(java.lang.String connName)	Lookup the current health of a connector and its tasks.
java.util.Collection<java.lang.String>	connectors()	Get the names of the connectors currently deployed in this cluster.

Method Detail

connectors

java.util.Collection<java.lang.String> connectors()

Get the names of the connectors currently deployed in this cluster. This is a full list of connectors in the cluster gathered from the current configuration, which may change over time.

Returns:

collection of connector names, never null

connectorHealth

ConnectorHealth connectorHealth(java.lang.String connName)

Lookup the current health of a connector and its tasks. This provides the current snapshot of health by querying the underlying herder. A connector returned by previous invocation of connectors() may no longer be available and could result in NotFoundException.

Parameters:

connName - name of the connector

Returns:

the health of the connector for the connector name

Throws:

NotFoundException - if the requested connector can't be found