[jira] [Commented] (FLINK-8217) Properly annotate APIs of flink-connector-kinesis
[ https://issues.apache.org/jira/browse/FLINK-8217?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16325036#comment-16325036 ] Tzu-Li (Gordon) Tai commented on FLINK-8217: Merged for 1.5: 30734d55660bfe00c39138584f0e576e711ad791 > Properly annotate APIs of flink-connector-kinesis > - > > Key: FLINK-8217 > URL: https://issues.apache.org/jira/browse/FLINK-8217 > Project: Flink > Issue Type: Sub-task > Components: Kinesis Connector >Affects Versions: 1.5.0 >Reporter: Bowen Li >Assignee: Bowen Li > Fix For: 1.5.0 > > -- This message was sent by Atlassian JIRA (v6.4.14#64029)
[jira] [Commented] (FLINK-8217) Properly annotate APIs of flink-connector-kinesis
[ https://issues.apache.org/jira/browse/FLINK-8217?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16323958#comment-16323958 ] ASF GitHub Bot commented on FLINK-8217: --- Github user asfgit closed the pull request at: https://github.com/apache/flink/pull/5138 > Properly annotate APIs of flink-connector-kinesis > - > > Key: FLINK-8217 > URL: https://issues.apache.org/jira/browse/FLINK-8217 > Project: Flink > Issue Type: Sub-task > Components: Kinesis Connector >Affects Versions: 1.5.0 >Reporter: Bowen Li >Assignee: Bowen Li > Fix For: 1.5.0 > > -- This message was sent by Atlassian JIRA (v6.4.14#64029)
[jira] [Commented] (FLINK-8217) Properly annotate APIs of flink-connector-kinesis
[ https://issues.apache.org/jira/browse/FLINK-8217?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16323711#comment-16323711 ] ASF GitHub Bot commented on FLINK-8217: --- Github user tzulitai commented on the issue: https://github.com/apache/flink/pull/5138 Since there are no other objections, will merge this to `master` now .. > Properly annotate APIs of flink-connector-kinesis > - > > Key: FLINK-8217 > URL: https://issues.apache.org/jira/browse/FLINK-8217 > Project: Flink > Issue Type: Sub-task > Components: Kinesis Connector >Affects Versions: 1.5.0 >Reporter: Bowen Li >Assignee: Bowen Li > Fix For: 1.5.0 > > -- This message was sent by Atlassian JIRA (v6.4.14#64029)
[jira] [Commented] (FLINK-8217) Properly annotate APIs of flink-connector-kinesis
[ https://issues.apache.org/jira/browse/FLINK-8217?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16319875#comment-16319875 ] ASF GitHub Bot commented on FLINK-8217: --- Github user tzulitai commented on the issue: https://github.com/apache/flink/pull/5138 I was waiting for any objections from others before moving ahead to merge this. If there are no other objections, will merge by the end of the week :) > Properly annotate APIs of flink-connector-kinesis > - > > Key: FLINK-8217 > URL: https://issues.apache.org/jira/browse/FLINK-8217 > Project: Flink > Issue Type: Sub-task > Components: Kinesis Connector >Affects Versions: 1.5.0 >Reporter: Bowen Li >Assignee: Bowen Li > Fix For: 1.5.0 > > -- This message was sent by Atlassian JIRA (v6.4.14#64029)
[jira] [Commented] (FLINK-8217) Properly annotate APIs of flink-connector-kinesis
[ https://issues.apache.org/jira/browse/FLINK-8217?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16309168#comment-16309168 ] ASF GitHub Bot commented on FLINK-8217: --- Github user bowenli86 commented on the issue: https://github.com/apache/flink/pull/5138 @tzulitai The PR has been updated > Properly annotate APIs of flink-connector-kinesis > - > > Key: FLINK-8217 > URL: https://issues.apache.org/jira/browse/FLINK-8217 > Project: Flink > Issue Type: Sub-task > Components: Kinesis Connector >Affects Versions: 1.5.0 >Reporter: Bowen Li >Assignee: Bowen Li > Fix For: 1.5.0 > > -- This message was sent by Atlassian JIRA (v6.4.14#64029)
[jira] [Commented] (FLINK-8217) Properly annotate APIs of flink-connector-kinesis
[ https://issues.apache.org/jira/browse/FLINK-8217?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16294541#comment-16294541 ] ASF GitHub Bot commented on FLINK-8217: --- Github user bowenli86 commented on the issue: https://github.com/apache/flink/pull/5138 A good point from Gordon. This PR's main purpose is actually reminding users which class to use and which not. `PublicEvolving` should be good enough. Will update the PR > Properly annotate APIs of flink-connector-kinesis > - > > Key: FLINK-8217 > URL: https://issues.apache.org/jira/browse/FLINK-8217 > Project: Flink > Issue Type: Sub-task > Components: Kinesis Connector >Affects Versions: 1.5.0 >Reporter: Bowen Li >Assignee: Bowen Li > Fix For: 1.5.0 > > -- This message was sent by Atlassian JIRA (v6.4.14#64029)
[jira] [Commented] (FLINK-8217) Properly annotate APIs of flink-connector-kinesis
[ https://issues.apache.org/jira/browse/FLINK-8217?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16294513#comment-16294513 ] ASF GitHub Bot commented on FLINK-8217: --- Github user tzulitai commented on the issue: https://github.com/apache/flink/pull/5138 My intention for opening FLINK-8217 was more towards the purpose of clearly identifying what is `@Internal` and should not be used. I can agree with that we at least separate APIs to be annotated as either `@Internal` or `@PublicEvolving` for now. Whether or not we want to elevate certain APIs to `@Public` can probably be a separate issue. > Properly annotate APIs of flink-connector-kinesis > - > > Key: FLINK-8217 > URL: https://issues.apache.org/jira/browse/FLINK-8217 > Project: Flink > Issue Type: Sub-task > Components: Kinesis Connector >Affects Versions: 1.5.0 >Reporter: Bowen Li >Assignee: Bowen Li > Fix For: 1.5.0 > > -- This message was sent by Atlassian JIRA (v6.4.14#64029)
[jira] [Commented] (FLINK-8217) Properly annotate APIs of flink-connector-kinesis
[ https://issues.apache.org/jira/browse/FLINK-8217?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16293062#comment-16293062 ] ASF GitHub Bot commented on FLINK-8217: --- Github user StephanEwen commented on the issue: https://github.com/apache/flink/pull/5138 I agree that we should be careful with `@Public` and if in doubt resort to `@PublicEvolving` (and use `@Internal` sort of as the default). Given that @tzulitai did a good amount of the Kinesis work, his buy-in for `@Public` classes would be good. > Properly annotate APIs of flink-connector-kinesis > - > > Key: FLINK-8217 > URL: https://issues.apache.org/jira/browse/FLINK-8217 > Project: Flink > Issue Type: Sub-task > Components: Kinesis Connector >Affects Versions: 1.5.0 >Reporter: Bowen Li >Assignee: Bowen Li > Fix For: 1.5.0 > > -- This message was sent by Atlassian JIRA (v6.4.14#64029)
[jira] [Commented] (FLINK-8217) Properly annotate APIs of flink-connector-kinesis
[ https://issues.apache.org/jira/browse/FLINK-8217?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16287780#comment-16287780 ] ASF GitHub Bot commented on FLINK-8217: --- Github user greghogan commented on the issue: https://github.com/apache/flink/pull/5138 @bowenli86 the `@Public` annotation is much more than an acknowledgement, it promises that Flink will support that API essentially forever (despite the large number of "2.0" tickets, it's likely that few APIs will be modified). If there is an implicit annotation I think it is closer to `@Internal` than to `@PublicEvolving`, and either of these two can be used with care without buy-in from the full developer community. I'm not sure that a FLIP is the best way to handle the promotion of `@PublicEvolving` to `@Public`. I think this might be better handled once per release, and there are other "bulk" considerations as well such as dependency versions which we may want to formalize in the release schedule. > Properly annotate APIs of flink-connector-kinesis > - > > Key: FLINK-8217 > URL: https://issues.apache.org/jira/browse/FLINK-8217 > Project: Flink > Issue Type: Sub-task > Components: Kinesis Connector >Affects Versions: 1.5.0 >Reporter: Bowen Li >Assignee: Bowen Li > Fix For: 1.5.0 > > -- This message was sent by Atlassian JIRA (v6.4.14#64029)
[jira] [Commented] (FLINK-8217) Properly annotate APIs of flink-connector-kinesis
[ https://issues.apache.org/jira/browse/FLINK-8217?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16286845#comment-16286845 ] ASF GitHub Bot commented on FLINK-8217: --- Github user bowenli86 commented on the issue: https://github.com/apache/flink/pull/5138 I agree with @tzulitai . FLINK-8192 acknowledges some un-annotated APIs as 'public', not necessarily changing existing official public APIs > Properly annotate APIs of flink-connector-kinesis > - > > Key: FLINK-8217 > URL: https://issues.apache.org/jira/browse/FLINK-8217 > Project: Flink > Issue Type: Sub-task > Components: Kinesis Connector >Affects Versions: 1.5.0 >Reporter: Bowen Li >Assignee: Bowen Li > Fix For: 1.5.0 > > -- This message was sent by Atlassian JIRA (v6.4.14#64029)
[jira] [Commented] (FLINK-8217) Properly annotate APIs of flink-connector-kinesis
[
https://issues.apache.org/jira/browse/FLINK-8217?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16286736#comment-16286736
]
ASF GitHub Bot commented on FLINK-8217:
---
Github user tzulitai commented on a diff in the pull request:
https://github.com/apache/flink/pull/5138#discussion_r156231822
--- Diff:
flink-connectors/flink-connector-kinesis/src/main/java/org/apache/flink/streaming/connectors/kinesis/model/KinesisStreamShard.java
---
@@ -24,9 +24,13 @@
import static org.apache.flink.util.Preconditions.checkNotNull;
/**
- * A legacy serializable representation of a AWS Kinesis Stream shard. It
is basically a wrapper class around the information
- * provided along with {@link com.amazonaws.services.kinesis.model.Shard}.
+ * A legacy serializable representation of a AWS Kinesis Stream shard.
+ * It is basically a wrapper class around the information provided along
+ * with {@link com.amazonaws.services.kinesis.model.Shard}.
+ *
+ * @deprecated Will be remove in a future version in favor of {@link
StreamShardHandle}.
*/
+@Deprecated
public class KinesisStreamShard implements Serializable {
--- End diff --
Although this is deprecated, we should probably also annotate this as
`@Internal`
> Properly annotate APIs of flink-connector-kinesis
> -
>
> Key: FLINK-8217
> URL: https://issues.apache.org/jira/browse/FLINK-8217
> Project: Flink
> Issue Type: Sub-task
> Components: Kinesis Connector
>Affects Versions: 1.5.0
>Reporter: Bowen Li
>Assignee: Bowen Li
> Fix For: 1.5.0
>
>
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
[jira] [Commented] (FLINK-8217) Properly annotate APIs of flink-connector-kinesis
[ https://issues.apache.org/jira/browse/FLINK-8217?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16286731#comment-16286731 ] ASF GitHub Bot commented on FLINK-8217: --- Github user tzulitai commented on the issue: https://github.com/apache/flink/pull/5138 @bowenli86 @greghogan To my understanding, the proposed changes for FLINK-8192 simply suggests adding proper annotations to the APIs in the Flink connectors. This does not count as a public API change, no? For example, classes such as `KinesisStreamShard` or `SequenceNumber` should be properly annotated as `@Internal`. I understand that by doing so we're narrowing down the "scope" of the public API, but I don't think there's was previously any way that those classes could have been used with the connector in any meaningful way anyways. > Properly annotate APIs of flink-connector-kinesis > - > > Key: FLINK-8217 > URL: https://issues.apache.org/jira/browse/FLINK-8217 > Project: Flink > Issue Type: Sub-task > Components: Kinesis Connector >Affects Versions: 1.5.0 >Reporter: Bowen Li >Assignee: Bowen Li > Fix For: 1.5.0 > > -- This message was sent by Atlassian JIRA (v6.4.14#64029)
[jira] [Commented] (FLINK-8217) Properly annotate APIs of flink-connector-kinesis
[
https://issues.apache.org/jira/browse/FLINK-8217?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16286741#comment-16286741
]
ASF GitHub Bot commented on FLINK-8217:
---
Github user tzulitai commented on a diff in the pull request:
https://github.com/apache/flink/pull/5138#discussion_r156231965
--- Diff:
flink-connectors/flink-connector-kinesis/src/main/java/org/apache/flink/streaming/connectors/kinesis/serialization/KinesisDeserializationSchemaWrapper.java
---
@@ -27,6 +28,7 @@
*
* @param The type created by the deserialization schema.
*/
+@PublicEvolving
public class KinesisDeserializationSchemaWrapper implements
KinesisDeserializationSchema {
--- End diff --
I think this is also only meant for `@Internal` use.
> Properly annotate APIs of flink-connector-kinesis
> -
>
> Key: FLINK-8217
> URL: https://issues.apache.org/jira/browse/FLINK-8217
> Project: Flink
> Issue Type: Sub-task
> Components: Kinesis Connector
>Affects Versions: 1.5.0
>Reporter: Bowen Li
>Assignee: Bowen Li
> Fix For: 1.5.0
>
>
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
[jira] [Commented] (FLINK-8217) Properly annotate APIs of flink-connector-kinesis
[ https://issues.apache.org/jira/browse/FLINK-8217?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16284616#comment-16284616 ] ASF GitHub Bot commented on FLINK-8217: --- Github user bowenli86 commented on the issue: https://github.com/apache/flink/pull/5138 @greghogan this is a subtask of FLINK-8192. @tzulitai What do you think of having a FLIP to FLINK-8192? > Properly annotate APIs of flink-connector-kinesis > - > > Key: FLINK-8217 > URL: https://issues.apache.org/jira/browse/FLINK-8217 > Project: Flink > Issue Type: Sub-task > Components: Kinesis Connector >Affects Versions: 1.5.0 >Reporter: Bowen Li >Assignee: Bowen Li > Fix For: 1.5.0 > > -- This message was sent by Atlassian JIRA (v6.4.14#64029)
