saravanakumar1987 commented on code in PR #30602:
URL: https://github.com/apache/camel/pull/30602#discussion_r4658777410
##########
components/camel-alibaba/camel-alibaba-oss/src/main/java/org/apache/camel/component/alibaba/oss/OSSEndpoint.java:
##########
@@ -68,51 +68,78 @@
+ " listObjects and
listBuckets a List of a Map per object or bucket"))
public class OSSEndpoint extends ScheduledPollEndpoint {
- @UriPath(description = "Name of bucket to perform operation on",
displayName = "Bucket Name")
+ @UriPath(description = "The name of the bucket, or of the destination
bucket for copyObject. The CamelAlibabaOssBucketName"
+ + " exchange property replaces this option for the
producer, and a header of the same name replaces"
+ + " both.",
+ displayName = "Bucket Name")
private String bucketName;
- @UriParam(description = "Operation to be performed", displayName =
"Operation", label = "producer",
+ @UriParam(description = "The operation that the producer performs. The
CamelAlibabaOssOperation exchange property replaces"
+ + " this option, and a header of the same name
replaces both.",
+ displayName = "Operation", label = "producer",
enums =
"listBuckets,listObjects,putObject,getObject,deleteObject,copyObject,headObject")
private String operation;
- @UriParam(description = "OSS service region", displayName = "Service
region")
+ @UriParam(description = "The region ID of Object Storage Service, for
example cn-hangzhou. The SDK uses it to sign"
+ + " requests, and to build the endpoint when the
endpoint option is not set.",
+ displayName = "Service region")
@Metadata(required = true)
private String region;
- @UriParam(description = "OSS endpoint URL. Carries higher precedence than
region based client initialization",
+ @UriParam(description = "The endpoint of Object Storage Service, for
example oss-cn-hangzhou.aliyuncs.com. If not set, the"
+ + " SDK builds it from the region option.",
displayName = "Endpoint url")
private String endpoint;
- @UriParam(description = "Configuration object for cloud service
authentication", displayName = "Service Configuration",
+ @UriParam(description = "The AccessKey pair as an
org.apache.camel.component.alibaba.common.models.ServiceKeys. Its"
+ + " accessKey and its secretKey are each used when
the option of the same name is not set.",
+ displayName = "Service Configuration",
security = "secret", label = "security")
private ServiceKeys serviceKeys;
- @UriParam(description = "Access key for the cloud user", displayName =
"API access key (AK)", security = "secret",
+ @UriParam(description = "The AccessKey ID of the AccessKey pair for Object
Storage Service. If not set, the accessKey of"
+ + " the serviceKeys option is used.",
+ displayName = "API access key (AK)", security = "secret",
label = "security")
@Metadata(required = true)
private String accessKey;
- @UriParam(description = "Secret key for the cloud user", displayName =
"API secret key (SK)", security = "secret",
+ @UriParam(description = "The AccessKey secret of the AccessKey pair for
Object Storage Service. If not set, the secretKey"
+ + " of the serviceKeys option is used.",
+ displayName = "API secret key (SK)", security = "secret",
label = "security")
@Metadata(required = true)
private String secretKey;
- @UriParam(description = "Name of object to perform operation with",
displayName = "Object Name")
+ @UriParam(description = "The name of the object for the producer, or of
the destination object for copyObject. The"
+ + " CamelAlibabaOssObjectName exchange property
replaces this option, and a header of the same name"
+ + " replaces both.",
+ displayName = "Object Name")
private String objectName;
- @UriParam(description = "The object name prefix used for filtering objects
to be listed", displayName = "Prefix",
+ @UriParam(description = "The prefix of the names of the objects to list,
for the consumer and for listObjects. The"
+ + " CamelAlibabaOssPrefix exchange property
replaces this option for the producer, and a header of"
+ + " the same name replaces both.",
Review Comment:
Not changed in this pull request, because `tasks/component-descriptions.md`
limits it to description text. The description reports the label, and
[CAMEL-27388](https://issues.apache.org/jira/browse/CAMEL-27388) covers the
fix. `consumer,producer` would not help here. The Endpoint DSL generator leaves
out an option that has both labels. `maxKeys` has both today, and
`OSSEndpointBuilderFactory` has no method for it. `prefix` needs no label, as
both sides read it.
_Claude Code on behalf of saravanakumar1987_
##########
components/camel-alibaba/camel-alibaba-oss/src/main/java/org/apache/camel/component/alibaba/oss/OSSEndpoint.java:
##########
@@ -68,51 +68,78 @@
+ " listObjects and
listBuckets a List of a Map per object or bucket"))
public class OSSEndpoint extends ScheduledPollEndpoint {
- @UriPath(description = "Name of bucket to perform operation on",
displayName = "Bucket Name")
+ @UriPath(description = "The name of the bucket, or of the destination
bucket for copyObject. The CamelAlibabaOssBucketName"
+ + " exchange property replaces this option for the
producer, and a header of the same name replaces"
+ + " both.",
+ displayName = "Bucket Name")
private String bucketName;
- @UriParam(description = "Operation to be performed", displayName =
"Operation", label = "producer",
+ @UriParam(description = "The operation that the producer performs. The
CamelAlibabaOssOperation exchange property replaces"
+ + " this option, and a header of the same name
replaces both.",
+ displayName = "Operation", label = "producer",
enums =
"listBuckets,listObjects,putObject,getObject,deleteObject,copyObject,headObject")
private String operation;
- @UriParam(description = "OSS service region", displayName = "Service
region")
+ @UriParam(description = "The region ID of Object Storage Service, for
example cn-hangzhou. The SDK uses it to sign"
+ + " requests, and to build the endpoint when the
endpoint option is not set.",
+ displayName = "Service region")
@Metadata(required = true)
private String region;
- @UriParam(description = "OSS endpoint URL. Carries higher precedence than
region based client initialization",
+ @UriParam(description = "The endpoint of Object Storage Service, for
example oss-cn-hangzhou.aliyuncs.com. If not set, the"
+ + " SDK builds it from the region option.",
displayName = "Endpoint url")
private String endpoint;
- @UriParam(description = "Configuration object for cloud service
authentication", displayName = "Service Configuration",
+ @UriParam(description = "The AccessKey pair as an
org.apache.camel.component.alibaba.common.models.ServiceKeys. Its"
+ + " accessKey and its secretKey are each used when
the option of the same name is not set.",
Review Comment:
Kept as it is. It is the `serviceKeys` sentence of camel-alibaba-mns, which
#30563 settled after a review. The other six Alibaba components say "is used"
too, so the eight components use the same term.
_Claude Code on behalf of saravanakumar1987_
--
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]