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

Joe Witt commented on NIFI-14284:
---------------------------------

Be careful.  There are a lot of claims about conventions but they're not always 
true...

People using this component rely on the fact that the 'name' is 
"amazon-kinesis-stream-failover-timeout" while the display name we show can be 
literally anything.

For NEW property descriptors the name/displayname can match - sure.  But we're 
not going around to change others.  The reason they're different is because 
displayName can evolve while name really cannot.



....However....we do now have a concept of property migration (which we did not 
before) so we have additional ways to approach this as we progress.  But net of 
this is - we dont need to change this.

> ConsumeKinesisStream props name convention update
> -------------------------------------------------
>
>                 Key: NIFI-14284
>                 URL: https://issues.apache.org/jira/browse/NIFI-14284
>             Project: Apache NiFi
>          Issue Type: Improvement
>          Components: Extensions
>    Affects Versions: 2.2.0
>            Reporter: Dariusz Seweryn
>            Priority: Trivial
>
> The ConsumeKinesisStream processor contains properties which names use the 
> previous convention, like:
> ```
> public static final PropertyDescriptor FAILOVER_TIMEOUT = new 
> PropertyDescriptor.Builder()
> .displayName("Failover Timeout")
> .name("amazon-kinesis-stream-failover-timeout")
> .description("Kinesis Client Library failover timeout")
> .addValidator(StandardValidators.TIME_PERIOD_VALIDATOR)
> .defaultValue("30 secs")
> .required(true).build();
> ```
>  
> The current convention is to have `displayName` and `name` to be equal. All 
> properties in the class could be updated.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

Reply via email to