[ 
https://issues.apache.org/jira/browse/FLINK-8062?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16251326#comment-16251326
 ] 

Kostas Kloudas commented on FLINK-8062:
---------------------------------------

This was intentional. 

The reason is that user-defined state currently belongs to the 
{{VoidNamespace}} and the namespace is not exposed to the user.
The only state on different namespace is the window state, and this method was 
added so that if in the future we decide to expose the 
namespace or make the window state queryable, then this method will already be 
in place.

You are right though that if a method is public, it should be documented. Thus 
I propose to simply make the method {{private}} for now
and if/when we decide to one or both of the above, we can simply make it 
public. 

What do you think?


> QueryableStateClient#getKvState(...N Namespace,...) not documented
> ------------------------------------------------------------------
>
>                 Key: FLINK-8062
>                 URL: https://issues.apache.org/jira/browse/FLINK-8062
>             Project: Flink
>          Issue Type: Improvement
>          Components: Queryable State
>    Affects Versions: 1.4.0
>            Reporter: Chesnay Schepler
>            Assignee: Kostas Kloudas
>
> The {{QueryableStateClient}} has this method:
> {code}
> public <K, N, S extends State, V> CompletableFuture<S> getKvState(
>               final JobID jobId,
>               final String queryableStateName,
>               final K key,
>               final N namespace,
>               final TypeInformation<K> keyTypeInfo,
>               final TypeInformation<N> namespaceTypeInfo,
>               final StateDescriptor<S, V> stateDescriptor) {
> {code}
> There is no documentation on how to use this method or what namespaces are.



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

Reply via email to