Package org.apache.kafka.clients.admin

Class ListMirrorsOptions

java.lang.Object

org.apache.kafka.clients.admin.AbstractOptions<ListMirrorsOptions>

org.apache.kafka.clients.admin.ListMirrorsOptions

@Confluent
@Evolving
public class ListMirrorsOptions
extends AbstractOptions<ListMirrorsOptions>

Options for ConfluentAdmin.listMirrors(ListMirrorsOptions). The API of this class is evolving, see Admin for details.

Constructor Summary

Constructors

Constructor	Description
ListMirrorsOptions()

Method Summary

Modifier and Type	Method	Description
boolean	includeStopped()	Whether to include stopped mirror topics.
ListMirrorsOptions	includeStopped(boolean includeStopped)	Sets whether to include stopped mirror topics.
Optional<String>	linkName()	The link name whose mirrors should be listed, or all if empty.
ListMirrorsOptions	linkName(Optional<String> linkName)	The link name whose mirrors should be listed, or all if empty.
boolean	listRemoteMirrors()	Whether to list the mirror topics on the remote clusters.
ListMirrorsOptions	listRemoteMirrors(boolean listRemoteMirrors)	Sets whether to list remote mirror topics.

Methods inherited from class org.apache.kafka.clients.admin.AbstractOptions

timeoutMs, timeoutMs

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ListMirrorsOptions

public ListMirrorsOptions()

Method Details

linkName

public Optional<String> linkName()

The link name whose mirrors should be listed, or all if empty.

linkName

public ListMirrorsOptions linkName(Optional<String> linkName)

The link name whose mirrors should be listed, or all if empty.

includeStopped

public boolean includeStopped()

Whether to include stopped mirror topics.

listRemoteMirrors

public boolean listRemoteMirrors()

Whether to list the mirror topics on the remote clusters. Only works for bidirectional links.

includeStopped

public ListMirrorsOptions includeStopped(boolean includeStopped)

Sets whether to include stopped mirror topics.

listRemoteMirrors

public ListMirrorsOptions listRemoteMirrors(boolean listRemoteMirrors)

Sets whether to list remote mirror topics.