Interface MirrorManager

public interface MirrorManager

A service to manage Kafka mirrors.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	createMirror(String clusterId, String linkName, String sourceTopicName, String mirrorTopicName, Map<String, Optional<String>> configs, Optional<Short> replicationFactor)	Creates a new Kafka mirror with specified replication factor
CompletableFuture<List<AlterMirrors>>	failOverMirrors(String clusterId, String linkName, Set<String> mirrorTopicNames, String mirrorTopicNamePattern, boolean validateOnly)	Failover the Kafka mirror
CompletableFuture<Optional<Mirror>>	getMirror(String clusterId, String linkName, String mirrorTopicName, Boolean includeStateTransitionErrors)	Returns a list of Kafka mirrors belonging to the Link with the given clusterId, linkName, and mirrorTopicName.
CompletableFuture<List<Mirror>>	listMirrors(String clusterId, MirrorStatus mirrorStatus)	Returns all Kafka mirrors in the cluster with the given clusterId, and in the given mirrorStatus.
default CompletableFuture<List<Mirror>>	listMirrors(String clusterId, String linkName, MirrorStatus mirrorStatus)	Returns all Kafka mirrors under the link with the given linkName, in the cluster with the given clusterId, and in the given mirrorStatus.
CompletableFuture<List<AlterMirrors>>	pauseMirrors(String clusterId, String linkName, Set<String> mirrorTopicNames, String mirrorTopicNamePattern, boolean validateOnly)	Pause the Kafka mirror
CompletableFuture<List<AlterMirrors>>	promoteMirrors(String clusterId, String linkName, Set<String> mirrorTopicNames, String mirrorTopicNamePattern, boolean validateOnly)	Promote the Kafka mirror
CompletableFuture<List<AlterMirrors>>	resumeMirrors(String clusterId, String linkName, Set<String> mirrorTopicNames, String mirrorTopicNamePattern, boolean validateOnly)	Resume the Kafka mirror
CompletableFuture<List<AlterMirrors>>	reverseAndPauseMirrors(String clusterId, String linkName, Set<String> mirrorTopicNames, String mirrorTopicNamePattern, boolean validateOnly)	Reverse and Start the Kafka mirror
CompletableFuture<List<AlterMirrors>>	reverseAndStartMirrors(String clusterId, String linkName, Set<String> mirrorTopicNames, String mirrorTopicNamePattern, boolean validateOnly)	Reverse and Start the Kafka mirror
CompletableFuture<List<AlterMirrors>>	truncateAndRestoreMirrors(String clusterId, String linkName, Set<String> mirrorTopicNames, String mirrorTopicNamePattern, boolean includePartitionLevelTruncationData, boolean validateOnly)	Truncate and Restore the Kafka mirror

Method Details

listMirrors

CompletableFuture<List<Mirror>> listMirrors(String clusterId,
 MirrorStatus mirrorStatus)

Returns all Kafka mirrors in the cluster with the given clusterId, and in the given mirrorStatus.

listMirrors

default CompletableFuture<List<Mirror>> listMirrors(String clusterId,
 String linkName,
 MirrorStatus mirrorStatus)

Returns all Kafka mirrors under the link with the given linkName, in the cluster with the given clusterId, and in the given mirrorStatus.

getMirror

CompletableFuture<Optional<Mirror>> getMirror(String clusterId,
 String linkName,
 String mirrorTopicName,
 @Nullable
 Boolean includeStateTransitionErrors)

Returns a list of Kafka mirrors belonging to the Link with the given clusterId, linkName, and mirrorTopicName.

createMirror

CompletableFuture<Void> createMirror(String clusterId,
 String linkName,
 String sourceTopicName,
 String mirrorTopicName,
 Map<String, Optional<String>> configs,
 Optional<Short> replicationFactor)

Creates a new Kafka mirror with specified replication factor

pauseMirrors

CompletableFuture<List<AlterMirrors>> pauseMirrors(String clusterId,
 String linkName,
 Set<String> mirrorTopicNames,
 String mirrorTopicNamePattern,
 boolean validateOnly)

Pause the Kafka mirror

resumeMirrors

CompletableFuture<List<AlterMirrors>> resumeMirrors(String clusterId,
 String linkName,
 Set<String> mirrorTopicNames,
 String mirrorTopicNamePattern,
 boolean validateOnly)

Resume the Kafka mirror

promoteMirrors

CompletableFuture<List<AlterMirrors>> promoteMirrors(String clusterId,
 String linkName,
 Set<String> mirrorTopicNames,
 String mirrorTopicNamePattern,
 boolean validateOnly)

Promote the Kafka mirror

failOverMirrors

CompletableFuture<List<AlterMirrors>> failOverMirrors(String clusterId,
 String linkName,
 Set<String> mirrorTopicNames,
 String mirrorTopicNamePattern,
 boolean validateOnly)

Failover the Kafka mirror

reverseAndStartMirrors

CompletableFuture<List<AlterMirrors>> reverseAndStartMirrors(String clusterId,
 String linkName,
 Set<String> mirrorTopicNames,
 String mirrorTopicNamePattern,
 boolean validateOnly)

Reverse and Start the Kafka mirror

reverseAndPauseMirrors

CompletableFuture<List<AlterMirrors>> reverseAndPauseMirrors(String clusterId,
 String linkName,
 Set<String> mirrorTopicNames,
 String mirrorTopicNamePattern,
 boolean validateOnly)

Reverse and Start the Kafka mirror

truncateAndRestoreMirrors

CompletableFuture<List<AlterMirrors>> truncateAndRestoreMirrors(String clusterId,
 String linkName,
 Set<String> mirrorTopicNames,
 String mirrorTopicNamePattern,
 boolean includePartitionLevelTruncationData,
 boolean validateOnly)

Truncate and Restore the Kafka mirror