This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new 27bdc47fee8e CAMEL-23832: camel-alibaba-fc - improve option
descriptions (#30004)
27bdc47fee8e is described below
commit 27bdc47fee8e116f240544f082226bab99264e45
Author: Saravanakumar Selvaraj <[email protected]>
AuthorDate: Sun Nov 15 15:04:35 2026 +0000
CAMEL-23832: camel-alibaba-fc - improve option descriptions (#30004)
New texts for 10 endpoint options and 5 headers, checked against the Camel
code and the FC-Open SDK for Java 2.1.0
sources. The old texts did not say which header and exchange property
replace operation, serviceName, functionName and
qualifier, when region is used, that endpoint is a host name without
http:// or https://, which options fcClient makes
unused, or who sets the request ID and status code headers. qualifier is
now the version or alias of the service, as in
the Function Compute 2.0 API, and accessKey, secretKey and serviceKeys use
the terms AccessKey ID and AccessKey secret.
Documentation only, no behavior change. The component JSON, the catalog
copy and the DSL are regenerated.
Co-Authored-By: Claude Opus 5.5 <[email protected]>
---
.../camel/catalog/components/alibaba-fc.json | 30 +++----
.../camel/component/alibaba/fc/alibaba-fc.json | 30 +++----
.../camel/component/alibaba/fc/FCEndpoint.java | 56 +++++++++----
.../component/alibaba/fc/constants/FCHeaders.java | 26 ++++--
.../builder/endpoint/StaticEndpointBuilders.java | 10 ++-
.../endpoint/dsl/FCEndpointBuilderFactory.java | 92 +++++++++++++++++-----
6 files changed, 174 insertions(+), 70 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/alibaba-fc.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/alibaba-fc.json
index 15c1cdb2f2ce..4506845b3eeb 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/alibaba-fc.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/alibaba-fc.json
@@ -30,27 +30,27 @@
"healthCheckProducerEnabled": { "index": 3, "kind": "property",
"displayName": "Health Check Producer Enabled", "group": "health", "label":
"health", "required": false, "type": "boolean", "javaType": "boolean",
"deprecated": false, "autowired": false, "secret": false, "defaultValue": true,
"description": "Used for enabling or disabling all producer based health checks
from this component. Notice: Camel has by default disabled all producer based
health-checks. You can turn on producer [...]
},
"headers": {
- "CamelAlibabaFcServiceName": { "index": 0, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "FC service name override", "constantName":
"org.apache.camel.component.alibaba.fc.constants.FCHeaders#SERVICE_NAME" },
- "CamelAlibabaFcFunctionName": { "index": 1, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "FC function name override", "constantName":
"org.apache.camel.component.alibaba.fc.constants.FCHeaders#FUNCTION_NAME" },
- "CamelAlibabaFcQualifier": { "index": 2, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "Function qualifier override", "constantName":
"org.apache.camel.component.alibaba.fc.constants.FCHeaders#QUALIFIER" },
- "CamelAlibabaFcRequestId": { "index": 3, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "Alibaba Cloud request id", "constantName":
"org.apache.camel.component.alibaba.fc.constants.FCHeaders#REQUEST_ID" },
- "CamelAlibabaFcStatusCode": { "index": 4, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"Integer", "deprecated": false, "autowired": false, "secret": false,
"description": "HTTP status code from FC invoke response", "constantName":
"org.apache.camel.component.alibaba.fc.constants.FCHeaders#STATUS_CODE" }
+ "CamelAlibabaFcServiceName": { "index": 0, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "The name of the service that contains the function. This header
replaces the serviceName option. If this header is not set, an exchange
property of the same name replaces the serviceName option.", "constantName":
"org.apache.camel.component.alibaba.fc [...]
+ "CamelAlibabaFcFunctionName": { "index": 1, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "The name of the function. This header replaces the functionName
option. If this header is not set, an exchange property of the same name
replaces the functionName option.", "constantName":
"org.apache.camel.component.alibaba.fc.constants.FCHeaders#FU [...]
+ "CamelAlibabaFcQualifier": { "index": 2, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The version or alias of the service. This header replaces the
qualifier option. If this header is not set, an exchange property of the same
name replaces the qualifier option.", "constantName":
"org.apache.camel.component.alibaba.fc.constants.FCHeaders# [...]
+ "CamelAlibabaFcRequestId": { "index": 3, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The request ID that Function Compute returns in the response to
invokeFunction. The producer sets it for invokeFunction, unless the exchange
fails.", "constantName":
"org.apache.camel.component.alibaba.fc.constants.FCHeaders#REQUEST_ID" },
+ "CamelAlibabaFcStatusCode": { "index": 4, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"Integer", "deprecated": false, "autowired": false, "secret": false,
"description": "The HTTP status code of the response to the operation. The
producer sets it, unless the exchange fails.", "constantName":
"org.apache.camel.component.alibaba.fc.constants.FCHeaders#STATUS_CODE" }
},
"bodyTypes": {
"producerIn": { "carriers": [ "any" ], "byOption": [ { "option":
"operation", "value": "invokeFunction", "carriers": [ "text", "bytes",
"stream", "file", "null" ] } ], "description": "invokeFunction sends the body
as the payload of the function: text in UTF-8, bytes as they are, a stream or a
file as its bytes, so binary data is kept, and no body as an empty payload. A
Map or a POJO fails, as it does not convert to bytes, so marshal it first.
getFunction does not use the body" },
"producerOut": { "carriers": [ "map" ], "javaType": "java.util.Map",
"description": "A Map: for invokeFunction the statusCode, the headers and the
body of the response, which holds the payload the function returns as bytes,
with the status code in the CamelAlibabaFcStatusCode header too; for
getFunction the fields of the function, such as functionName, runtime and
handler" }
},
"properties": {
- "operation": { "index": 0, "kind": "path", "displayName": "Operation",
"group": "producer", "label": "producer", "required": true, "type": "enum",
"javaType": "java.lang.String", "enum": [ "invokeFunction", "getFunction" ],
"deprecated": false, "autowired": false, "secret": false, "description":
"Operation to perform" },
- "endpoint": { "index": 1, "kind": "parameter", "displayName": "Endpoint",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "FC endpoint URL. Carries higher precedence
than region based client initialization" },
- "functionName": { "index": 2, "kind": "parameter", "displayName":
"Function Name", "group": "producer", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "FC function name" },
- "qualifier": { "index": 3, "kind": "parameter", "displayName":
"Qualifier", "group": "producer", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "Function version or alias qualifier" },
- "region": { "index": 4, "kind": "parameter", "displayName": "Region",
"group": "producer", "label": "", "required": true, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Alibaba Cloud region" },
- "serviceName": { "index": 5, "kind": "parameter", "displayName": "Service
Name", "group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "FC service name" },
+ "operation": { "index": 0, "kind": "path", "displayName": "Operation",
"group": "producer", "label": "producer", "required": true, "type": "enum",
"javaType": "java.lang.String", "enum": [ "invokeFunction", "getFunction" ],
"deprecated": false, "autowired": false, "secret": false, "description": "The
operation that the producer performs. The CamelAlibabaFcOperation header
replaces this option for a request that the producer sends. If that header is
not set, an exchange property of th [...]
+ "endpoint": { "index": 1, "kind": "parameter", "displayName": "Endpoint",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The endpoint of Function Compute, which is a
host name without http:\/\/ or https:\/\/. The producer sends requests to it
over HTTPS. If not set, the region option determines the endpoint, and one of
the two is required. Not used when th [...]
+ "functionName": { "index": 2, "kind": "parameter", "displayName":
"Function Name", "group": "producer", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "The name of the function. The
CamelAlibabaFcFunctionName 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. One of the three [...]
+ "qualifier": { "index": 3, "kind": "parameter", "displayName":
"Qualifier", "group": "producer", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "The version or alias of the service.
The CamelAlibabaFcQualifier 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. If none of the t [...]
+ "region": { "index": 4, "kind": "parameter", "displayName": "Region",
"group": "producer", "label": "", "required": true, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The region ID of Function Compute, for example
cn-hangzhou. Only used when the endpoint option is not set, to build the
endpoint of Function Compute. Not used when the fcClient option is set or
autowired." },
+ "serviceName": { "index": 5, "kind": "parameter", "displayName": "Service
Name", "group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The name of the service that contains the
function. The CamelAlibabaFcServiceName 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 op [...]
"lazyStartProducer": { "index": 6, "kind": "parameter", "displayName":
"Lazy Start Producer", "group": "producer (advanced)", "label":
"producer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "Whether the producer should be started
lazy (on the first message). By starting lazy you can use this to allow
CamelContext and routes to startup in situations where a produc [...]
- "fcClient": { "index": 7, "kind": "parameter", "displayName": "FC Client",
"group": "advanced", "label": "advanced", "required": false, "type": "object",
"javaType": "com.aliyun.fc_open20210406.Client", "deprecated": false,
"autowired": true, "secret": false, "description": "Autowire an existing FC
client instance" },
- "accessKey": { "index": 8, "kind": "parameter", "displayName": "Access
Key", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "security": "secret", "description": "Access key for the
cloud user" },
- "secretKey": { "index": 9, "kind": "parameter", "displayName": "Secret
Key", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "security": "secret", "description": "Secret key for the
cloud user" },
- "serviceKeys": { "index": 10, "kind": "parameter", "displayName": "Service
Keys", "group": "security", "label": "security", "required": false, "type":
"object", "javaType":
"org.apache.camel.component.alibaba.common.models.ServiceKeys", "deprecated":
false, "autowired": false, "secret": true, "security": "secret", "description":
"Configuration object for cloud service authentication" }
+ "fcClient": { "index": 7, "kind": "parameter", "displayName": "FC Client",
"group": "advanced", "label": "advanced", "required": false, "type": "object",
"javaType": "com.aliyun.fc_open20210406.Client", "deprecated": false,
"autowired": true, "secret": false, "description": "To use a custom
com.aliyun.fc_open20210406.Client. The producer sends its requests with this
client, and the region, endpoint, accessKey, secretKey and serviceKeys options
are not used. If no client is set or aut [...]
+ "accessKey": { "index": 8, "kind": "parameter", "displayName": "Access
Key", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "security": "secret", "description": "The AccessKey ID
of the AccessKey pair for the requests that the producer sends to Function
Compute. If not set, the accessKey of the serviceKeys option is used, and one
of the two is required. Not used wh [...]
+ "secretKey": { "index": 9, "kind": "parameter", "displayName": "Secret
Key", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "security": "secret", "description": "The AccessKey
secret of the AccessKey pair for the requests that the producer sends to
Function Compute. If not set, the secretKey of the serviceKeys option is used,
and one of the two is required. Not use [...]
+ "serviceKeys": { "index": 10, "kind": "parameter", "displayName": "Service
Keys", "group": "security", "label": "security", "required": false, "type":
"object", "javaType":
"org.apache.camel.component.alibaba.common.models.ServiceKeys", "deprecated":
false, "autowired": false, "secret": true, "security": "secret", "description":
"The AccessKey pair as an
org.apache.camel.component.alibaba.common.models.ServiceKeys. Its accessKey is
the AccessKey ID and its secretKey is the AccessKey [...]
}
}
diff --git
a/components/camel-alibaba/camel-alibaba-fc/src/generated/resources/META-INF/org/apache/camel/component/alibaba/fc/alibaba-fc.json
b/components/camel-alibaba/camel-alibaba-fc/src/generated/resources/META-INF/org/apache/camel/component/alibaba/fc/alibaba-fc.json
index 15c1cdb2f2ce..4506845b3eeb 100644
---
a/components/camel-alibaba/camel-alibaba-fc/src/generated/resources/META-INF/org/apache/camel/component/alibaba/fc/alibaba-fc.json
+++
b/components/camel-alibaba/camel-alibaba-fc/src/generated/resources/META-INF/org/apache/camel/component/alibaba/fc/alibaba-fc.json
@@ -30,27 +30,27 @@
"healthCheckProducerEnabled": { "index": 3, "kind": "property",
"displayName": "Health Check Producer Enabled", "group": "health", "label":
"health", "required": false, "type": "boolean", "javaType": "boolean",
"deprecated": false, "autowired": false, "secret": false, "defaultValue": true,
"description": "Used for enabling or disabling all producer based health checks
from this component. Notice: Camel has by default disabled all producer based
health-checks. You can turn on producer [...]
},
"headers": {
- "CamelAlibabaFcServiceName": { "index": 0, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "FC service name override", "constantName":
"org.apache.camel.component.alibaba.fc.constants.FCHeaders#SERVICE_NAME" },
- "CamelAlibabaFcFunctionName": { "index": 1, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "FC function name override", "constantName":
"org.apache.camel.component.alibaba.fc.constants.FCHeaders#FUNCTION_NAME" },
- "CamelAlibabaFcQualifier": { "index": 2, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "Function qualifier override", "constantName":
"org.apache.camel.component.alibaba.fc.constants.FCHeaders#QUALIFIER" },
- "CamelAlibabaFcRequestId": { "index": 3, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "Alibaba Cloud request id", "constantName":
"org.apache.camel.component.alibaba.fc.constants.FCHeaders#REQUEST_ID" },
- "CamelAlibabaFcStatusCode": { "index": 4, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"Integer", "deprecated": false, "autowired": false, "secret": false,
"description": "HTTP status code from FC invoke response", "constantName":
"org.apache.camel.component.alibaba.fc.constants.FCHeaders#STATUS_CODE" }
+ "CamelAlibabaFcServiceName": { "index": 0, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "The name of the service that contains the function. This header
replaces the serviceName option. If this header is not set, an exchange
property of the same name replaces the serviceName option.", "constantName":
"org.apache.camel.component.alibaba.fc [...]
+ "CamelAlibabaFcFunctionName": { "index": 1, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "The name of the function. This header replaces the functionName
option. If this header is not set, an exchange property of the same name
replaces the functionName option.", "constantName":
"org.apache.camel.component.alibaba.fc.constants.FCHeaders#FU [...]
+ "CamelAlibabaFcQualifier": { "index": 2, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The version or alias of the service. This header replaces the
qualifier option. If this header is not set, an exchange property of the same
name replaces the qualifier option.", "constantName":
"org.apache.camel.component.alibaba.fc.constants.FCHeaders# [...]
+ "CamelAlibabaFcRequestId": { "index": 3, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The request ID that Function Compute returns in the response to
invokeFunction. The producer sets it for invokeFunction, unless the exchange
fails.", "constantName":
"org.apache.camel.component.alibaba.fc.constants.FCHeaders#REQUEST_ID" },
+ "CamelAlibabaFcStatusCode": { "index": 4, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"Integer", "deprecated": false, "autowired": false, "secret": false,
"description": "The HTTP status code of the response to the operation. The
producer sets it, unless the exchange fails.", "constantName":
"org.apache.camel.component.alibaba.fc.constants.FCHeaders#STATUS_CODE" }
},
"bodyTypes": {
"producerIn": { "carriers": [ "any" ], "byOption": [ { "option":
"operation", "value": "invokeFunction", "carriers": [ "text", "bytes",
"stream", "file", "null" ] } ], "description": "invokeFunction sends the body
as the payload of the function: text in UTF-8, bytes as they are, a stream or a
file as its bytes, so binary data is kept, and no body as an empty payload. A
Map or a POJO fails, as it does not convert to bytes, so marshal it first.
getFunction does not use the body" },
"producerOut": { "carriers": [ "map" ], "javaType": "java.util.Map",
"description": "A Map: for invokeFunction the statusCode, the headers and the
body of the response, which holds the payload the function returns as bytes,
with the status code in the CamelAlibabaFcStatusCode header too; for
getFunction the fields of the function, such as functionName, runtime and
handler" }
},
"properties": {
- "operation": { "index": 0, "kind": "path", "displayName": "Operation",
"group": "producer", "label": "producer", "required": true, "type": "enum",
"javaType": "java.lang.String", "enum": [ "invokeFunction", "getFunction" ],
"deprecated": false, "autowired": false, "secret": false, "description":
"Operation to perform" },
- "endpoint": { "index": 1, "kind": "parameter", "displayName": "Endpoint",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "FC endpoint URL. Carries higher precedence
than region based client initialization" },
- "functionName": { "index": 2, "kind": "parameter", "displayName":
"Function Name", "group": "producer", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "FC function name" },
- "qualifier": { "index": 3, "kind": "parameter", "displayName":
"Qualifier", "group": "producer", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "Function version or alias qualifier" },
- "region": { "index": 4, "kind": "parameter", "displayName": "Region",
"group": "producer", "label": "", "required": true, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Alibaba Cloud region" },
- "serviceName": { "index": 5, "kind": "parameter", "displayName": "Service
Name", "group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "FC service name" },
+ "operation": { "index": 0, "kind": "path", "displayName": "Operation",
"group": "producer", "label": "producer", "required": true, "type": "enum",
"javaType": "java.lang.String", "enum": [ "invokeFunction", "getFunction" ],
"deprecated": false, "autowired": false, "secret": false, "description": "The
operation that the producer performs. The CamelAlibabaFcOperation header
replaces this option for a request that the producer sends. If that header is
not set, an exchange property of th [...]
+ "endpoint": { "index": 1, "kind": "parameter", "displayName": "Endpoint",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The endpoint of Function Compute, which is a
host name without http:\/\/ or https:\/\/. The producer sends requests to it
over HTTPS. If not set, the region option determines the endpoint, and one of
the two is required. Not used when th [...]
+ "functionName": { "index": 2, "kind": "parameter", "displayName":
"Function Name", "group": "producer", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "The name of the function. The
CamelAlibabaFcFunctionName 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. One of the three [...]
+ "qualifier": { "index": 3, "kind": "parameter", "displayName":
"Qualifier", "group": "producer", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "The version or alias of the service.
The CamelAlibabaFcQualifier 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. If none of the t [...]
+ "region": { "index": 4, "kind": "parameter", "displayName": "Region",
"group": "producer", "label": "", "required": true, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The region ID of Function Compute, for example
cn-hangzhou. Only used when the endpoint option is not set, to build the
endpoint of Function Compute. Not used when the fcClient option is set or
autowired." },
+ "serviceName": { "index": 5, "kind": "parameter", "displayName": "Service
Name", "group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The name of the service that contains the
function. The CamelAlibabaFcServiceName 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 op [...]
"lazyStartProducer": { "index": 6, "kind": "parameter", "displayName":
"Lazy Start Producer", "group": "producer (advanced)", "label":
"producer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "Whether the producer should be started
lazy (on the first message). By starting lazy you can use this to allow
CamelContext and routes to startup in situations where a produc [...]
- "fcClient": { "index": 7, "kind": "parameter", "displayName": "FC Client",
"group": "advanced", "label": "advanced", "required": false, "type": "object",
"javaType": "com.aliyun.fc_open20210406.Client", "deprecated": false,
"autowired": true, "secret": false, "description": "Autowire an existing FC
client instance" },
- "accessKey": { "index": 8, "kind": "parameter", "displayName": "Access
Key", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "security": "secret", "description": "Access key for the
cloud user" },
- "secretKey": { "index": 9, "kind": "parameter", "displayName": "Secret
Key", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "security": "secret", "description": "Secret key for the
cloud user" },
- "serviceKeys": { "index": 10, "kind": "parameter", "displayName": "Service
Keys", "group": "security", "label": "security", "required": false, "type":
"object", "javaType":
"org.apache.camel.component.alibaba.common.models.ServiceKeys", "deprecated":
false, "autowired": false, "secret": true, "security": "secret", "description":
"Configuration object for cloud service authentication" }
+ "fcClient": { "index": 7, "kind": "parameter", "displayName": "FC Client",
"group": "advanced", "label": "advanced", "required": false, "type": "object",
"javaType": "com.aliyun.fc_open20210406.Client", "deprecated": false,
"autowired": true, "secret": false, "description": "To use a custom
com.aliyun.fc_open20210406.Client. The producer sends its requests with this
client, and the region, endpoint, accessKey, secretKey and serviceKeys options
are not used. If no client is set or aut [...]
+ "accessKey": { "index": 8, "kind": "parameter", "displayName": "Access
Key", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "security": "secret", "description": "The AccessKey ID
of the AccessKey pair for the requests that the producer sends to Function
Compute. If not set, the accessKey of the serviceKeys option is used, and one
of the two is required. Not used wh [...]
+ "secretKey": { "index": 9, "kind": "parameter", "displayName": "Secret
Key", "group": "security", "label": "security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "security": "secret", "description": "The AccessKey
secret of the AccessKey pair for the requests that the producer sends to
Function Compute. If not set, the secretKey of the serviceKeys option is used,
and one of the two is required. Not use [...]
+ "serviceKeys": { "index": 10, "kind": "parameter", "displayName": "Service
Keys", "group": "security", "label": "security", "required": false, "type":
"object", "javaType":
"org.apache.camel.component.alibaba.common.models.ServiceKeys", "deprecated":
false, "autowired": false, "secret": true, "security": "secret", "description":
"The AccessKey pair as an
org.apache.camel.component.alibaba.common.models.ServiceKeys. Its accessKey is
the AccessKey ID and its secretKey is the AccessKey [...]
}
}
diff --git
a/components/camel-alibaba/camel-alibaba-fc/src/main/java/org/apache/camel/component/alibaba/fc/FCEndpoint.java
b/components/camel-alibaba/camel-alibaba-fc/src/main/java/org/apache/camel/component/alibaba/fc/FCEndpoint.java
index 776bc2dd754a..5b2d47bb05de 100644
---
a/components/camel-alibaba/camel-alibaba-fc/src/main/java/org/apache/camel/component/alibaba/fc/FCEndpoint.java
+++
b/components/camel-alibaba/camel-alibaba-fc/src/main/java/org/apache/camel/component/alibaba/fc/FCEndpoint.java
@@ -55,41 +55,69 @@ import org.apache.camel.support.DefaultEndpoint;
+ " and handler"))
public class FCEndpoint extends DefaultEndpoint {
- @UriPath(description = "Operation to perform", displayName = "Operation",
label = "producer",
- enums = "invokeFunction,getFunction")
+ @UriPath(description = "The operation that the producer performs. The
CamelAlibabaFcOperation 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 =
"invokeFunction,getFunction")
@Metadata(required = true)
private String operation;
- @UriParam(description = "Alibaba Cloud region", displayName = "Region")
+ @UriParam(description = "The region ID of Function Compute, for example
cn-hangzhou. Only used when the endpoint option is"
+ + " not set, to build the endpoint of Function
Compute. Not used when the fcClient option is set or"
+ + " autowired.",
+ displayName = "Region")
@Metadata(required = true)
private String region;
- @UriParam(description = "FC endpoint URL. Carries higher precedence than
region based client initialization",
+ @UriParam(description = "The endpoint of Function Compute, which is a host
name without http:// or https://. The producer"
+ + " sends requests to it over HTTPS. If not set,
the region option determines the endpoint, and one"
+ + " of the two is required. Not used when the
fcClient option is set or autowired.",
displayName = "Endpoint")
private String endpoint;
- @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 Function"
+ + " Compute. If not set, the accessKey of the
serviceKeys option is used, and one of the two is"
+ + " required. Not used when the fcClient 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 Function"
+ + " Compute. If not set, the secretKey of the
serviceKeys option is used, and one of the two is"
+ + " required. Not used when the fcClient 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. Its"
+ + " accessKey is the AccessKey ID and its
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 fcClient option is set or"
+ + " autowired.",
+ displayName = "Service Keys", security = "secret", label =
"security")
private ServiceKeys serviceKeys;
- @UriParam(description = "FC service name", displayName = "Service Name")
+ @UriParam(description = "The name of the service that contains the
function. The CamelAlibabaFcServiceName 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. One of the three is required.",
+ displayName = "Service Name")
private String serviceName;
- @UriParam(description = "FC function name", displayName = "Function Name")
+ @UriParam(description = "The name of the function. The
CamelAlibabaFcFunctionName 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. One of the three is
required.",
+ displayName = "Function Name")
private String functionName;
- @UriParam(description = "Function version or alias qualifier", displayName
= "Qualifier")
+ @UriParam(description = "The version or alias of the service. The
CamelAlibabaFcQualifier 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. If none of the
three is set, the producer adds no version or alias"
+ + " to the request.",
+ displayName = "Qualifier")
private String qualifier;
- @UriParam(description = "Autowire an existing FC client instance",
displayName = "FC Client", label = "advanced")
+ @UriParam(description = "To use a custom
com.aliyun.fc_open20210406.Client. The producer sends its requests with this"
+ + " client, and the region, endpoint, accessKey,
secretKey and serviceKeys options are not used. If"
+ + " no client is set or autowired, the Camel
endpoint creates a client from these options. It"
+ + " creates this client when the producer
processes its first message.",
+ displayName = "FC Client", label = "advanced")
@Metadata(autowired = true)
private Client fcClient;
diff --git
a/components/camel-alibaba/camel-alibaba-fc/src/main/java/org/apache/camel/component/alibaba/fc/constants/FCHeaders.java
b/components/camel-alibaba/camel-alibaba-fc/src/main/java/org/apache/camel/component/alibaba/fc/constants/FCHeaders.java
index 65f81e36f0bf..1684b0e657c4 100644
---
a/components/camel-alibaba/camel-alibaba-fc/src/main/java/org/apache/camel/component/alibaba/fc/constants/FCHeaders.java
+++
b/components/camel-alibaba/camel-alibaba-fc/src/main/java/org/apache/camel/component/alibaba/fc/constants/FCHeaders.java
@@ -20,19 +20,35 @@ import org.apache.camel.spi.Metadata;
public final class FCHeaders {
- @Metadata(label = "producer", description = "FC service name override",
javaType = "String")
+ @Metadata(label = "producer",
+ description = "The name of the service that contains the
function. This header replaces the serviceName option."
+ + " If this header is not set, an exchange
property of the same name replaces the serviceName"
+ + " option.",
+ javaType = "String")
public static final String SERVICE_NAME = FCProperties.SERVICE_NAME;
- @Metadata(label = "producer", description = "FC function name override",
javaType = "String")
+ @Metadata(label = "producer",
+ description = "The name of the function. This header replaces
the functionName option. If this header is not set,"
+ + " an exchange property of the same name replaces
the functionName option.",
+ javaType = "String")
public static final String FUNCTION_NAME = FCProperties.FUNCTION_NAME;
- @Metadata(label = "producer", description = "Function qualifier override",
javaType = "String")
+ @Metadata(label = "producer",
+ description = "The version or alias of the service. This header
replaces the qualifier option. If this header is"
+ + " not set, an exchange property of the same name
replaces the qualifier option.",
+ javaType = "String")
public static final String QUALIFIER = FCProperties.QUALIFIER;
- @Metadata(label = "producer", description = "Alibaba Cloud request id",
javaType = "String")
+ @Metadata(label = "producer",
+ description = "The request ID that Function Compute returns in
the response to invokeFunction. The producer sets"
+ + " it for invokeFunction, unless the exchange
fails.",
+ javaType = "String")
public static final String REQUEST_ID = FCProperties.REQUEST_ID;
- @Metadata(label = "producer", description = "HTTP status code from FC
invoke response", javaType = "Integer")
+ @Metadata(label = "producer",
+ description = "The HTTP status code of the response to the
operation. The producer sets it, unless the exchange"
+ + " fails.",
+ javaType = "Integer")
public static final String STATUS_CODE = "CamelAlibabaFcStatusCode";
private FCHeaders() {
diff --git
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java
index 1dbae88d542e..f60f17d2f3cb 100644
---
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java
+++
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java
@@ -355,7 +355,10 @@ public class StaticEndpointBuilders {
* Syntax: <code>alibaba-fc:operation</code>
*
* Path parameter: operation (required)
- * Operation to perform
+ * The operation that the producer performs. The CamelAlibabaFcOperation
+ * 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.
* There are 2 enums and the value can be one of: invokeFunction,
* getFunction
*
@@ -376,7 +379,10 @@ public class StaticEndpointBuilders {
* Syntax: <code>alibaba-fc:operation</code>
*
* Path parameter: operation (required)
- * Operation to perform
+ * The operation that the producer performs. The CamelAlibabaFcOperation
+ * 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.
* There are 2 enums and the value can be one of: invokeFunction,
* getFunction
*
diff --git
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/FCEndpointBuilderFactory.java
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/FCEndpointBuilderFactory.java
index c9bcee47650e..8acebef988ae 100644
---
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/FCEndpointBuilderFactory.java
+++
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/FCEndpointBuilderFactory.java
@@ -45,8 +45,11 @@ public interface FCEndpointBuilderFactory {
}
/**
- * FC endpoint URL. Carries higher precedence than region based client
- * initialization.
+ * The endpoint of Function Compute, which is a host name without
+ * http:// or https://. The producer sends requests to it over HTTPS.
If
+ * not set, the region option determines the endpoint, and one of the
+ * two is required. Not used when the fcClient option is set or
+ * autowired.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -60,7 +63,10 @@ public interface FCEndpointBuilderFactory {
return this;
}
/**
- * FC function name.
+ * The name of the function. The CamelAlibabaFcFunctionName 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. One of the three is required.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -74,7 +80,11 @@ public interface FCEndpointBuilderFactory {
return this;
}
/**
- * Function version or alias qualifier.
+ * The version or alias of the service. The CamelAlibabaFcQualifier
+ * 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. If none of the three is set, the producer adds
+ * no version or alias to the request.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -88,7 +98,10 @@ public interface FCEndpointBuilderFactory {
return this;
}
/**
- * Alibaba Cloud region.
+ * The region ID of Function Compute, for example cn-hangzhou. Only
used
+ * when the endpoint option is not set, to build the endpoint of
+ * Function Compute. Not used when the fcClient option is set or
+ * autowired.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -103,7 +116,11 @@ public interface FCEndpointBuilderFactory {
return this;
}
/**
- * FC service name.
+ * The name of the service that contains the function. The
+ * CamelAlibabaFcServiceName 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. One of the three is
+ * required.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -117,7 +134,10 @@ public interface FCEndpointBuilderFactory {
return this;
}
/**
- * Access key for the cloud user.
+ * The AccessKey ID of the AccessKey pair for the requests that the
+ * producer sends to Function Compute. If not set, the accessKey of the
+ * serviceKeys option is used, and one of the two is required. Not used
+ * when the fcClient option is set or autowired.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -131,7 +151,10 @@ public interface FCEndpointBuilderFactory {
return this;
}
/**
- * Secret key for the cloud user.
+ * The AccessKey secret of the AccessKey pair for the requests that the
+ * producer sends to Function Compute. If not set, the secretKey of the
+ * serviceKeys option is used, and one of the two is required. Not used
+ * when the fcClient option is set or autowired.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -145,7 +168,11 @@ public interface FCEndpointBuilderFactory {
return this;
}
/**
- * Configuration object for cloud service authentication.
+ * The AccessKey pair as an
+ * org.apache.camel.component.alibaba.common.models.ServiceKeys. Its
+ * accessKey is the AccessKey ID and its 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 fcClient option is set or autowired.
*
* The option is a:
*
<code>org.apache.camel.component.alibaba.common.models.ServiceKeys</code> type.
@@ -160,7 +187,11 @@ public interface FCEndpointBuilderFactory {
return this;
}
/**
- * Configuration object for cloud service authentication.
+ * The AccessKey pair as an
+ * org.apache.camel.component.alibaba.common.models.ServiceKeys. Its
+ * accessKey is the AccessKey ID and its 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 fcClient option is set or autowired.
*
* The option will be converted to a
*
<code>org.apache.camel.component.alibaba.common.models.ServiceKeys</code> type.
@@ -233,7 +264,11 @@ public interface FCEndpointBuilderFactory {
return this;
}
/**
- * Autowire an existing FC client instance.
+ * To use a custom com.aliyun.fc_open20210406.Client. The producer
sends
+ * its requests with this client, and the region, endpoint, accessKey,
+ * secretKey and serviceKeys options are not used. If no client is set
+ * or autowired, the Camel endpoint creates a client from these
options.
+ * It creates this client when the producer processes its first
message.
*
* The option is a: <code>com.aliyun.fc_open20210406.Client</code>
type.
*
@@ -247,7 +282,11 @@ public interface FCEndpointBuilderFactory {
return this;
}
/**
- * Autowire an existing FC client instance.
+ * To use a custom com.aliyun.fc_open20210406.Client. The producer
sends
+ * its requests with this client, and the region, endpoint, accessKey,
+ * secretKey and serviceKeys options are not used. If no client is set
+ * or autowired, the Camel endpoint creates a client from these
options.
+ * It creates this client when the producer processes its first
message.
*
* The option will be converted to a
* <code>com.aliyun.fc_open20210406.Client</code> type.
@@ -288,7 +327,10 @@ public interface FCEndpointBuilderFactory {
* Syntax: <code>alibaba-fc:operation</code>
*
* Path parameter: operation (required)
- * Operation to perform
+ * The operation that the producer performs. The
CamelAlibabaFcOperation
+ * 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.
* There are 2 enums and the value can be one of: invokeFunction,
* getFunction
*
@@ -309,7 +351,10 @@ public interface FCEndpointBuilderFactory {
* Syntax: <code>alibaba-fc:operation</code>
*
* Path parameter: operation (required)
- * Operation to perform
+ * The operation that the producer performs. The
CamelAlibabaFcOperation
+ * 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.
* There are 2 enums and the value can be one of: invokeFunction,
* getFunction
*
@@ -334,7 +379,9 @@ public interface FCEndpointBuilderFactory {
public static final FCHeaderNameBuilder INSTANCE = new
FCHeaderNameBuilder();
/**
- * FC service name override.
+ * The name of the service that contains the function. This header
+ * replaces the serviceName option. If this header is not set, an
+ * exchange property of the same name replaces the serviceName option.
*
* The option is a: {@code String} type.
*
@@ -346,7 +393,9 @@ public interface FCEndpointBuilderFactory {
return "CamelAlibabaFcServiceName";
}
/**
- * FC function name override.
+ * The name of the function. This header replaces the functionName
+ * option. If this header is not set, an exchange property of the same
+ * name replaces the functionName option.
*
* The option is a: {@code String} type.
*
@@ -358,7 +407,9 @@ public interface FCEndpointBuilderFactory {
return "CamelAlibabaFcFunctionName";
}
/**
- * Function qualifier override.
+ * The version or alias of the service. This header replaces the
+ * qualifier option. If this header is not set, an exchange property of
+ * the same name replaces the qualifier option.
*
* The option is a: {@code String} type.
*
@@ -370,7 +421,9 @@ public interface FCEndpointBuilderFactory {
return "CamelAlibabaFcQualifier";
}
/**
- * Alibaba Cloud request id.
+ * The request ID that Function Compute returns in the response to
+ * invokeFunction. The producer sets it for invokeFunction, unless the
+ * exchange fails.
*
* The option is a: {@code String} type.
*
@@ -382,7 +435,8 @@ public interface FCEndpointBuilderFactory {
return "CamelAlibabaFcRequestId";
}
/**
- * HTTP status code from FC invoke response.
+ * The HTTP status code of the response to the operation. The producer
+ * sets it, unless the exchange fails.
*
* The option is a: {@code Integer} type.
*