Skip to content

Commit

Permalink
CAMEL-16471 - documentation re-generated. updated endpoint related co…
Browse files Browse the repository at this point in the history
…nfiguration descriptions in SimpleNotificationEndpoint.java
  • Loading branch information
hokutor committed Apr 9, 2021
1 parent 2543ba1 commit e6b794d
Show file tree
Hide file tree
Showing 8 changed files with 86 additions and 66 deletions.
Expand Up @@ -71,13 +71,14 @@ with the following path and query parameters:
|===


=== Query Parameters (13 parameters):
=== Query Parameters (14 parameters):


[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *authKey* (producer) | *Required* Authentication key for the cloud user | | String
| *endpoint* (producer) | Fully qualified smn service url. Carries higher precedence than region parameter based client initialization | | String
| *ignoreSslVerification* (producer) | Ignore SSL verification | false | boolean
| *lazyStartProducer* (producer) | 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 producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | boolean
| *messageTtl* (producer) | TTL for published message | 3600 | int
Expand All @@ -87,7 +88,7 @@ with the following path and query parameters:
| *proxyPassword* (producer) | Proxy authentication password | | String
| *proxyPort* (producer) | Proxy server port | | int
| *proxyUser* (producer) | Proxy authentication user | | String
| *region* (producer) | *Required* SMN service region | | String
| *region* (producer) | *Required* SMN service region. This is lower precedence than endpoint based configuration | | String
| *secretKey* (producer) | *Required* Secret key for the cloud user | | String
| *serviceKeys* (producer) | Configuration object for cloud service authentication | | ServiceKeys
|===
Expand Down
Expand Up @@ -28,7 +28,7 @@
"properties": {
"smnService": { "kind": "path", "displayName": "Service name", "group": "producer", "label": "producer", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Name of SMN service to invoke" },
"authKey": { "kind": "parameter", "displayName": "API authentication key (AK)", "group": "producer", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": true, "description": "Authentication key for the cloud user" },
"endpoint": { "kind": "parameter", "displayName": "Service endpoint", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "SMN service endpoint" },
"endpoint": { "kind": "parameter", "displayName": "Service endpoint", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Fully qualified smn service url. Carries higher precedence than region parameter based client initialization" },
"ignoreSslVerification": { "kind": "parameter", "displayName": "SSL Verification Ignored", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "defaultValue": false, "description": "Ignore SSL verification" },
"lazyStartProducer": { "kind": "parameter", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "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 producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing." },
"messageTtl": { "kind": "parameter", "displayName": "Message TTL", "group": "producer", "label": "", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "defaultValue": 3600, "description": "TTL for published message" },
Expand All @@ -38,7 +38,7 @@
"proxyPassword": { "kind": "parameter", "displayName": "Proxy password", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": true, "description": "Proxy authentication password" },
"proxyPort": { "kind": "parameter", "displayName": "Proxy server port", "group": "producer", "label": "", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Proxy server port" },
"proxyUser": { "kind": "parameter", "displayName": "Proxy user", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": true, "description": "Proxy authentication user" },
"region": { "kind": "parameter", "displayName": "Service region", "group": "producer", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "SMN service region" },
"region": { "kind": "parameter", "displayName": "Service region", "group": "producer", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "SMN service region. This is lower precedence than endpoint based configuration" },
"secretKey": { "kind": "parameter", "displayName": "API secret key (SK)", "group": "producer", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": true, "description": "Secret key for the cloud user" },
"serviceKeys": { "kind": "parameter", "displayName": "Service Configuration", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.huaweicloud.smn.models.ServiceKeys", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": true, "description": "Configuration object for cloud service authentication" }
}
Expand Down
Expand Up @@ -78,8 +78,7 @@ with the following path and query parameters:
|===
| Name | Description | Default | Type
| *authKey* (producer) | *Required* Authentication key for the cloud user | | String
| *endpoint* (producer) | Fully qualified smn service url. Carries higher precedence than region parameter based client initialization| | String
| *region* (producer) | SMN service region. This is lower precedence than endpoint based configuration | | String
| *endpoint* (producer) | Fully qualified smn service url. Carries higher precedence than region parameter based client initialization | | String
| *ignoreSslVerification* (producer) | Ignore SSL verification | false | boolean
| *lazyStartProducer* (producer) | 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 producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | boolean
| *messageTtl* (producer) | TTL for published message | 3600 | int
Expand All @@ -89,6 +88,7 @@ with the following path and query parameters:
| *proxyPassword* (producer) | Proxy authentication password | | String
| *proxyPort* (producer) | Proxy server port | | int
| *proxyUser* (producer) | Proxy authentication user | | String
| *region* (producer) | *Required* SMN service region. This is lower precedence than endpoint based configuration | | String
| *secretKey* (producer) | *Required* Secret key for the cloud user | | String
| *serviceKeys* (producer) | Configuration object for cloud service authentication | | ServiceKeys
|===
Expand Down
Expand Up @@ -79,11 +79,13 @@ public class SimpleNotificationEndpoint extends DefaultEndpoint {
@Metadata(required = false)
private String proxyPassword;

@UriParam(description = "SMN service region", displayName = "Service region", secret = false)
@UriParam(description = "SMN service region. This is lower precedence than endpoint based configuration",
displayName = "Service region", secret = false)
@Metadata(required = true)
private String region;

@UriParam(description = "SMN service endpoint", displayName = "Service endpoint", secret = false)
@UriParam(description = "Fully qualified smn service url. Carries higher precedence than region parameter based client initialization",
displayName = "Service endpoint", secret = false)
@Metadata(required = false)
private String endpoint;

Expand Down

0 comments on commit e6b794d

Please sign in to comment.