Package org.apache.kafka.streams.processor.internals

Class StreamsMetadataState

java.lang.Object

org.apache.kafka.streams.processor.internals.StreamsMetadataState

public class StreamsMetadataState
extends java.lang.Object

Provides access to the StreamsMetadata in a KafkaStreams application. This can be used to discover the locations of StateStores in a KafkaStreams application

Field Summary

Fields

Modifier and Type	Field	Description
static HostInfo	UNKNOWN_HOST

Constructor Summary

Constructors

Constructor	Description
StreamsMetadataState(InternalTopologyBuilder builder, HostInfo thisHost)

Method Summary

Modifier and Type	Method	Description
java.util.Collection<StreamsMetadata>	getAllMetadata()	Find all of the StreamsMetadatas in a application
java.util.Collection<StreamsMetadata>	getAllMetadataForStore(java.lang.String storeName)	Find all of the StreamsMetadatas for a given storeName
<K> KeyQueryMetadata	getKeyQueryMetadataForKey(java.lang.String storeName, K key, org.apache.kafka.common.serialization.Serializer<K> keySerializer)	Find the KeyQueryMetadatas for a given storeName and key.
<K> KeyQueryMetadata	getKeyQueryMetadataForKey(java.lang.String storeName, K key, StreamPartitioner<? super K,?> partitioner)	Find the KeyQueryMetadatas for a given storeName and key Note: the key may not exist in the StateStore,this method provides a way of finding which StreamsMetadata it would exist on.
StreamsMetadata	getLocalMetadata()	Get the StreamsMetadatas for the local instance in a application
<K> StreamsMetadata	getMetadataWithKey(java.lang.String storeName, K key, org.apache.kafka.common.serialization.Serializer<K> keySerializer)	Deprecated. Use getKeyQueryMetadataForKey(String, Object, Serializer) instead.
<K> StreamsMetadata	getMetadataWithKey(java.lang.String storeName, K key, StreamPartitioner<? super K,?> partitioner)	Deprecated. Use getKeyQueryMetadataForKey(String, Object, StreamPartitioner) instead.
java.lang.String	getStoreForChangelogTopic(java.lang.String topicName)
java.lang.String	toString()
java.lang.String	toString(java.lang.String indent)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

UNKNOWN_HOST

public static final HostInfo UNKNOWN_HOST

Constructor Detail

StreamsMetadataState

public StreamsMetadataState(InternalTopologyBuilder builder,
                            HostInfo thisHost)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(java.lang.String indent)

getLocalMetadata

public StreamsMetadata getLocalMetadata()

Get the StreamsMetadatas for the local instance in a application

Returns:

the StreamsMetadatas for the local instance in a KafkaStreams application

getAllMetadata

public java.util.Collection<StreamsMetadata> getAllMetadata()

Find all of the StreamsMetadatas in a application

Returns:

all the StreamsMetadatas in a KafkaStreams application

getAllMetadataForStore

public java.util.Collection<StreamsMetadata> getAllMetadataForStore(java.lang.String storeName)

Find all of the StreamsMetadatas for a given storeName

Parameters:

storeName - the storeName to find metadata for

Returns:

A collection of StreamsMetadata that have the provided storeName

getMetadataWithKey

@Deprecated
public <K> StreamsMetadata getMetadataWithKey(java.lang.String storeName,
                                              K key,
                                              org.apache.kafka.common.serialization.Serializer<K> keySerializer)

Deprecated.

Use getKeyQueryMetadataForKey(String, Object, Serializer) instead.

Find the StreamsMetadatas for a given storeName and key. This method will use the DefaultStreamPartitioner to locate the store. If a custom partitioner has been used please use getMetadataWithKey(String, Object, StreamPartitioner) Note: the key may not exist in the StateStore, this method provides a way of finding which StreamsMetadata it would exist on.

Type Parameters:

K - key type

Parameters:

storeName - Name of the store

key - Key to use

keySerializer - Serializer for the key

Returns:

The StreamsMetadata for the storeName and key or StreamsMetadata.NOT_AVAILABLE if streams is (re-)initializing, or null if no matching metadata could be found.

getKeyQueryMetadataForKey

public <K> KeyQueryMetadata getKeyQueryMetadataForKey(java.lang.String storeName,
                                                      K key,
                                                      org.apache.kafka.common.serialization.Serializer<K> keySerializer)

Find the KeyQueryMetadatas for a given storeName and key. This method will use the DefaultStreamPartitioner to locate the store. If a custom partitioner has been used please use getKeyQueryMetadataForKey(String, Object, StreamPartitioner) instead. Note: the key may not exist in the StateStore, this method provides a way of finding which KeyQueryMetadata it would exist on.

Type Parameters:

K - key type

Parameters:

storeName - Name of the store

key - Key to use

keySerializer - Serializer for the key

Returns:

The KeyQueryMetadata for the storeName and key or KeyQueryMetadata.NOT_AVAILABLE if streams is (re-)initializing or null if the corresponding topic cannot be found, or null if no matching metadata could be found.

getKeyQueryMetadataForKey

public <K> KeyQueryMetadata getKeyQueryMetadataForKey(java.lang.String storeName,
                                                      K key,
                                                      StreamPartitioner<? super K,?> partitioner)

Find the KeyQueryMetadatas for a given storeName and key Note: the key may not exist in the StateStore,this method provides a way of finding which StreamsMetadata it would exist on.

Type Parameters:

K - key type

Parameters:

storeName - Name of the store

key - Key to use

partitioner - partitioner to use to find correct partition for key

Returns:

The KeyQueryMetadata for the storeName and key or KeyQueryMetadata.NOT_AVAILABLE if streams is (re-)initializing, or null if no matching metadata could be found.

getMetadataWithKey

@Deprecated
public <K> StreamsMetadata getMetadataWithKey(java.lang.String storeName,
                                              K key,
                                              StreamPartitioner<? super K,?> partitioner)

Deprecated.

Use getKeyQueryMetadataForKey(String, Object, StreamPartitioner) instead.

Find the StreamsMetadatas for a given storeName and key. Note: the key may not exist in the StateStore, this method provides a way of finding which StreamsMetadata it would exist on.

Type Parameters:

K - key type

Parameters:

storeName - Name of the store

key - Key to use

partitioner - partitioner to use to find correct partition for key

Returns:

The StreamsMetadata for the storeName and key or StreamsMetadata.NOT_AVAILABLE if streams is (re-)initializing, or null if no matching metadata could be found.

getStoreForChangelogTopic

public java.lang.String getStoreForChangelogTopic(java.lang.String topicName)