camel.apache.org/opensearch
1
0
Fork 0
generated from camel.apache.org/component
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
master
opensearch/component.json

542 lines
18 KiB
JSON
Raw Permalink Blame History

{
"component": {
"kind": "component",
"name": "opensearch",
"title": "OpenSearch",
"description": "Send requests to OpenSearch via Java Client API.",
"deprecated": false,
"firstVersion": "4.0.0",
"label": "search,monitoring",
"javaType": "org.apache.camel.component.opensearch.OpensearchComponent",
"supportLevel": "Stable",
"groupId": "org.apache.camel",
"artifactId": "camel-opensearch",
"version": "4.10.2",
"scheme": "opensearch",
"extendsScheme": "",
"syntax": "opensearch:clusterName",
"async": false,
"api": false,
"consumerOnly": false,
"producerOnly": true,
"lenientProperties": false,
"browsable": false,
"remote": true
},
"headers": {
"operation": {
"index": 0,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "org.apache.camel.component.opensearch.OpensearchOperation",
"enum": [
"Index",
"Update",
"Bulk",
"GetById",
"MultiGet",
"MultiSearch",
"Delete",
"DeleteIndex",
"Search",
"Exists",
"Ping"
],
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The operation to perform",
"constantName": "org.apache.camel.component.opensearch.OpensearchConstants#PARAM_OPERATION"
},
"indexId": {
"index": 1,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The id of the indexed document.",
"constantName": "org.apache.camel.component.opensearch.OpensearchConstants#PARAM_INDEX_ID"
},
"indexName": {
"index": 2,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The name of the index to act against",
"constantName": "org.apache.camel.component.opensearch.OpensearchConstants#PARAM_INDEX_NAME"
},
"documentClass": {
"index": 3,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "Class",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"defaultValue": "ObjectNode",
"description": "The full qualified name of the class of the document to unmarshall",
"constantName": "org.apache.camel.component.opensearch.OpensearchConstants#PARAM_DOCUMENT_CLASS"
},
"waitForActiveShards": {
"index": 4,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "Integer",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The index creation waits for the write consistency number of shards to be available",
"constantName": "org.apache.camel.component.opensearch.OpensearchConstants#PARAM_WAIT_FOR_ACTIVE_SHARDS"
},
"scrollKeepAliveMs": {
"index": 5,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "Integer",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The starting index of the response.",
"constantName": "org.apache.camel.component.opensearch.OpensearchConstants#PARAM_SCROLL_KEEP_ALIVE_MS"
},
"useScroll": {
"index": 6,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "Boolean",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "Set to true to enable scroll usage",
"constantName": "org.apache.camel.component.opensearch.OpensearchConstants#PARAM_SCROLL"
},
"size": {
"index": 7,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "Integer",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The size of the response.",
"constantName": "org.apache.camel.component.opensearch.OpensearchConstants#PARAM_SIZE"
},
"from": {
"index": 8,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "Integer",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The starting index of the response.",
"constantName": "org.apache.camel.component.opensearch.OpensearchConstants#PARAM_FROM"
}
},
"properties": {
"clusterName": {
"index": 0,
"kind": "path",
"displayName": "Cluster Name",
"group": "producer",
"label": "",
"required": true,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.opensearch.OpensearchConfiguration",
"configurationField": "configuration",
"description": "Name of the cluster"
},
"connectionTimeout": {
"index": 1,
"kind": "parameter",
"displayName": "Connection Timeout",
"group": "producer",
"label": "",
"required": false,
"type": "integer",
"javaType": "int",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": 30000,
"configurationClass": "org.apache.camel.component.opensearch.OpensearchConfiguration",
"configurationField": "configuration",
"description": "The time in ms to wait before connection will time out."
},
"disconnect": {
"index": 2,
"kind": "parameter",
"displayName": "Disconnect",
"group": "producer",
"label": "",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"configurationClass": "org.apache.camel.component.opensearch.OpensearchConfiguration",
"configurationField": "configuration",
"description": "Disconnect after it finish calling the producer"
},
"from": {
"index": 3,
"kind": "parameter",
"displayName": "From",
"group": "producer",
"label": "",
"required": false,
"type": "integer",
"javaType": "java.lang.Integer",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.opensearch.OpensearchConfiguration",
"configurationField": "configuration",
"description": "Starting index of the response."
},
"hostAddresses": {
"index": 4,
"kind": "parameter",
"displayName": "Host Addresses",
"group": "producer",
"label": "",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.opensearch.OpensearchConfiguration",
"configurationField": "configuration",
"description": "Comma separated list with ip:port formatted remote transport addresses to use."
},
"indexName": {
"index": 5,
"kind": "parameter",
"displayName": "Index Name",
"group": "producer",
"label": "",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.opensearch.OpensearchConfiguration",
"configurationField": "configuration",
"description": "The name of the index to act against"
},
"maxRetryTimeout": {
"index": 6,
"kind": "parameter",
"displayName": "Max Retry Timeout",
"group": "producer",
"label": "",
"required": false,
"type": "integer",
"javaType": "int",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": 30000,
"configurationClass": "org.apache.camel.component.opensearch.OpensearchConfiguration",
"configurationField": "configuration",
"description": "The time in ms before retry"
},
"operation": {
"index": 7,
"kind": "parameter",
"displayName": "Operation",
"group": "producer",
"label": "",
"required": false,
"type": "object",
"javaType": "org.apache.camel.component.opensearch.OpensearchOperation",
"enum": [
"Index",
"Update",
"Bulk",
"GetById",
"MultiGet",
"MultiSearch",
"Delete",
"DeleteIndex",
"Search",
"Exists",
"Ping"
],
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.opensearch.OpensearchConfiguration",
"configurationField": "configuration",
"description": "What operation to perform"
},
"scrollKeepAliveMs": {
"index": 8,
"kind": "parameter",
"displayName": "Scroll Keep Alive Ms",
"group": "producer",
"label": "",
"required": false,
"type": "integer",
"javaType": "int",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": 60000,
"configurationClass": "org.apache.camel.component.opensearch.OpensearchConfiguration",
"configurationField": "configuration",
"description": "Time in ms during which OpenSearch will keep search context alive"
},
"size": {
"index": 9,
"kind": "parameter",
"displayName": "Size",
"group": "producer",
"label": "",
"required": false,
"type": "integer",
"javaType": "java.lang.Integer",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.opensearch.OpensearchConfiguration",
"configurationField": "configuration",
"description": "Size of the response."
},
"socketTimeout": {
"index": 10,
"kind": "parameter",
"displayName": "Socket Timeout",
"group": "producer",
"label": "",
"required": false,
"type": "integer",
"javaType": "int",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": 30000,
"configurationClass": "org.apache.camel.component.opensearch.OpensearchConfiguration",
"configurationField": "configuration",
"description": "The timeout in ms to wait before the socket will time out."
},
"useScroll": {
"index": 11,
"kind": "parameter",
"displayName": "Use Scroll",
"group": "producer",
"label": "",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"configurationClass": "org.apache.camel.component.opensearch.OpensearchConfiguration",
"configurationField": "configuration",
"description": "Enable scroll usage"
},
"waitForActiveShards": {
"index": 12,
"kind": "parameter",
"displayName": "Wait For Active Shards",
"group": "producer",
"label": "",
"required": false,
"type": "integer",
"javaType": "int",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": 1,
"configurationClass": "org.apache.camel.component.opensearch.OpensearchConfiguration",
"configurationField": "configuration",
"description": "Index creation waits for the write consistency number of shards to be available"
},
"lazyStartProducer": {
"index": 13,
"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 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."
},
"documentClass": {
"index": 14,
"kind": "parameter",
"displayName": "Document Class",
"group": "advanced",
"label": "advanced",
"required": false,
"type": "string",
"javaType": "java.lang.Class<java.lang.Object>",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": "ObjectNode",
"configurationClass": "org.apache.camel.component.opensearch.OpensearchConfiguration",
"configurationField": "configuration",
"description": "The class to use when deserializing the documents."
},
"enableSniffer": {
"index": 15,
"kind": "parameter",
"displayName": "Enable Sniffer",
"group": "advanced",
"label": "advanced",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"configurationClass": "org.apache.camel.component.opensearch.OpensearchConfiguration",
"configurationField": "configuration",
"description": "Enable automatically discover nodes from a running OpenSearch cluster. If this option is used in conjunction with Spring Boot, then it's managed by the Spring Boot configuration (see: Disable Sniffer in Spring Boot)."
},
"hostnameVerifier": {
"index": 16,
"kind": "parameter",
"displayName": "Hostname Verifier",
"group": "advanced",
"label": "advanced",
"required": false,
"type": "object",
"javaType": "javax.net.ssl.HostnameVerifier",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.opensearch.OpensearchConfiguration",
"configurationField": "configuration",
"description": "The class to use as HostnameVerifier. By default there is no HostnameVerifier."
},
"sniffAfterFailureDelay": {
"index": 17,
"kind": "parameter",
"displayName": "Sniff After Failure Delay",
"group": "advanced",
"label": "advanced",
"required": false,
"type": "integer",
"javaType": "int",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": 60000,
"configurationClass": "org.apache.camel.component.opensearch.OpensearchConfiguration",
"configurationField": "configuration",
"description": "The delay of a sniff execution scheduled after a failure (in milliseconds)"
},
"snifferInterval": {
"index": 18,
"kind": "parameter",
"displayName": "Sniffer Interval",
"group": "advanced",
"label": "advanced",
"required": false,
"type": "integer",
"javaType": "int",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": 300000,
"configurationClass": "org.apache.camel.component.opensearch.OpensearchConfiguration",
"configurationField": "configuration",
"description": "The interval between consecutive ordinary sniff executions in milliseconds. Will be honoured when sniffOnFailure is disabled or when there are no failures between consecutive sniff executions"
},
"certificatePath": {
"index": 19,
"kind": "parameter",
"displayName": "Certificate Path",
"group": "security",
"label": "security",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"supportFileReference": true,
"configurationClass": "org.apache.camel.component.opensearch.OpensearchConfiguration",
"configurationField": "configuration",
"description": "The certificate that can be used to access the ES Cluster. It can be loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems."
},
"enableSSL": {
"index": 20,
"kind": "parameter",
"displayName": "Enable SSL",
"group": "security",
"label": "security",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"configurationClass": "org.apache.camel.component.opensearch.OpensearchConfiguration",
"configurationField": "configuration",
"description": "Enable SSL"
}
}
}
Reference in New Issue View Git Blame Copy Permalink