SingleClusterTopicMetadataService (Flink : Connectors : Kafka 3.3.0-1.19 API)

java.lang.Object
- org.apache.flink.connector.kafka.dynamic.metadata.SingleClusterTopicMetadataService

All Implemented Interfaces:

Serializable, AutoCloseable, KafkaMetadataService
```
@Experimental
public class SingleClusterTopicMetadataService
extends Object
implements KafkaMetadataService
```
A KafkaMetadataService that delegates metadata fetching to a single AdminClient, which is scoped to a single cluster. The stream ids are equivalent to topics.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor	Description
`SingleClusterTopicMetadataService(String kafkaClusterId, Properties properties)`	Create a `SingleClusterTopicMetadataService`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`close()`
`Map<String,KafkaStream>`	`describeStreams(Collection<String> streamIds)`	Get current metadata for queried streams.
`Set<KafkaStream>`	`getAllStreams()`	Get current metadata for all streams.
`boolean`	`isClusterActive(String kafkaClusterId)`	Check if the cluster is active.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SingleClusterTopicMetadataService
```
public SingleClusterTopicMetadataService(String kafkaClusterId,
                                         Properties properties)
```
    Create a SingleClusterTopicMetadataService.
    
    Parameters:
    
    kafkaClusterId - the id of the Kafka cluster.
    
    properties - the properties of the Kafka cluster.
- Method Detail
  - getAllStreams
```
public Set<KafkaStream> getAllStreams()
```
    Get current metadata for all streams.
    
    Specified by:
    
    getAllStreams in interface KafkaMetadataService
    
    Returns:
    
    set of all streams
  - describeStreams
```
public Map<String,KafkaStream> describeStreams(Collection<String> streamIds)
```
    Get current metadata for queried streams.
    
    Specified by:
    
    describeStreams in interface KafkaMetadataService
    
    Parameters:
    
    streamIds - stream full names
    
    Returns:
    
    map of stream name to metadata
  - isClusterActive
```
public boolean isClusterActive(String kafkaClusterId)
```
    Check if the cluster is active.
    
    Specified by:
    
    isClusterActive in interface KafkaMetadataService
    
    Parameters:
    
    kafkaClusterId - Kafka cluster id
    
    Returns:
    
    boolean whether the cluster is active
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable