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 53560c0647c5 CAMEL-23832: camel-alibaba-sls - improve the component
and option descriptions (#30301)
53560c0647c5 is described below
commit 53560c0647c5a3cfdbf0e60d6200e4621a4791e2
Author: Saravanakumar Selvaraj <[email protected]>
AuthorDate: Wed Nov 18 12:21:11 2026 +0000
CAMEL-23832: camel-alibaba-sls - improve the component and option
descriptions (#30301)
New texts for the component description, 16 endpoint options and 17
headers. The Camel code, the sls20201230 5.18.1
sources and the Alibaba Cloud API reference back each statement. The old
texts were short labels. They did not say which
header and exchange property replace each input, or which operation reads
it. They also left out the limits of Simple
Log Service and the host that the SDK builds.
tasks/component-descriptions.md marks camel-alibaba-sls as done.
Documentation only, no behavior change. The component JSON, the catalog
copy, the doc page header and the DSL are regenerated.
Co-Authored-By: Claude Opus 5.5 <[email protected]>
---
.../camel/catalog/components/alibaba-sls.json | 68 +++---
.../camel/catalog/docs/alibaba-sls-component.adoc | 2 +-
.../camel/component/alibaba/sls/alibaba-sls.json | 68 +++---
.../src/main/docs/alibaba-sls-component.adoc | 2 +-
.../component/alibaba/sls/AlibabaSlsEndpoint.java | 101 +++++++--
.../alibaba/sls/constants/AlibabaSlsHeaders.java | 105 +++++++--
.../component/ComponentsBuilderFactory.java | 3 +-
.../dsl/AlibabaSlsComponentBuilderFactory.java | 6 +-
.../builder/endpoint/EndpointHeaderBuilders.java | 3 +-
.../builder/endpoint/StaticEndpointBuilders.java | 16 +-
.../dsl/AlibabaSlsEndpointBuilderFactory.java | 250 +++++++++++++++++----
tasks/component-descriptions.md | 2 +-
12 files changed, 466 insertions(+), 160 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/alibaba-sls.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/alibaba-sls.json
index 092954d2c625..e2121d137229 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/alibaba-sls.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/alibaba-sls.json
@@ -3,7 +3,7 @@
"kind": "component",
"name": "alibaba-sls",
"title": "Alibaba Simple Log Service (SLS)",
- "description": "Manage logs on Alibaba Cloud Simple Log Service (SLS).",
+ "description": "Write logs, query logs, and list Logstores on Alibaba
Cloud Simple Log Service (SLS).",
"deprecated": false,
"firstVersion": "4.23.0",
"label": "cloud,monitoring",
@@ -30,45 +30,45 @@
"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": {
- "CamelAlibabaSlsOperation": { "index": 0, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "Operation override", "constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#OPERATION"
},
- "CamelAlibabaSlsProject": { "index": 1, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "SLS project name override", "constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#PROJECT" },
- "CamelAlibabaSlsLogStoreName": { "index": 2, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "SLS log store name override", "constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#LOG_STORE_NAME"
},
- "CamelAlibabaSlsQuery": { "index": 3, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "Log query string override", "constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#QUERY" },
- "CamelAlibabaSlsFrom": { "index": 4, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"Integer", "deprecated": false, "autowired": false, "secret": false,
"description": "Query start time override (Unix timestamp in seconds)",
"constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#FROM" },
- "CamelAlibabaSlsTo": { "index": 5, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"Integer", "deprecated": false, "autowired": false, "secret": false,
"description": "Query end time override (Unix timestamp in seconds)",
"constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#TO" },
- "CamelAlibabaSlsLine": { "index": 6, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"Long", "deprecated": false, "autowired": false, "secret": false,
"description": "Maximum number of log lines to return", "constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#LINE" },
- "CamelAlibabaSlsOffset": { "index": 7, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"Long", "deprecated": false, "autowired": false, "secret": false,
"description": "Log query offset", "constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#OFFSET" },
- "CamelAlibabaSlsTopic": { "index": 8, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "Log topic filter override", "constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#TOPIC" },
- "CamelAlibabaSlsReverse": { "index": 9, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"Boolean", "deprecated": false, "autowired": false, "secret": false,
"description": "Whether to return logs in reverse order", "constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#REVERSE" },
- "CamelAlibabaSlsLogstoreName": { "index": 10, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "Log store name prefix filter for listLogStores",
"constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#LOGSTORE_NAME"
},
- "CamelAlibabaSlsMode": { "index": 11, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "List mode for listLogStores", "constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#MODE" },
- "CamelAlibabaSlsSize": { "index": 12, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"Integer", "deprecated": false, "autowired": false, "secret": false,
"description": "Page size for listLogStores", "constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#SIZE" },
- "CamelAlibabaSlsListOffset": { "index": 13, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "Integer", "deprecated": false, "autowired": false, "secret":
false, "description": "Pagination offset for listLogStores", "constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#LIST_OFFSET"
},
- "CamelAlibabaSlsTelemetryType": { "index": 14, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "Telemetry type filter for listLogStores", "constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#TELEMETRY_TYPE"
},
- "CamelAlibabaSlsRequestId": { "index": 15, "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.sls.constants.AlibabaSlsHeaders#REQUEST_ID"
},
- "CamelAlibabaSlsStatusCode": { "index": 16, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "Integer", "deprecated": false, "autowired": false, "secret":
false, "description": "HTTP status code from SLS response", "constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#STATUS_CODE"
}
+ "CamelAlibabaSlsOperation": { "index": 0, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The operation that the producer performs. This header replaces
the operation option. If this header is not set, an exchange property of the
same name replaces the operation option.", "constantName":
"org.apache.camel.component.alibaba.sls.constants.Ali [...]
+ "CamelAlibabaSlsProject": { "index": 1, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The name of the project. This header replaces the project
option. If this header is not set, an exchange property of the same name
replaces the project option.", "constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#PROJECT" },
+ "CamelAlibabaSlsLogStoreName": { "index": 2, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "The name of the Logstore for putLogs and getLogs. The producer
writes the logs to this Logstore for putLogs, and queries its logs for getLogs.
This header replaces the logStoreName option. If this header is not set, an
exchange property of the same [...]
+ "CamelAlibabaSlsQuery": { "index": 3, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The search statement or analytic statement for getLogs. This
header replaces the query option. If this header is not set, an exchange
property of the same name replaces the query option.", "constantName":
"org.apache.camel.component.alibaba.sls.constants.A [...]
+ "CamelAlibabaSlsFrom": { "index": 4, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"Integer", "deprecated": false, "autowired": false, "secret": false,
"description": "The start time for getLogs, as a Unix timestamp in seconds.
Simple Log Service requires a start time. This header replaces the from option.
If this header is not set, an exchange property of the same name replaces the
from option.", "constantName": "org.ap [...]
+ "CamelAlibabaSlsTo": { "index": 5, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"Integer", "deprecated": false, "autowired": false, "secret": false,
"description": "The end time for getLogs, as a Unix timestamp in seconds.
Simple Log Service requires an end time. This header replaces the to option. If
this header is not set, an exchange property of the same name replaces the to
option.", "constantName": "org.apache.came [...]
+ "CamelAlibabaSlsLine": { "index": 6, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"Long", "deprecated": false, "autowired": false, "secret": false,
"description": "The maximum number of logs to return for getLogs. Simple Log
Service accepts a value of at most 100. Simple Log Service does not use it when
query contains an analytic statement. This header replaces the line option. If
this header is not set, an exchange pro [...]
+ "CamelAlibabaSlsOffset": { "index": 7, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"Long", "deprecated": false, "autowired": false, "secret": false,
"description": "The offset of the first log to return for getLogs. Simple Log
Service does not use it when query contains an analytic statement. This header
replaces the offset option. If this header is not set, an exchange property of
the same name replaces the offset opt [...]
+ "CamelAlibabaSlsTopic": { "index": 8, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The log topic for getLogs. This header replaces the topic
option. If this header is not set, an exchange property of the same name
replaces the topic option.", "constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#TOPIC" },
+ "CamelAlibabaSlsReverse": { "index": 9, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"Boolean", "deprecated": false, "autowired": false, "secret": false,
"description": "Whether to return logs in descending order of log timestamps
for getLogs. Simple Log Service does not use it when query contains an analytic
statement. This header replaces the reverse option. If this header is not set,
an exchange property of the same [...]
+ "CamelAlibabaSlsLogstoreName": { "index": 10, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "The name of the Logstore for listLogStores. Simple Log Service
returns the Logstores whose name contains the value. If this header is not set,
the producer uses an exchange property of the same name. If neither of the two
is set, the producer adds [...]
+ "CamelAlibabaSlsMode": { "index": 11, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The type of the Logstore for listLogStores. The value must be
standard or query. If this header is not set, the producer uses an exchange
property of the same name. If neither of the two is set, the producer adds no
Logstore type to the request.", "constan [...]
+ "CamelAlibabaSlsSize": { "index": 12, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"Integer", "deprecated": false, "autowired": false, "secret": false,
"description": "The number of entries per page for listLogStores. Simple Log
Service accepts a value of at most 500. If this header is not set, the producer
uses an exchange property of the same name. If neither of the two is set, the
producer adds no number of entries p [...]
+ "CamelAlibabaSlsListOffset": { "index": 13, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "Integer", "deprecated": false, "autowired": false, "secret":
false, "description": "The offset of the first Logstore to return for
listLogStores. If this header is not set, the producer uses an exchange
property of the same name. If neither of the two is set, the producer adds no
offset to the request.", "constantName": "org.apache [...]
+ "CamelAlibabaSlsTelemetryType": { "index": 14, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "The telemetry type for listLogStores. The value must be None
for logs or Metrics for metrics. If this header is not set, the producer uses
an exchange property of the same name. If neither of the two is set, the
producer adds no telemetry type to [...]
+ "CamelAlibabaSlsRequestId": { "index": 15, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "The request ID that Simple Log Service returns in the response
to the operation. The producer sets it when the response has one.",
"constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#REQUEST_ID"
},
+ "CamelAlibabaSlsStatusCode": { "index": 16, "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.sls.constants.AlibabaSlsHeaders#STATUS_CODE"
}
},
"bodyTypes": {
"producerIn": { "carriers": [ "any" ], "byOption": [ { "option":
"operation", "value": "putLogs", "carriers": [ "pojo" ] } ], "description":
"The logs to write for putLogs: a LogGroup or a PutLogsRequest of the SLS SDK,
any other body fails. getLogs and listLogStores do not read the body, they take
their input from options and headers" },
"producerOut": { "carriers": [ "map" ], "description": "A Map of the
response with its statusCode and headers. For getLogs the GetLogsResponseBody
of the SLS SDK is under body, for listLogStores the names under logstores with
count and total" }
},
"properties": {
- "operation": { "index": 0, "kind": "path", "displayName": "Operation",
"group": "producer", "label": "producer", "required": true, "type": "enum",
"javaType": "java.lang.String", "enum": [ "putLogs", "getLogs", "listLogStores"
], "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": "SLS endpoint URL (e.g.
cn-hangzhou.log.aliyuncs.com). Carries higher precedence than region based
client initialization" },
- "logStoreName": { "index": 2, "kind": "parameter", "displayName": "Log
Store Name", "group": "producer", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "SLS log store name" },
- "project": { "index": 3, "kind": "parameter", "displayName": "Project",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "SLS project name" },
- "region": { "index": 4, "kind": "parameter", "displayName": "Region",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Alibaba Cloud region" },
+ "operation": { "index": 0, "kind": "path", "displayName": "Operation",
"group": "producer", "label": "producer", "required": true, "type": "enum",
"javaType": "java.lang.String", "enum": [ "putLogs", "getLogs", "listLogStores"
], "deprecated": false, "autowired": false, "secret": false, "description":
"The operation that the producer performs. The CamelAlibabaSlsOperation header
replaces this option for a request that the producer sends. If that header is
not set, an exchange propert [...]
+ "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 Simple Log Service, which is a
host name without http:\/\/ or https:\/\/, for example
cn-hangzhou.log.aliyuncs.com. The producer sends requests over HTTPS to the
endpoint, with the name of the project in front of it. If n [...]
+ "logStoreName": { "index": 2, "kind": "parameter", "displayName": "Log
Store Name", "group": "producer", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "The name of the Logstore for putLogs
and getLogs. The producer writes the logs to this Logstore for putLogs, and
queries its logs for getLogs. The CamelAlibabaSlsLogStoreName header replaces
this option for a request that the p [...]
+ "project": { "index": 3, "kind": "parameter", "displayName": "Project",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The name of the project. The
CamelAlibabaSlsProject 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." },
+ "region": { "index": 4, "kind": "parameter", "displayName": "Region",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The region ID of Simple Log Service, for
example cn-hangzhou. Only used when the endpoint option is not set, to build
the endpoint of Simple Log Service. Not used when the slsClient option is set
or autowired." },
"lazyStartProducer": { "index": 5, "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 [...]
- "slsClient": { "index": 6, "kind": "parameter", "displayName": "SLS
Client", "group": "advanced", "label": "advanced", "required": false, "type":
"object", "javaType": "com.aliyun.sls20201230.Client", "deprecated": false,
"autowired": true, "secret": false, "description": "Autowire an existing SLS
client instance" },
- "from": { "index": 7, "kind": "parameter", "displayName": "From", "group":
"getLogs", "label": "getLogs", "required": false, "type": "integer",
"javaType": "java.lang.Integer", "deprecated": false, "autowired": false,
"secret": false, "description": "Query start time for getLogs (Unix timestamp
in seconds)" },
- "line": { "index": 8, "kind": "parameter", "displayName": "Line", "group":
"getLogs", "label": "getLogs", "required": false, "type": "integer",
"javaType": "java.lang.Long", "deprecated": false, "autowired": false,
"secret": false, "description": "Maximum number of log lines to return for
getLogs" },
- "offset": { "index": 9, "kind": "parameter", "displayName": "Offset",
"group": "getLogs", "label": "getLogs", "required": false, "type": "integer",
"javaType": "java.lang.Long", "deprecated": false, "autowired": false,
"secret": false, "description": "Log query offset for getLogs" },
- "query": { "index": 10, "kind": "parameter", "displayName": "Query",
"group": "getLogs", "label": "getLogs", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Log query string for getLogs" },
- "reverse": { "index": 11, "kind": "parameter", "displayName": "Reverse",
"group": "getLogs", "label": "getLogs", "required": false, "type": "boolean",
"javaType": "java.lang.Boolean", "deprecated": false, "autowired": false,
"secret": false, "description": "Whether to return logs in reverse order for
getLogs" },
- "to": { "index": 12, "kind": "parameter", "displayName": "To", "group":
"getLogs", "label": "getLogs", "required": false, "type": "integer",
"javaType": "java.lang.Integer", "deprecated": false, "autowired": false,
"secret": false, "description": "Query end time for getLogs (Unix timestamp in
seconds)" },
- "topic": { "index": 13, "kind": "parameter", "displayName": "Topic",
"group": "getLogs", "label": "getLogs", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Log topic filter for getLogs" },
- "accessKey": { "index": 14, "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": 15, "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": 16, "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" }
+ "slsClient": { "index": 6, "kind": "parameter", "displayName": "SLS
Client", "group": "advanced", "label": "advanced", "required": false, "type":
"object", "javaType": "com.aliyun.sls20201230.Client", "deprecated": false,
"autowired": true, "secret": false, "description": "To use a custom
com.aliyun.sls20201230.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 [...]
+ "from": { "index": 7, "kind": "parameter", "displayName": "From", "group":
"getLogs", "label": "getLogs", "required": false, "type": "integer",
"javaType": "java.lang.Integer", "deprecated": false, "autowired": false,
"secret": false, "description": "The start time for getLogs, as a Unix
timestamp in seconds. Simple Log Service requires a start time. The
CamelAlibabaSlsFrom header replaces this option for a request that the producer
sends. If that header is not set, an exchange prope [...]
+ "line": { "index": 8, "kind": "parameter", "displayName": "Line", "group":
"getLogs", "label": "getLogs", "required": false, "type": "integer",
"javaType": "java.lang.Long", "deprecated": false, "autowired": false,
"secret": false, "description": "The maximum number of logs to return for
getLogs. Simple Log Service accepts a value of at most 100. Simple Log Service
does not use it when query contains an analytic statement. The
CamelAlibabaSlsLine header replaces this option for a req [...]
+ "offset": { "index": 9, "kind": "parameter", "displayName": "Offset",
"group": "getLogs", "label": "getLogs", "required": false, "type": "integer",
"javaType": "java.lang.Long", "deprecated": false, "autowired": false,
"secret": false, "description": "The offset of the first log to return for
getLogs. Simple Log Service does not use it when query contains an analytic
statement. The CamelAlibabaSlsOffset header replaces this option for a request
that the producer sends. If that header [...]
+ "query": { "index": 10, "kind": "parameter", "displayName": "Query",
"group": "getLogs", "label": "getLogs", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The search statement or analytic statement for
getLogs. The CamelAlibabaSlsQuery 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. I [...]
+ "reverse": { "index": 11, "kind": "parameter", "displayName": "Reverse",
"group": "getLogs", "label": "getLogs", "required": false, "type": "boolean",
"javaType": "java.lang.Boolean", "deprecated": false, "autowired": false,
"secret": false, "description": "Whether to return logs in descending order of
log timestamps for getLogs. Simple Log Service does not use it when query
contains an analytic statement. The CamelAlibabaSlsReverse header replaces this
option for a request that the [...]
+ "to": { "index": 12, "kind": "parameter", "displayName": "To", "group":
"getLogs", "label": "getLogs", "required": false, "type": "integer",
"javaType": "java.lang.Integer", "deprecated": false, "autowired": false,
"secret": false, "description": "The end time for getLogs, as a Unix timestamp
in seconds. Simple Log Service requires an end time. The CamelAlibabaSlsTo
header replaces this option for a request that the producer sends. If that
header is not set, an exchange property of t [...]
+ "topic": { "index": 13, "kind": "parameter", "displayName": "Topic",
"group": "getLogs", "label": "getLogs", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The log topic for getLogs. The
CamelAlibabaSlsTopic 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, t [...]
+ "accessKey": { "index": 14, "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 Simple Log
Service. If not set, the accessKey of the serviceKeys option is used, and one
of the two is required. Not used [...]
+ "secretKey": { "index": 15, "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 Simple
Log Service. If not set, the secretKey of the serviceKeys option is used, and
one of the two is required. Not [...]
+ "serviceKeys": { "index": 16, "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/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/alibaba-sls-component.adoc
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/alibaba-sls-component.adoc
index 64eb2ca4a75f..7895564d1468 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/alibaba-sls-component.adoc
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/alibaba-sls-component.adoc
@@ -2,7 +2,7 @@
:doctitle: Alibaba Simple Log Service (SLS)
:shortname: alibaba-sls
:artifactid: camel-alibaba-sls
-:description: Manage logs on Alibaba Cloud Simple Log Service (SLS).
+:description: Write logs, query logs, and list Logstores on Alibaba Cloud
Simple Log Service (SLS).
:since: 4.23
:supportlevel: Preview
:tabs-sync-option:
diff --git
a/components/camel-alibaba/camel-alibaba-sls/src/generated/resources/META-INF/org/apache/camel/component/alibaba/sls/alibaba-sls.json
b/components/camel-alibaba/camel-alibaba-sls/src/generated/resources/META-INF/org/apache/camel/component/alibaba/sls/alibaba-sls.json
index 092954d2c625..e2121d137229 100644
---
a/components/camel-alibaba/camel-alibaba-sls/src/generated/resources/META-INF/org/apache/camel/component/alibaba/sls/alibaba-sls.json
+++
b/components/camel-alibaba/camel-alibaba-sls/src/generated/resources/META-INF/org/apache/camel/component/alibaba/sls/alibaba-sls.json
@@ -3,7 +3,7 @@
"kind": "component",
"name": "alibaba-sls",
"title": "Alibaba Simple Log Service (SLS)",
- "description": "Manage logs on Alibaba Cloud Simple Log Service (SLS).",
+ "description": "Write logs, query logs, and list Logstores on Alibaba
Cloud Simple Log Service (SLS).",
"deprecated": false,
"firstVersion": "4.23.0",
"label": "cloud,monitoring",
@@ -30,45 +30,45 @@
"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": {
- "CamelAlibabaSlsOperation": { "index": 0, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "Operation override", "constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#OPERATION"
},
- "CamelAlibabaSlsProject": { "index": 1, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "SLS project name override", "constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#PROJECT" },
- "CamelAlibabaSlsLogStoreName": { "index": 2, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "SLS log store name override", "constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#LOG_STORE_NAME"
},
- "CamelAlibabaSlsQuery": { "index": 3, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "Log query string override", "constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#QUERY" },
- "CamelAlibabaSlsFrom": { "index": 4, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"Integer", "deprecated": false, "autowired": false, "secret": false,
"description": "Query start time override (Unix timestamp in seconds)",
"constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#FROM" },
- "CamelAlibabaSlsTo": { "index": 5, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"Integer", "deprecated": false, "autowired": false, "secret": false,
"description": "Query end time override (Unix timestamp in seconds)",
"constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#TO" },
- "CamelAlibabaSlsLine": { "index": 6, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"Long", "deprecated": false, "autowired": false, "secret": false,
"description": "Maximum number of log lines to return", "constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#LINE" },
- "CamelAlibabaSlsOffset": { "index": 7, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"Long", "deprecated": false, "autowired": false, "secret": false,
"description": "Log query offset", "constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#OFFSET" },
- "CamelAlibabaSlsTopic": { "index": 8, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "Log topic filter override", "constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#TOPIC" },
- "CamelAlibabaSlsReverse": { "index": 9, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"Boolean", "deprecated": false, "autowired": false, "secret": false,
"description": "Whether to return logs in reverse order", "constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#REVERSE" },
- "CamelAlibabaSlsLogstoreName": { "index": 10, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "Log store name prefix filter for listLogStores",
"constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#LOGSTORE_NAME"
},
- "CamelAlibabaSlsMode": { "index": 11, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "List mode for listLogStores", "constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#MODE" },
- "CamelAlibabaSlsSize": { "index": 12, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"Integer", "deprecated": false, "autowired": false, "secret": false,
"description": "Page size for listLogStores", "constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#SIZE" },
- "CamelAlibabaSlsListOffset": { "index": 13, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "Integer", "deprecated": false, "autowired": false, "secret":
false, "description": "Pagination offset for listLogStores", "constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#LIST_OFFSET"
},
- "CamelAlibabaSlsTelemetryType": { "index": 14, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "Telemetry type filter for listLogStores", "constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#TELEMETRY_TYPE"
},
- "CamelAlibabaSlsRequestId": { "index": 15, "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.sls.constants.AlibabaSlsHeaders#REQUEST_ID"
},
- "CamelAlibabaSlsStatusCode": { "index": 16, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "Integer", "deprecated": false, "autowired": false, "secret":
false, "description": "HTTP status code from SLS response", "constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#STATUS_CODE"
}
+ "CamelAlibabaSlsOperation": { "index": 0, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The operation that the producer performs. This header replaces
the operation option. If this header is not set, an exchange property of the
same name replaces the operation option.", "constantName":
"org.apache.camel.component.alibaba.sls.constants.Ali [...]
+ "CamelAlibabaSlsProject": { "index": 1, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The name of the project. This header replaces the project
option. If this header is not set, an exchange property of the same name
replaces the project option.", "constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#PROJECT" },
+ "CamelAlibabaSlsLogStoreName": { "index": 2, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "The name of the Logstore for putLogs and getLogs. The producer
writes the logs to this Logstore for putLogs, and queries its logs for getLogs.
This header replaces the logStoreName option. If this header is not set, an
exchange property of the same [...]
+ "CamelAlibabaSlsQuery": { "index": 3, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The search statement or analytic statement for getLogs. This
header replaces the query option. If this header is not set, an exchange
property of the same name replaces the query option.", "constantName":
"org.apache.camel.component.alibaba.sls.constants.A [...]
+ "CamelAlibabaSlsFrom": { "index": 4, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"Integer", "deprecated": false, "autowired": false, "secret": false,
"description": "The start time for getLogs, as a Unix timestamp in seconds.
Simple Log Service requires a start time. This header replaces the from option.
If this header is not set, an exchange property of the same name replaces the
from option.", "constantName": "org.ap [...]
+ "CamelAlibabaSlsTo": { "index": 5, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"Integer", "deprecated": false, "autowired": false, "secret": false,
"description": "The end time for getLogs, as a Unix timestamp in seconds.
Simple Log Service requires an end time. This header replaces the to option. If
this header is not set, an exchange property of the same name replaces the to
option.", "constantName": "org.apache.came [...]
+ "CamelAlibabaSlsLine": { "index": 6, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"Long", "deprecated": false, "autowired": false, "secret": false,
"description": "The maximum number of logs to return for getLogs. Simple Log
Service accepts a value of at most 100. Simple Log Service does not use it when
query contains an analytic statement. This header replaces the line option. If
this header is not set, an exchange pro [...]
+ "CamelAlibabaSlsOffset": { "index": 7, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"Long", "deprecated": false, "autowired": false, "secret": false,
"description": "The offset of the first log to return for getLogs. Simple Log
Service does not use it when query contains an analytic statement. This header
replaces the offset option. If this header is not set, an exchange property of
the same name replaces the offset opt [...]
+ "CamelAlibabaSlsTopic": { "index": 8, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The log topic for getLogs. This header replaces the topic
option. If this header is not set, an exchange property of the same name
replaces the topic option.", "constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#TOPIC" },
+ "CamelAlibabaSlsReverse": { "index": 9, "kind": "header", "displayName":
"", "group": "producer", "label": "producer", "required": false, "javaType":
"Boolean", "deprecated": false, "autowired": false, "secret": false,
"description": "Whether to return logs in descending order of log timestamps
for getLogs. Simple Log Service does not use it when query contains an analytic
statement. This header replaces the reverse option. If this header is not set,
an exchange property of the same [...]
+ "CamelAlibabaSlsLogstoreName": { "index": 10, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "The name of the Logstore for listLogStores. Simple Log Service
returns the Logstores whose name contains the value. If this header is not set,
the producer uses an exchange property of the same name. If neither of the two
is set, the producer adds [...]
+ "CamelAlibabaSlsMode": { "index": 11, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "autowired": false, "secret": false,
"description": "The type of the Logstore for listLogStores. The value must be
standard or query. If this header is not set, the producer uses an exchange
property of the same name. If neither of the two is set, the producer adds no
Logstore type to the request.", "constan [...]
+ "CamelAlibabaSlsSize": { "index": 12, "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"Integer", "deprecated": false, "autowired": false, "secret": false,
"description": "The number of entries per page for listLogStores. Simple Log
Service accepts a value of at most 500. If this header is not set, the producer
uses an exchange property of the same name. If neither of the two is set, the
producer adds no number of entries p [...]
+ "CamelAlibabaSlsListOffset": { "index": 13, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "Integer", "deprecated": false, "autowired": false, "secret":
false, "description": "The offset of the first Logstore to return for
listLogStores. If this header is not set, the producer uses an exchange
property of the same name. If neither of the two is set, the producer adds no
offset to the request.", "constantName": "org.apache [...]
+ "CamelAlibabaSlsTelemetryType": { "index": 14, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "The telemetry type for listLogStores. The value must be None
for logs or Metrics for metrics. If this header is not set, the producer uses
an exchange property of the same name. If neither of the two is set, the
producer adds no telemetry type to [...]
+ "CamelAlibabaSlsRequestId": { "index": 15, "kind": "header",
"displayName": "", "group": "producer", "label": "producer", "required": false,
"javaType": "String", "deprecated": false, "autowired": false, "secret": false,
"description": "The request ID that Simple Log Service returns in the response
to the operation. The producer sets it when the response has one.",
"constantName":
"org.apache.camel.component.alibaba.sls.constants.AlibabaSlsHeaders#REQUEST_ID"
},
+ "CamelAlibabaSlsStatusCode": { "index": 16, "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.sls.constants.AlibabaSlsHeaders#STATUS_CODE"
}
},
"bodyTypes": {
"producerIn": { "carriers": [ "any" ], "byOption": [ { "option":
"operation", "value": "putLogs", "carriers": [ "pojo" ] } ], "description":
"The logs to write for putLogs: a LogGroup or a PutLogsRequest of the SLS SDK,
any other body fails. getLogs and listLogStores do not read the body, they take
their input from options and headers" },
"producerOut": { "carriers": [ "map" ], "description": "A Map of the
response with its statusCode and headers. For getLogs the GetLogsResponseBody
of the SLS SDK is under body, for listLogStores the names under logstores with
count and total" }
},
"properties": {
- "operation": { "index": 0, "kind": "path", "displayName": "Operation",
"group": "producer", "label": "producer", "required": true, "type": "enum",
"javaType": "java.lang.String", "enum": [ "putLogs", "getLogs", "listLogStores"
], "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": "SLS endpoint URL (e.g.
cn-hangzhou.log.aliyuncs.com). Carries higher precedence than region based
client initialization" },
- "logStoreName": { "index": 2, "kind": "parameter", "displayName": "Log
Store Name", "group": "producer", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "SLS log store name" },
- "project": { "index": 3, "kind": "parameter", "displayName": "Project",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "SLS project name" },
- "region": { "index": 4, "kind": "parameter", "displayName": "Region",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Alibaba Cloud region" },
+ "operation": { "index": 0, "kind": "path", "displayName": "Operation",
"group": "producer", "label": "producer", "required": true, "type": "enum",
"javaType": "java.lang.String", "enum": [ "putLogs", "getLogs", "listLogStores"
], "deprecated": false, "autowired": false, "secret": false, "description":
"The operation that the producer performs. The CamelAlibabaSlsOperation header
replaces this option for a request that the producer sends. If that header is
not set, an exchange propert [...]
+ "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 Simple Log Service, which is a
host name without http:\/\/ or https:\/\/, for example
cn-hangzhou.log.aliyuncs.com. The producer sends requests over HTTPS to the
endpoint, with the name of the project in front of it. If n [...]
+ "logStoreName": { "index": 2, "kind": "parameter", "displayName": "Log
Store Name", "group": "producer", "label": "", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "The name of the Logstore for putLogs
and getLogs. The producer writes the logs to this Logstore for putLogs, and
queries its logs for getLogs. The CamelAlibabaSlsLogStoreName header replaces
this option for a request that the p [...]
+ "project": { "index": 3, "kind": "parameter", "displayName": "Project",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The name of the project. The
CamelAlibabaSlsProject 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." },
+ "region": { "index": 4, "kind": "parameter", "displayName": "Region",
"group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The region ID of Simple Log Service, for
example cn-hangzhou. Only used when the endpoint option is not set, to build
the endpoint of Simple Log Service. Not used when the slsClient option is set
or autowired." },
"lazyStartProducer": { "index": 5, "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 [...]
- "slsClient": { "index": 6, "kind": "parameter", "displayName": "SLS
Client", "group": "advanced", "label": "advanced", "required": false, "type":
"object", "javaType": "com.aliyun.sls20201230.Client", "deprecated": false,
"autowired": true, "secret": false, "description": "Autowire an existing SLS
client instance" },
- "from": { "index": 7, "kind": "parameter", "displayName": "From", "group":
"getLogs", "label": "getLogs", "required": false, "type": "integer",
"javaType": "java.lang.Integer", "deprecated": false, "autowired": false,
"secret": false, "description": "Query start time for getLogs (Unix timestamp
in seconds)" },
- "line": { "index": 8, "kind": "parameter", "displayName": "Line", "group":
"getLogs", "label": "getLogs", "required": false, "type": "integer",
"javaType": "java.lang.Long", "deprecated": false, "autowired": false,
"secret": false, "description": "Maximum number of log lines to return for
getLogs" },
- "offset": { "index": 9, "kind": "parameter", "displayName": "Offset",
"group": "getLogs", "label": "getLogs", "required": false, "type": "integer",
"javaType": "java.lang.Long", "deprecated": false, "autowired": false,
"secret": false, "description": "Log query offset for getLogs" },
- "query": { "index": 10, "kind": "parameter", "displayName": "Query",
"group": "getLogs", "label": "getLogs", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Log query string for getLogs" },
- "reverse": { "index": 11, "kind": "parameter", "displayName": "Reverse",
"group": "getLogs", "label": "getLogs", "required": false, "type": "boolean",
"javaType": "java.lang.Boolean", "deprecated": false, "autowired": false,
"secret": false, "description": "Whether to return logs in reverse order for
getLogs" },
- "to": { "index": 12, "kind": "parameter", "displayName": "To", "group":
"getLogs", "label": "getLogs", "required": false, "type": "integer",
"javaType": "java.lang.Integer", "deprecated": false, "autowired": false,
"secret": false, "description": "Query end time for getLogs (Unix timestamp in
seconds)" },
- "topic": { "index": 13, "kind": "parameter", "displayName": "Topic",
"group": "getLogs", "label": "getLogs", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Log topic filter for getLogs" },
- "accessKey": { "index": 14, "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": 15, "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": 16, "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" }
+ "slsClient": { "index": 6, "kind": "parameter", "displayName": "SLS
Client", "group": "advanced", "label": "advanced", "required": false, "type":
"object", "javaType": "com.aliyun.sls20201230.Client", "deprecated": false,
"autowired": true, "secret": false, "description": "To use a custom
com.aliyun.sls20201230.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 [...]
+ "from": { "index": 7, "kind": "parameter", "displayName": "From", "group":
"getLogs", "label": "getLogs", "required": false, "type": "integer",
"javaType": "java.lang.Integer", "deprecated": false, "autowired": false,
"secret": false, "description": "The start time for getLogs, as a Unix
timestamp in seconds. Simple Log Service requires a start time. The
CamelAlibabaSlsFrom header replaces this option for a request that the producer
sends. If that header is not set, an exchange prope [...]
+ "line": { "index": 8, "kind": "parameter", "displayName": "Line", "group":
"getLogs", "label": "getLogs", "required": false, "type": "integer",
"javaType": "java.lang.Long", "deprecated": false, "autowired": false,
"secret": false, "description": "The maximum number of logs to return for
getLogs. Simple Log Service accepts a value of at most 100. Simple Log Service
does not use it when query contains an analytic statement. The
CamelAlibabaSlsLine header replaces this option for a req [...]
+ "offset": { "index": 9, "kind": "parameter", "displayName": "Offset",
"group": "getLogs", "label": "getLogs", "required": false, "type": "integer",
"javaType": "java.lang.Long", "deprecated": false, "autowired": false,
"secret": false, "description": "The offset of the first log to return for
getLogs. Simple Log Service does not use it when query contains an analytic
statement. The CamelAlibabaSlsOffset header replaces this option for a request
that the producer sends. If that header [...]
+ "query": { "index": 10, "kind": "parameter", "displayName": "Query",
"group": "getLogs", "label": "getLogs", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The search statement or analytic statement for
getLogs. The CamelAlibabaSlsQuery 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. I [...]
+ "reverse": { "index": 11, "kind": "parameter", "displayName": "Reverse",
"group": "getLogs", "label": "getLogs", "required": false, "type": "boolean",
"javaType": "java.lang.Boolean", "deprecated": false, "autowired": false,
"secret": false, "description": "Whether to return logs in descending order of
log timestamps for getLogs. Simple Log Service does not use it when query
contains an analytic statement. The CamelAlibabaSlsReverse header replaces this
option for a request that the [...]
+ "to": { "index": 12, "kind": "parameter", "displayName": "To", "group":
"getLogs", "label": "getLogs", "required": false, "type": "integer",
"javaType": "java.lang.Integer", "deprecated": false, "autowired": false,
"secret": false, "description": "The end time for getLogs, as a Unix timestamp
in seconds. Simple Log Service requires an end time. The CamelAlibabaSlsTo
header replaces this option for a request that the producer sends. If that
header is not set, an exchange property of t [...]
+ "topic": { "index": 13, "kind": "parameter", "displayName": "Topic",
"group": "getLogs", "label": "getLogs", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "The log topic for getLogs. The
CamelAlibabaSlsTopic 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, t [...]
+ "accessKey": { "index": 14, "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 Simple Log
Service. If not set, the accessKey of the serviceKeys option is used, and one
of the two is required. Not used [...]
+ "secretKey": { "index": 15, "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 Simple
Log Service. If not set, the secretKey of the serviceKeys option is used, and
one of the two is required. Not [...]
+ "serviceKeys": { "index": 16, "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-sls/src/main/docs/alibaba-sls-component.adoc
b/components/camel-alibaba/camel-alibaba-sls/src/main/docs/alibaba-sls-component.adoc
index 64eb2ca4a75f..7895564d1468 100644
---
a/components/camel-alibaba/camel-alibaba-sls/src/main/docs/alibaba-sls-component.adoc
+++
b/components/camel-alibaba/camel-alibaba-sls/src/main/docs/alibaba-sls-component.adoc
@@ -2,7 +2,7 @@
:doctitle: Alibaba Simple Log Service (SLS)
:shortname: alibaba-sls
:artifactid: camel-alibaba-sls
-:description: Manage logs on Alibaba Cloud Simple Log Service (SLS).
+:description: Write logs, query logs, and list Logstores on Alibaba Cloud
Simple Log Service (SLS).
:since: 4.23
:supportlevel: Preview
:tabs-sync-option:
diff --git
a/components/camel-alibaba/camel-alibaba-sls/src/main/java/org/apache/camel/component/alibaba/sls/AlibabaSlsEndpoint.java
b/components/camel-alibaba/camel-alibaba-sls/src/main/java/org/apache/camel/component/alibaba/sls/AlibabaSlsEndpoint.java
index bb207583131a..fb22162b3531 100644
---
a/components/camel-alibaba/camel-alibaba-sls/src/main/java/org/apache/camel/component/alibaba/sls/AlibabaSlsEndpoint.java
+++
b/components/camel-alibaba/camel-alibaba-sls/src/main/java/org/apache/camel/component/alibaba/sls/AlibabaSlsEndpoint.java
@@ -33,7 +33,7 @@ import org.apache.camel.spi.UriPath;
import org.apache.camel.support.DefaultEndpoint;
/**
- * Manage logs on Alibaba Cloud Simple Log Service (SLS).
+ * Write logs, query logs, and list Logstores on Alibaba Cloud Simple Log
Service (SLS).
*/
@UriEndpoint(firstVersion = "4.23.0", scheme = "alibaba-sls", title = "Alibaba
Simple Log Service (SLS)",
syntax = "alibaba-sls:operation", category = { Category.CLOUD,
Category.MONITORING },
@@ -49,63 +49,128 @@ import org.apache.camel.support.DefaultEndpoint;
+ " the names under logstores
with count and total"))
public class AlibabaSlsEndpoint extends DefaultEndpoint {
- @UriPath(description = "Operation to perform", displayName = "Operation",
label = "producer",
+ @UriPath(description = "The operation that the producer performs. The
CamelAlibabaSlsOperation 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 = "putLogs,getLogs,listLogStores")
@Metadata(required = true)
private String operation;
- @UriParam(description = "Alibaba Cloud region", displayName = "Region")
+ @UriParam(description = "The region ID of Simple Log Service, for example
cn-hangzhou. Only used when the endpoint"
+ + " option is not set, to build the endpoint of
Simple Log Service. Not used when the"
+ + " slsClient option is set or autowired.",
+ displayName = "Region")
private String region;
- @UriParam(description = "SLS endpoint URL (e.g.
cn-hangzhou.log.aliyuncs.com). "
- + "Carries higher precedence than region based
client initialization",
+ @UriParam(description = "The endpoint of Simple Log Service, which is a
host name without http:// or https://, for"
+ + " example cn-hangzhou.log.aliyuncs.com. The
producer sends requests over HTTPS to the"
+ + " endpoint, with the name of the project in
front of it. If not set, the region option"
+ + " determines the endpoint, and one of the two is
required. Not used when the slsClient"
+ + " option is set or autowired.",
displayName = "Endpoint")
private String endpoint;
- @UriParam(description = "Access key for the cloud user", displayName =
"Access Key", security = "secret",
+ @UriParam(description = "The AccessKey ID of the AccessKey pair for the
requests that the producer sends to Simple"
+ + " Log Service. If not set, the accessKey of the
serviceKeys option is used, and one of"
+ + " the two is required. Not used when the
slsClient 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",
+ @UriParam(description = "The AccessKey secret of the AccessKey pair for
the requests that the producer sends to"
+ + " Simple Log Service. If not set, the secretKey
of the serviceKeys option is used, and"
+ + " one of the two is required. Not used when the
slsClient 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",
+ @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"
+ + " slsClient option is set or autowired.",
+ displayName = "Service Keys",
security = "secret", label = "security")
private ServiceKeys serviceKeys;
- @UriParam(description = "SLS project name", displayName = "Project")
+ @UriParam(description = "The name of the project. The
CamelAlibabaSlsProject 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 = "Project")
private String project;
- @UriParam(description = "SLS log store name", displayName = "Log Store
Name")
+ @UriParam(description = "The name of the Logstore for putLogs and getLogs.
The producer writes the logs to this"
+ + " Logstore for putLogs, and queries its logs for
getLogs. The"
+ + " CamelAlibabaSlsLogStoreName 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 for putLogs and getLogs.",
+ displayName = "Log Store Name")
private String logStoreName;
- @UriParam(description = "Log query string for getLogs", displayName =
"Query", label = "getLogs")
+ @UriParam(description = "The search statement or analytic statement for
getLogs. The CamelAlibabaSlsQuery 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 search statement or
analytic statement to the request.",
+ displayName = "Query", label = "getLogs")
private String query;
- @UriParam(description = "Query start time for getLogs (Unix timestamp in
seconds)", displayName = "From",
+ @UriParam(description = "The start time for getLogs, as a Unix timestamp
in seconds. Simple Log Service requires a"
+ + " start time. The CamelAlibabaSlsFrom 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 start time to"
+ + " the request.",
+ displayName = "From",
label = "getLogs")
private Integer from;
- @UriParam(description = "Query end time for getLogs (Unix timestamp in
seconds)", displayName = "To",
+ @UriParam(description = "The end time for getLogs, as a Unix timestamp in
seconds. Simple Log Service requires an"
+ + " end time. The CamelAlibabaSlsTo 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 end time to"
+ + " the request.",
+ displayName = "To",
label = "getLogs")
private Integer to;
- @UriParam(description = "Maximum number of log lines to return for
getLogs", displayName = "Line",
+ @UriParam(description = "The maximum number of logs to return for getLogs.
Simple Log Service accepts a value of"
+ + " at most 100. Simple Log Service does not use
it when query contains an analytic"
+ + " statement. The CamelAlibabaSlsLine 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 maximum number"
+ + " of logs to the request.",
+ displayName = "Line",
label = "getLogs")
private Long line;
- @UriParam(description = "Log query offset for getLogs", displayName =
"Offset", label = "getLogs")
+ @UriParam(description = "The offset of the first log to return for
getLogs. Simple Log Service does not use it"
+ + " when query contains an analytic statement. The
CamelAlibabaSlsOffset 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 offset to the request.",
+ displayName = "Offset", label = "getLogs")
private Long offset;
- @UriParam(description = "Log topic filter for getLogs", displayName =
"Topic", label = "getLogs")
+ @UriParam(description = "The log topic for getLogs. The
CamelAlibabaSlsTopic 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"
+ + " log topic to the request.",
+ displayName = "Topic", label = "getLogs")
private String topic;
- @UriParam(description = "Whether to return logs in reverse order for
getLogs", displayName = "Reverse",
+ @UriParam(description = "Whether to return logs in descending order of log
timestamps for getLogs. Simple Log"
+ + " Service does not use it when query contains an
analytic statement. The"
+ + " CamelAlibabaSlsReverse 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 sort order to the request.",
+ displayName = "Reverse",
label = "getLogs")
private Boolean reverse;
- @UriParam(description = "Autowire an existing SLS client instance",
displayName = "SLS Client", label = "advanced")
+ @UriParam(description = "To use a custom com.aliyun.sls20201230.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 = "SLS Client", label = "advanced")
@Metadata(autowired = true)
private Client slsClient;
diff --git
a/components/camel-alibaba/camel-alibaba-sls/src/main/java/org/apache/camel/component/alibaba/sls/constants/AlibabaSlsHeaders.java
b/components/camel-alibaba/camel-alibaba-sls/src/main/java/org/apache/camel/component/alibaba/sls/constants/AlibabaSlsHeaders.java
index 2f24d11d2b9e..98748f953981 100644
---
a/components/camel-alibaba/camel-alibaba-sls/src/main/java/org/apache/camel/component/alibaba/sls/constants/AlibabaSlsHeaders.java
+++
b/components/camel-alibaba/camel-alibaba-sls/src/main/java/org/apache/camel/component/alibaba/sls/constants/AlibabaSlsHeaders.java
@@ -20,55 +20,126 @@ import org.apache.camel.spi.Metadata;
public final class AlibabaSlsHeaders {
- @Metadata(label = "producer", description = "Operation override", javaType
= "String")
+ @Metadata(label = "producer",
+ description = "The operation that the producer performs. This
header replaces the operation option. If"
+ + " this header is not set, an exchange property
of the same name replaces the operation"
+ + " option.",
+ javaType = "String")
public static final String OPERATION = AlibabaSlsProperties.OPERATION;
- @Metadata(label = "producer", description = "SLS project name override",
javaType = "String")
+ @Metadata(label = "producer",
+ description = "The name of the project. This header replaces the
project option. If this header is not"
+ + " set, an exchange property of the same name
replaces the project option.",
+ javaType = "String")
public static final String PROJECT = AlibabaSlsProperties.PROJECT;
- @Metadata(label = "producer", description = "SLS log store name override",
javaType = "String")
+ @Metadata(label = "producer",
+ description = "The name of the Logstore for putLogs and getLogs.
The producer writes the logs to this"
+ + " Logstore for putLogs, and queries its logs for
getLogs. This header replaces the"
+ + " logStoreName option. If this header is not
set, an exchange property of the same name"
+ + " replaces the logStoreName option.",
+ javaType = "String")
public static final String LOG_STORE_NAME =
AlibabaSlsProperties.LOG_STORE_NAME;
- @Metadata(label = "producer", description = "Log query string override",
javaType = "String")
+ @Metadata(label = "producer",
+ description = "The search statement or analytic statement for
getLogs. This header replaces the query"
+ + " option. If this header is not set, an exchange
property of the same name replaces the"
+ + " query option.",
+ javaType = "String")
public static final String QUERY = AlibabaSlsProperties.QUERY;
- @Metadata(label = "producer", description = "Query start time override
(Unix timestamp in seconds)", javaType = "Integer")
+ @Metadata(label = "producer",
+ description = "The start time for getLogs, as a Unix timestamp
in seconds. Simple Log Service requires a"
+ + " start time. This header replaces the from
option. If this header is not set, an"
+ + " exchange property of the same name replaces
the from option.",
+ javaType = "Integer")
public static final String FROM = AlibabaSlsProperties.FROM;
- @Metadata(label = "producer", description = "Query end time override (Unix
timestamp in seconds)", javaType = "Integer")
+ @Metadata(label = "producer",
+ description = "The end time for getLogs, as a Unix timestamp in
seconds. Simple Log Service requires an"
+ + " end time. This header replaces the to option.
If this header is not set, an exchange"
+ + " property of the same name replaces the to
option.",
+ javaType = "Integer")
public static final String TO = AlibabaSlsProperties.TO;
- @Metadata(label = "producer", description = "Maximum number of log lines
to return", javaType = "Long")
+ @Metadata(label = "producer",
+ description = "The maximum number of logs to return for getLogs.
Simple Log Service accepts a value of"
+ + " at most 100. Simple Log Service does not use
it when query contains an analytic"
+ + " statement. This header replaces the line
option. If this header is not set, an"
+ + " exchange property of the same name replaces
the line option.",
+ javaType = "Long")
public static final String LINE = AlibabaSlsProperties.LINE;
- @Metadata(label = "producer", description = "Log query offset", javaType =
"Long")
+ @Metadata(label = "producer",
+ description = "The offset of the first log to return for
getLogs. Simple Log Service does not use it"
+ + " when query contains an analytic statement.
This header replaces the offset option. If"
+ + " this header is not set, an exchange property
of the same name replaces the offset"
+ + " option.",
+ javaType = "Long")
public static final String OFFSET = AlibabaSlsProperties.OFFSET;
- @Metadata(label = "producer", description = "Log topic filter override",
javaType = "String")
+ @Metadata(label = "producer",
+ description = "The log topic for getLogs. This header replaces
the topic option. If this header is not"
+ + " set, an exchange property of the same name
replaces the topic option.",
+ javaType = "String")
public static final String TOPIC = AlibabaSlsProperties.TOPIC;
- @Metadata(label = "producer", description = "Whether to return logs in
reverse order", javaType = "Boolean")
+ @Metadata(label = "producer",
+ description = "Whether to return logs in descending order of log
timestamps for getLogs. Simple Log"
+ + " Service does not use it when query contains an
analytic statement. This header"
+ + " replaces the reverse option. If this header is
not set, an exchange property of the"
+ + " same name replaces the reverse option.",
+ javaType = "Boolean")
public static final String REVERSE = AlibabaSlsProperties.REVERSE;
- @Metadata(label = "producer", description = "Log store name prefix filter
for listLogStores", javaType = "String")
+ @Metadata(label = "producer",
+ description = "The name of the Logstore for listLogStores.
Simple Log Service returns the Logstores"
+ + " whose name contains the value. If this header
is not set, the producer uses an"
+ + " exchange property of the same name. If neither
of the two is set, the producer adds no"
+ + " Logstore name to the request.",
+ javaType = "String")
public static final String LOGSTORE_NAME =
AlibabaSlsProperties.LOGSTORE_NAME;
- @Metadata(label = "producer", description = "List mode for listLogStores",
javaType = "String")
+ @Metadata(label = "producer",
+ description = "The type of the Logstore for listLogStores. The
value must be standard or query. If this"
+ + " header is not set, the producer uses an
exchange property of the same name. If neither"
+ + " of the two is set, the producer adds no
Logstore type to the request.",
+ javaType = "String")
public static final String MODE = AlibabaSlsProperties.MODE;
- @Metadata(label = "producer", description = "Page size for listLogStores",
javaType = "Integer")
+ @Metadata(label = "producer",
+ description = "The number of entries per page for listLogStores.
Simple Log Service accepts a value of"
+ + " at most 500. If this header is not set, the
producer uses an exchange property of the"
+ + " same name. If neither of the two is set, the
producer adds no number of entries per"
+ + " page to the request.",
+ javaType = "Integer")
public static final String SIZE = AlibabaSlsProperties.SIZE;
- @Metadata(label = "producer", description = "Pagination offset for
listLogStores", javaType = "Integer")
+ @Metadata(label = "producer",
+ description = "The offset of the first Logstore to return for
listLogStores. If this header is not set,"
+ + " the producer uses an exchange property of the
same name. If neither of the two is set,"
+ + " the producer adds no offset to the request.",
+ javaType = "Integer")
public static final String LIST_OFFSET = AlibabaSlsProperties.LIST_OFFSET;
- @Metadata(label = "producer", description = "Telemetry type filter for
listLogStores", javaType = "String")
+ @Metadata(label = "producer",
+ description = "The telemetry type for listLogStores. The value
must be None for logs or Metrics for"
+ + " metrics. If this header is not set, the
producer uses an exchange property of the same"
+ + " name. If neither of the two is set, the
producer adds no telemetry type to the"
+ + " request.",
+ javaType = "String")
public static final String TELEMETRY_TYPE =
AlibabaSlsProperties.TELEMETRY_TYPE;
- @Metadata(label = "producer", description = "Alibaba Cloud request id",
javaType = "String")
+ @Metadata(label = "producer",
+ description = "The request ID that Simple Log Service returns in
the response to the operation. The"
+ + " producer sets it when the response has one.",
+ javaType = "String")
public static final String REQUEST_ID = AlibabaSlsProperties.REQUEST_ID;
- @Metadata(label = "producer", description = "HTTP status code from SLS
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 = AlibabaSlsProperties.STATUS_CODE;
private AlibabaSlsHeaders() {
diff --git
a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java
b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java
index 8c0083fd298c..33a09235e26a 100644
---
a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java
+++
b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java
@@ -208,7 +208,8 @@ public interface ComponentsBuilderFactory {
}
/**
* Alibaba Simple Log Service (SLS) (camel-alibaba-sls)
- * Manage logs on Alibaba Cloud Simple Log Service (SLS).
+ * Write logs, query logs, and list Logstores on Alibaba Cloud Simple Log
+ * Service (SLS).
*
* Category: cloud,monitoring
* Since: 4.23
diff --git
a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/AlibabaSlsComponentBuilderFactory.java
b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/AlibabaSlsComponentBuilderFactory.java
index ebaa93021f06..0df36e41aed7 100644
---
a/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/AlibabaSlsComponentBuilderFactory.java
+++
b/dsl/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/AlibabaSlsComponentBuilderFactory.java
@@ -24,7 +24,8 @@ import org.apache.camel.builder.component.ComponentBuilder;
import org.apache.camel.component.alibaba.sls.AlibabaSlsComponent;
/**
- * Manage logs on Alibaba Cloud Simple Log Service (SLS).
+ * Write logs, query logs, and list Logstores on Alibaba Cloud Simple Log
+ * Service (SLS).
*
* Generated by camel build tools - do NOT edit this file!
*/
@@ -33,7 +34,8 @@ public interface AlibabaSlsComponentBuilderFactory {
/**
* Alibaba Simple Log Service (SLS) (camel-alibaba-sls)
- * Manage logs on Alibaba Cloud Simple Log Service (SLS).
+ * Write logs, query logs, and list Logstores on Alibaba Cloud Simple Log
+ * Service (SLS).
*
* Category: cloud,monitoring
* Since: 4.23
diff --git
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointHeaderBuilders.java
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointHeaderBuilders.java
index 0710ceb8f461..39a2986ca1a2 100644
---
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointHeaderBuilders.java
+++
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointHeaderBuilders.java
@@ -188,7 +188,8 @@ public class EndpointHeaderBuilders {
}
/**
* Alibaba Simple Log Service (SLS) (camel-alibaba-sls)
- * Manage logs on Alibaba Cloud Simple Log Service (SLS).
+ * Write logs, query logs, and list Logstores on Alibaba Cloud Simple Log
+ * Service (SLS).
*
* Category: cloud,monitoring
* Since: 4.23
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 b8602a81ad29..9c35dd2103c1 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
@@ -584,7 +584,8 @@ public class StaticEndpointBuilders {
}
/**
* Alibaba Simple Log Service (SLS) (camel-alibaba-sls)
- * Manage logs on Alibaba Cloud Simple Log Service (SLS).
+ * Write logs, query logs, and list Logstores on Alibaba Cloud Simple Log
+ * Service (SLS).
*
* Category: cloud,monitoring
* Since: 4.23
@@ -593,7 +594,10 @@ public class StaticEndpointBuilders {
* Syntax: <code>alibaba-sls:operation</code>
*
* Path parameter: operation (required)
- * Operation to perform
+ * The operation that the producer performs. The CamelAlibabaSlsOperation
+ * 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 3 enums and the value can be one of: putLogs, getLogs,
* listLogStores
*
@@ -605,7 +609,8 @@ public class StaticEndpointBuilders {
}
/**
* Alibaba Simple Log Service (SLS) (camel-alibaba-sls)
- * Manage logs on Alibaba Cloud Simple Log Service (SLS).
+ * Write logs, query logs, and list Logstores on Alibaba Cloud Simple Log
+ * Service (SLS).
*
* Category: cloud,monitoring
* Since: 4.23
@@ -614,7 +619,10 @@ public class StaticEndpointBuilders {
* Syntax: <code>alibaba-sls:operation</code>
*
* Path parameter: operation (required)
- * Operation to perform
+ * The operation that the producer performs. The CamelAlibabaSlsOperation
+ * 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 3 enums and the value can be one of: putLogs, getLogs,
* listLogStores
*
diff --git
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/AlibabaSlsEndpointBuilderFactory.java
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/AlibabaSlsEndpointBuilderFactory.java
index 0778ad1dbf84..445740fceb3d 100644
---
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/AlibabaSlsEndpointBuilderFactory.java
+++
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/AlibabaSlsEndpointBuilderFactory.java
@@ -27,7 +27,8 @@ import org.apache.camel.builder.EndpointProducerBuilder;
import org.apache.camel.builder.endpoint.AbstractEndpointBuilder;
/**
- * Manage logs on Alibaba Cloud Simple Log Service (SLS).
+ * Write logs, query logs, and list Logstores on Alibaba Cloud Simple Log
+ * Service (SLS).
*
* Generated by camel build tools - do NOT edit this file!
*/
@@ -45,8 +46,12 @@ public interface AlibabaSlsEndpointBuilderFactory {
}
/**
- * SLS endpoint URL (e.g. cn-hangzhou.log.aliyuncs.com). Carries higher
- * precedence than region based client initialization.
+ * The endpoint of Simple Log Service, which is a host name without
+ * http:// or https://, for example cn-hangzhou.log.aliyuncs.com. The
+ * producer sends requests over HTTPS to the endpoint, with the name of
+ * the project in front of it. If not set, the region option determines
+ * the endpoint, and one of the two is required. Not used when the
+ * slsClient option is set or autowired.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -60,7 +65,12 @@ public interface AlibabaSlsEndpointBuilderFactory {
return this;
}
/**
- * SLS log store name.
+ * The name of the Logstore for putLogs and getLogs. The producer
writes
+ * the logs to this Logstore for putLogs, and queries its logs for
+ * getLogs. The CamelAlibabaSlsLogStoreName 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 for putLogs and getLogs.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -74,7 +84,10 @@ public interface AlibabaSlsEndpointBuilderFactory {
return this;
}
/**
- * SLS project name.
+ * The name of the project. The CamelAlibabaSlsProject 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.
*
@@ -88,7 +101,10 @@ public interface AlibabaSlsEndpointBuilderFactory {
return this;
}
/**
- * Alibaba Cloud region.
+ * The region ID of Simple Log Service, for example cn-hangzhou. Only
+ * used when the endpoint option is not set, to build the endpoint of
+ * Simple Log Service. Not used when the slsClient option is set or
+ * autowired.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -102,7 +118,12 @@ public interface AlibabaSlsEndpointBuilderFactory {
return this;
}
/**
- * Query start time for getLogs (Unix timestamp in seconds).
+ * The start time for getLogs, as a Unix timestamp in seconds. Simple
+ * Log Service requires a start time. The CamelAlibabaSlsFrom 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 start
+ * time to the request.
*
* The option is a: <code>java.lang.Integer</code> type.
*
@@ -116,7 +137,12 @@ public interface AlibabaSlsEndpointBuilderFactory {
return this;
}
/**
- * Query start time for getLogs (Unix timestamp in seconds).
+ * The start time for getLogs, as a Unix timestamp in seconds. Simple
+ * Log Service requires a start time. The CamelAlibabaSlsFrom 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 start
+ * time to the request.
*
* The option will be converted to a <code>java.lang.Integer</code>
* type.
@@ -131,7 +157,13 @@ public interface AlibabaSlsEndpointBuilderFactory {
return this;
}
/**
- * Maximum number of log lines to return for getLogs.
+ * The maximum number of logs to return for getLogs. Simple Log Service
+ * accepts a value of at most 100. Simple Log Service does not use it
+ * when query contains an analytic statement. The CamelAlibabaSlsLine
+ * 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 maximum number of logs to the request.
*
* The option is a: <code>java.lang.Long</code> type.
*
@@ -145,7 +177,13 @@ public interface AlibabaSlsEndpointBuilderFactory {
return this;
}
/**
- * Maximum number of log lines to return for getLogs.
+ * The maximum number of logs to return for getLogs. Simple Log Service
+ * accepts a value of at most 100. Simple Log Service does not use it
+ * when query contains an analytic statement. The CamelAlibabaSlsLine
+ * 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 maximum number of logs to the request.
*
* The option will be converted to a <code>java.lang.Long</code> type.
*
@@ -159,7 +197,12 @@ public interface AlibabaSlsEndpointBuilderFactory {
return this;
}
/**
- * Log query offset for getLogs.
+ * The offset of the first log to return for getLogs. Simple Log
Service
+ * does not use it when query contains an analytic statement. The
+ * CamelAlibabaSlsOffset 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 offset to the request.
*
* The option is a: <code>java.lang.Long</code> type.
*
@@ -173,7 +216,12 @@ public interface AlibabaSlsEndpointBuilderFactory {
return this;
}
/**
- * Log query offset for getLogs.
+ * The offset of the first log to return for getLogs. Simple Log
Service
+ * does not use it when query contains an analytic statement. The
+ * CamelAlibabaSlsOffset 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 offset to the request.
*
* The option will be converted to a <code>java.lang.Long</code> type.
*
@@ -187,7 +235,12 @@ public interface AlibabaSlsEndpointBuilderFactory {
return this;
}
/**
- * Log query string for getLogs.
+ * The search statement or analytic statement for getLogs. The
+ * CamelAlibabaSlsQuery 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 search statement or analytic statement to the
+ * request.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -201,7 +254,13 @@ public interface AlibabaSlsEndpointBuilderFactory {
return this;
}
/**
- * Whether to return logs in reverse order for getLogs.
+ * Whether to return logs in descending order of log timestamps for
+ * getLogs. Simple Log Service does not use it when query contains an
+ * analytic statement. The CamelAlibabaSlsReverse 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 sort order to the
+ * request.
*
* The option is a: <code>java.lang.Boolean</code> type.
*
@@ -215,7 +274,13 @@ public interface AlibabaSlsEndpointBuilderFactory {
return this;
}
/**
- * Whether to return logs in reverse order for getLogs.
+ * Whether to return logs in descending order of log timestamps for
+ * getLogs. Simple Log Service does not use it when query contains an
+ * analytic statement. The CamelAlibabaSlsReverse 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 sort order to the
+ * request.
*
* The option will be converted to a <code>java.lang.Boolean</code>
* type.
@@ -230,7 +295,12 @@ public interface AlibabaSlsEndpointBuilderFactory {
return this;
}
/**
- * Query end time for getLogs (Unix timestamp in seconds).
+ * The end time for getLogs, as a Unix timestamp in seconds. Simple Log
+ * Service requires an end time. The CamelAlibabaSlsTo 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 end time to the
+ * request.
*
* The option is a: <code>java.lang.Integer</code> type.
*
@@ -244,7 +314,12 @@ public interface AlibabaSlsEndpointBuilderFactory {
return this;
}
/**
- * Query end time for getLogs (Unix timestamp in seconds).
+ * The end time for getLogs, as a Unix timestamp in seconds. Simple Log
+ * Service requires an end time. The CamelAlibabaSlsTo 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 end time to the
+ * request.
*
* The option will be converted to a <code>java.lang.Integer</code>
* type.
@@ -259,7 +334,11 @@ public interface AlibabaSlsEndpointBuilderFactory {
return this;
}
/**
- * Log topic filter for getLogs.
+ * The log topic for getLogs. The CamelAlibabaSlsTopic 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 log topic to the
+ * request.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -273,7 +352,10 @@ public interface AlibabaSlsEndpointBuilderFactory {
return this;
}
/**
- * Access key for the cloud user.
+ * The AccessKey ID of the AccessKey pair for the requests that the
+ * producer sends to Simple Log Service. If not set, the accessKey of
+ * the serviceKeys option is used, and one of the two is required. Not
+ * used when the slsClient option is set or autowired.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -287,7 +369,10 @@ public interface AlibabaSlsEndpointBuilderFactory {
return this;
}
/**
- * Secret key for the cloud user.
+ * The AccessKey secret of the AccessKey pair for the requests that the
+ * producer sends to Simple Log Service. If not set, the secretKey of
+ * the serviceKeys option is used, and one of the two is required. Not
+ * used when the slsClient option is set or autowired.
*
* The option is a: <code>java.lang.String</code> type.
*
@@ -301,7 +386,11 @@ public interface AlibabaSlsEndpointBuilderFactory {
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 slsClient option is set or autowired.
*
* The option is a:
*
<code>org.apache.camel.component.alibaba.common.models.ServiceKeys</code> type.
@@ -316,7 +405,11 @@ public interface AlibabaSlsEndpointBuilderFactory {
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 slsClient option is set or autowired.
*
* The option will be converted to a
*
<code>org.apache.camel.component.alibaba.common.models.ServiceKeys</code> type.
@@ -389,7 +482,11 @@ public interface AlibabaSlsEndpointBuilderFactory {
return this;
}
/**
- * Autowire an existing SLS client instance.
+ * To use a custom com.aliyun.sls20201230.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.sls20201230.Client</code> type.
*
@@ -403,7 +500,11 @@ public interface AlibabaSlsEndpointBuilderFactory {
return this;
}
/**
- * Autowire an existing SLS client instance.
+ * To use a custom com.aliyun.sls20201230.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.sls20201230.Client</code> type.
@@ -422,7 +523,8 @@ public interface AlibabaSlsEndpointBuilderFactory {
public interface AlibabaSlsBuilders {
/**
* Alibaba Simple Log Service (SLS) (camel-alibaba-sls)
- * Manage logs on Alibaba Cloud Simple Log Service (SLS).
+ * Write logs, query logs, and list Logstores on Alibaba Cloud Simple
+ * Log Service (SLS).
*
* Category: cloud,monitoring
* Since: 4.23
@@ -435,7 +537,8 @@ public interface AlibabaSlsEndpointBuilderFactory {
}
/**
* Alibaba Simple Log Service (SLS) (camel-alibaba-sls)
- * Manage logs on Alibaba Cloud Simple Log Service (SLS).
+ * Write logs, query logs, and list Logstores on Alibaba Cloud Simple
+ * Log Service (SLS).
*
* Category: cloud,monitoring
* Since: 4.23
@@ -444,7 +547,10 @@ public interface AlibabaSlsEndpointBuilderFactory {
* Syntax: <code>alibaba-sls:operation</code>
*
* Path parameter: operation (required)
- * Operation to perform
+ * The operation that the producer performs. The
+ * CamelAlibabaSlsOperation 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 3 enums and the value can be one of: putLogs, getLogs,
* listLogStores
*
@@ -456,7 +562,8 @@ public interface AlibabaSlsEndpointBuilderFactory {
}
/**
* Alibaba Simple Log Service (SLS) (camel-alibaba-sls)
- * Manage logs on Alibaba Cloud Simple Log Service (SLS).
+ * Write logs, query logs, and list Logstores on Alibaba Cloud Simple
+ * Log Service (SLS).
*
* Category: cloud,monitoring
* Since: 4.23
@@ -465,7 +572,10 @@ public interface AlibabaSlsEndpointBuilderFactory {
* Syntax: <code>alibaba-sls:operation</code>
*
* Path parameter: operation (required)
- * Operation to perform
+ * The operation that the producer performs. The
+ * CamelAlibabaSlsOperation 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 3 enums and the value can be one of: putLogs, getLogs,
* listLogStores
*
@@ -490,7 +600,9 @@ public interface AlibabaSlsEndpointBuilderFactory {
public static final AlibabaSlsHeaderNameBuilder INSTANCE = new
AlibabaSlsHeaderNameBuilder();
/**
- * Operation override.
+ * The operation that the producer performs. This header replaces the
+ * operation option. If this header is not set, an exchange property of
+ * the same name replaces the operation option.
*
* The option is a: {@code String} type.
*
@@ -502,7 +614,9 @@ public interface AlibabaSlsEndpointBuilderFactory {
return "CamelAlibabaSlsOperation";
}
/**
- * SLS project name override.
+ * The name of the project. This header replaces the project option. If
+ * this header is not set, an exchange property of the same name
+ * replaces the project option.
*
* The option is a: {@code String} type.
*
@@ -514,7 +628,11 @@ public interface AlibabaSlsEndpointBuilderFactory {
return "CamelAlibabaSlsProject";
}
/**
- * SLS log store name override.
+ * The name of the Logstore for putLogs and getLogs. The producer
writes
+ * the logs to this Logstore for putLogs, and queries its logs for
+ * getLogs. This header replaces the logStoreName option. If this
header
+ * is not set, an exchange property of the same name replaces the
+ * logStoreName option.
*
* The option is a: {@code String} type.
*
@@ -526,7 +644,9 @@ public interface AlibabaSlsEndpointBuilderFactory {
return "CamelAlibabaSlsLogStoreName";
}
/**
- * Log query string override.
+ * The search statement or analytic statement for getLogs. This header
+ * replaces the query option. If this header is not set, an exchange
+ * property of the same name replaces the query option.
*
* The option is a: {@code String} type.
*
@@ -538,7 +658,10 @@ public interface AlibabaSlsEndpointBuilderFactory {
return "CamelAlibabaSlsQuery";
}
/**
- * Query start time override (Unix timestamp in seconds).
+ * The start time for getLogs, as a Unix timestamp in seconds. Simple
+ * Log Service requires a start time. This header replaces the from
+ * option. If this header is not set, an exchange property of the same
+ * name replaces the from option.
*
* The option is a: {@code Integer} type.
*
@@ -550,7 +673,10 @@ public interface AlibabaSlsEndpointBuilderFactory {
return "CamelAlibabaSlsFrom";
}
/**
- * Query end time override (Unix timestamp in seconds).
+ * The end time for getLogs, as a Unix timestamp in seconds. Simple Log
+ * Service requires an end time. This header replaces the to option. If
+ * this header is not set, an exchange property of the same name
+ * replaces the to option.
*
* The option is a: {@code Integer} type.
*
@@ -562,7 +688,11 @@ public interface AlibabaSlsEndpointBuilderFactory {
return "CamelAlibabaSlsTo";
}
/**
- * Maximum number of log lines to return.
+ * The maximum number of logs to return for getLogs. Simple Log Service
+ * accepts a value of at most 100. Simple Log Service does not use it
+ * when query contains an analytic statement. This header replaces the
+ * line option. If this header is not set, an exchange property of the
+ * same name replaces the line option.
*
* The option is a: {@code Long} type.
*
@@ -574,7 +704,10 @@ public interface AlibabaSlsEndpointBuilderFactory {
return "CamelAlibabaSlsLine";
}
/**
- * Log query offset.
+ * The offset of the first log to return for getLogs. Simple Log
Service
+ * does not use it when query contains an analytic statement. This
+ * header replaces the offset option. If this header is not set, an
+ * exchange property of the same name replaces the offset option.
*
* The option is a: {@code Long} type.
*
@@ -586,7 +719,9 @@ public interface AlibabaSlsEndpointBuilderFactory {
return "CamelAlibabaSlsOffset";
}
/**
- * Log topic filter override.
+ * The log topic for getLogs. This header replaces the topic option. If
+ * this header is not set, an exchange property of the same name
+ * replaces the topic option.
*
* The option is a: {@code String} type.
*
@@ -598,7 +733,11 @@ public interface AlibabaSlsEndpointBuilderFactory {
return "CamelAlibabaSlsTopic";
}
/**
- * Whether to return logs in reverse order.
+ * Whether to return logs in descending order of log timestamps for
+ * getLogs. Simple Log Service does not use it when query contains an
+ * analytic statement. This header replaces the reverse option. If this
+ * header is not set, an exchange property of the same name replaces
the
+ * reverse option.
*
* The option is a: {@code Boolean} type.
*
@@ -610,7 +749,11 @@ public interface AlibabaSlsEndpointBuilderFactory {
return "CamelAlibabaSlsReverse";
}
/**
- * Log store name prefix filter for listLogStores.
+ * The name of the Logstore for listLogStores. Simple Log Service
+ * returns the Logstores whose name contains the value. If this header
+ * is not set, the producer uses an exchange property of the same name.
+ * If neither of the two is set, the producer adds no Logstore name to
+ * the request.
*
* The option is a: {@code String} type.
*
@@ -622,7 +765,10 @@ public interface AlibabaSlsEndpointBuilderFactory {
return "CamelAlibabaSlsLogstoreName";
}
/**
- * List mode for listLogStores.
+ * The type of the Logstore for listLogStores. The value must be
+ * standard or query. If this header is not set, the producer uses an
+ * exchange property of the same name. If neither of the two is set,
the
+ * producer adds no Logstore type to the request.
*
* The option is a: {@code String} type.
*
@@ -634,7 +780,11 @@ public interface AlibabaSlsEndpointBuilderFactory {
return "CamelAlibabaSlsMode";
}
/**
- * Page size for listLogStores.
+ * The number of entries per page for listLogStores. Simple Log Service
+ * accepts a value of at most 500. If this header is not set, the
+ * producer uses an exchange property of the same name. If neither of
+ * the two is set, the producer adds no number of entries per page to
+ * the request.
*
* The option is a: {@code Integer} type.
*
@@ -646,7 +796,10 @@ public interface AlibabaSlsEndpointBuilderFactory {
return "CamelAlibabaSlsSize";
}
/**
- * Pagination offset for listLogStores.
+ * The offset of the first Logstore to return for listLogStores. If
this
+ * header is not set, the producer uses an exchange property of the
same
+ * name. If neither of the two is set, the producer adds no offset to
+ * the request.
*
* The option is a: {@code Integer} type.
*
@@ -658,7 +811,10 @@ public interface AlibabaSlsEndpointBuilderFactory {
return "CamelAlibabaSlsListOffset";
}
/**
- * Telemetry type filter for listLogStores.
+ * The telemetry type for listLogStores. The value must be None for
logs
+ * or Metrics for metrics. If this header is not set, the producer uses
+ * an exchange property of the same name. If neither of the two is set,
+ * the producer adds no telemetry type to the request.
*
* The option is a: {@code String} type.
*
@@ -670,7 +826,8 @@ public interface AlibabaSlsEndpointBuilderFactory {
return "CamelAlibabaSlsTelemetryType";
}
/**
- * Alibaba Cloud request id.
+ * The request ID that Simple Log Service returns in the response to
the
+ * operation. The producer sets it when the response has one.
*
* The option is a: {@code String} type.
*
@@ -682,7 +839,8 @@ public interface AlibabaSlsEndpointBuilderFactory {
return "CamelAlibabaSlsRequestId";
}
/**
- * HTTP status code from SLS 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.
*
diff --git a/tasks/component-descriptions.md b/tasks/component-descriptions.md
index 96e07a2cd506..2792593d3be2 100644
--- a/tasks/component-descriptions.md
+++ b/tasks/component-descriptions.md
@@ -64,7 +64,7 @@ or removes its row.
| camel-alibaba-mns | alibaba-mns | |
| camel-alibaba-oss | alibaba-oss | |
| camel-alibaba-ots | alibaba-ots | yes |
-| camel-alibaba-sls | alibaba-sls | |
+| camel-alibaba-sls | alibaba-sls | yes |
| camel-alibaba-sms | alibaba-sms | yes |
| camel-amqp | amqp | |
| camel-apicurio-registry | apicurio-registry | |