gnodet-bot commented on code in PR #29991:
URL: https://github.com/apache/camel/pull/29991#discussion_r4576114160
##########
components/camel-alibaba/camel-alibaba-ots/src/main/java/org/apache/camel/component/alibaba/ots/AlibabaOtsEndpoint.java:
##########
@@ -60,33 +60,50 @@
+ " listTables gives a List
of the table names"))
public class AlibabaOtsEndpoint extends DefaultEndpoint {
- @UriPath(description = "Operation to perform", displayName = "Operation",
label = "producer",
- enums = "putRow,getRow,updateRow,deleteRow,listTables")
+ @UriPath(description = "The operation that the producer performs. The
CamelAlibabaOtsOperation header replaces this option"
+ + " for a request that the producer sends. If that
header is not set, an exchange property of the"
+ + " same name replaces this option.",
+ displayName = "Operation", label = "producer", enums =
"putRow,getRow,updateRow,deleteRow,listTables")
@Metadata(required = true)
private String operation;
- @UriParam(description = "Tablestore endpoint URL", displayName =
"Endpoint")
+ @UriParam(description = "The endpoint of the Tablestore instance, which
starts with http:// or https://, for example"
+ + "
https://my-instance.cn-hangzhou.ots.aliyuncs.com. Not used when the otsClient
option is set or"
+ + " autowired.",
+ displayName = "Endpoint")
@Metadata(required = true)
private String endpoint;
- @UriParam(description = "Tablestore instance name", displayName =
"Instance Name")
+ @UriParam(description = "The name of the Tablestore instance. Not used
when the otsClient option is set or autowired.",
+ displayName = "Instance Name")
@Metadata(required = true)
private String instanceName;
- @UriParam(description = "Access key for the cloud user", displayName =
"Access Key", security = "secret",
- label = "security")
+ @UriParam(description = "The AccessKey ID of the AccessKey pair for the
requests that the producer sends to Tablestore. If"
+ + " not set, the accessKey of the serviceKeys
option is used, and one of the two is required. Not"
+ + " used when the otsClient option is set or
autowired.",
+ displayName = "Access Key", security = "secret", label =
"security")
private String accessKey;
- @UriParam(description = "Secret key for the cloud user", displayName =
"Secret Key", security = "secret",
- label = "security")
+ @UriParam(description = "The AccessKey secret of the AccessKey pair for
the requests that the producer sends to Tablestore."
+ + " If not set, the secretKey of the serviceKeys
option is used, and one of the two is required."
+ + " Not used when the otsClient option is set or
autowired.",
+ displayName = "Secret Key", security = "secret", label =
"security")
private String secretKey;
- @UriParam(description = "Configuration object for cloud service
authentication", displayName = "Service Keys",
- security = "secret", label = "security")
+ @UriParam(description = "The AccessKey pair as an
org.apache.camel.component.alibaba.common.models.ServiceKeys, whose"
+ + " accessKey is the AccessKey ID and whose
secretKey is the AccessKey secret. Each of the two is"
+ + " used when the option of the same name is not
set. Not used when the otsClient option is set or"
+ + " autowired.",
+ displayName = "Service Keys", security = "secret", label =
"security")
private ServiceKeys serviceKeys;
- @UriParam(description = "Autowire an existing Tablestore client instance",
displayName = "OTS Client",
- label = "advanced")
+ @UriParam(description = "To use a custom
com.alicloud.openservices.tablestore.SyncClient. The producer sends its
requests"
+ + " with this client, and the endpoint,
instanceName, accessKey, secretKey and serviceKeys options"
+ + " are not used. The Camel endpoint does not shut
down a client that is set or autowired. If no"
+ + " client is set or autowired, the Camel endpoint
creates a SyncClient from these options when the"
Review Comment:
📝 **STE style (low):** The last sentence (starting "If no client is set...")
is 36 words. Consider splitting at the lifecycle boundary:
```suggestion
@UriParam(description = "To use a custom
com.alicloud.openservices.tablestore.SyncClient. The"
+ " producer sends its requests with this
client, and the endpoint, instanceName, accessKey, secretKey and serviceKeys
options"
+ " are not used. The Camel endpoint does not
shut down a client that is set or autowired. If no client is set or autowired,"
+ " the Camel endpoint creates a SyncClient on
the first message and shuts it down when the endpoint stops.",
displayName = "OTS Client", label = "advanced")
```
##########
components/camel-alibaba/camel-alibaba-ots/src/main/java/org/apache/camel/component/alibaba/ots/AlibabaOtsEndpoint.java:
##########
@@ -60,33 +60,50 @@
+ " listTables gives a List
of the table names"))
public class AlibabaOtsEndpoint extends DefaultEndpoint {
- @UriPath(description = "Operation to perform", displayName = "Operation",
label = "producer",
- enums = "putRow,getRow,updateRow,deleteRow,listTables")
+ @UriPath(description = "The operation that the producer performs. The
CamelAlibabaOtsOperation header replaces this option"
+ + " for a request that the producer sends. If that
header is not set, an exchange property of the"
+ + " same name replaces this option.",
+ displayName = "Operation", label = "producer", enums =
"putRow,getRow,updateRow,deleteRow,listTables")
@Metadata(required = true)
private String operation;
- @UriParam(description = "Tablestore endpoint URL", displayName =
"Endpoint")
+ @UriParam(description = "The endpoint of the Tablestore instance, which
starts with http:// or https://, for example"
+ + "
https://my-instance.cn-hangzhou.ots.aliyuncs.com. Not used when the otsClient
option is set or"
+ + " autowired.",
+ displayName = "Endpoint")
@Metadata(required = true)
private String endpoint;
- @UriParam(description = "Tablestore instance name", displayName =
"Instance Name")
+ @UriParam(description = "The name of the Tablestore instance. Not used
when the otsClient option is set or autowired.",
+ displayName = "Instance Name")
@Metadata(required = true)
private String instanceName;
- @UriParam(description = "Access key for the cloud user", displayName =
"Access Key", security = "secret",
- label = "security")
+ @UriParam(description = "The AccessKey ID of the AccessKey pair for the
requests that the producer sends to Tablestore. If"
+ + " not set, the accessKey of the serviceKeys
option is used, and one of the two is required. Not"
+ + " used when the otsClient option is set or
autowired.",
+ displayName = "Access Key", security = "secret", label =
"security")
private String accessKey;
- @UriParam(description = "Secret key for the cloud user", displayName =
"Secret Key", security = "secret",
- label = "security")
+ @UriParam(description = "The AccessKey secret of the AccessKey pair for
the requests that the producer sends to Tablestore."
+ + " If not set, the secretKey of the serviceKeys
option is used, and one of the two is required."
+ + " Not used when the otsClient option is set or
autowired.",
+ displayName = "Secret Key", security = "secret", label =
"security")
private String secretKey;
- @UriParam(description = "Configuration object for cloud service
authentication", displayName = "Service Keys",
- security = "secret", label = "security")
+ @UriParam(description = "The AccessKey pair as an
org.apache.camel.component.alibaba.common.models.ServiceKeys, whose"
+ + " accessKey is the AccessKey ID and whose
secretKey is the AccessKey secret. Each of the two is"
+ + " used when the option of the same name is not
set. Not used when the otsClient option is set or"
+ + " autowired.",
Review Comment:
📝 **STE style (low):** The first sentence is 34 words, exceeding the 25-word
guideline. The fully-qualified class name makes it long — consider splitting
after the class name:
```suggestion
@UriParam(description = "The accessKey and secretKey of the AccessKey
pair, held in a ServiceKeys object
(org.apache.camel.component.alibaba.common.models.ServiceKeys)."
+ " Each is used as a fallback when the option
of the same name is not set. Not used when the otsClient option is set or"
+ " autowired.",
displayName = "Service Keys", security = "secret", label =
"security")
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
