Field | Required | Default | Multiple | Notes | Example |
---|---|---|---|---|---|
properties | Yes | - | No | Configuration object | |
elasticNoUrl | Yes | false | No | Selects how to enter the Elasticsearch URL. True: server and port are specified. False: full URL is specified. | true / false |
elasticUrl | No | - | No | Enter the URL for the Elasticsearch bulk index endpoint, it must have this format <protocol>://<host>:<port>/_bulk . Required if elasticNoUrl is false. | "http://myServer:9200" |
elasticHost | No | - | No | Enter the Elasticsearch host. Required if elasticNoUrl is true. | "myServer" |
elasticPort | No | 9200 | No | Enter the Elasticsearch port. Required if elasticNoUrl is true. | "9201" |
elasticIndex | Yes | - | No | Enter the index to which the jobs are going to be publish. | "test-index" |
authType | No | - | No | Specify the authentication information. Allowed values are: "none", "basic" and "aws". | "none" |
user | No | - | No | Provide the user for basic authentication. Required if authType is "basic". | "john.doe" |
password | No | - | No | Provide the password for basic authentication. Required if authType is "basic". | "myP@ssword11" |
awsRegion | No | - | No | Specify the AWS region to use. Required if authType is "aws". | "us-east-2" |
useCredentialsProviderChain | No | false | No | Enable to specify a credentials provider chain. | true / false |
awsAccessKey | No | - | No | Provide the access key for authentication with AWS. Required if authType is "aws" and useCredentialsProviderChain is false. | "AKIAQYO33L5HIS3N55NN" |
awsSecretKey | No | - | No | Provide the secret key for authentication with AWS. Required if authType is "aws" and useCredentialsProviderChain is false. | "PPA3Qt+FqUA4Kk07DRS7w4T6Bya1IWebbcqFmqmI" |
transformType | Yes | - | No | Type of the transformation file used. | "JSON" |
transformFile | Yes | - | No | Path to the transform file. The default value is set to "${component.home}/config/groovy/transform.groovy" for the default JSON transformation file provided with Aspire. | "C:\transformfiles\groovy\mytransform.groovy" |
processClear | No | false | No | Set to true to clear the index on full crawls. | true / false |
clearType | Yes if processClear = Yes | - | No | Type of the clear. 2 options here :
| "deleteAllDocuments" |
uploadMappings | No | false | No | Upload Mappings. Relevant for clearType "deleteIndex" | true / false |
uploadMappingsFrom | No | false | No | Source for the mappings. Required if uploadMappings is true. If uploadsMappingFrom is true the mappings will be used from the parameter below otherwise from the file | true / false |
mappingsText | No | - | No | Mappings specified directly. Required if uploadMappings is true and uploadMappingsFrom is true. | "{\"mappings\":{\"properties\":{\"doc._id\":{\"type\":\"text\",\"fields\":{\"keyword\":{\"type\":\"keyword\"}}}}}}" |
uploadMappingsFile | No | - | No | Mappings file path. Required if uploadMappings is true and uploadMappingsFrom is false. | "C:\mappings\myMappings\myMappingsFile.txt" |
idleConnectionTimeout | No | - | No | Maximum time (in milliseconds) to keep an idle connection open. | 3600000 |
maxConnections | No | - | No | Maximum number of connections to be opened. | 100 |
maxConnectionsPerRoute | No | - | No | Maximum number of connections opened for the same target. | 10 |
connectionTimeout | No | - | No | Maximum time (in milliseconds) to wait for the connection. | 15000 |
socketTimeout | No | - | No | Maximum time (in milliseconds) to wait for a socket response. | 15000 |
useThrottling | No | - | No | Set to true to specify Throttling Settings. | true / false |
throttlingRate | No | 5000 | No | Time period (in milliseconds) to throttle the connection. | 6000 |
throttlingConnectionRate | No | 500 | No | Maximum number of connections used during the Throttling Period. | 600 |
maxRetries | No | 3 | No | Maximum number of retries for a failed document. | 5 |
retryWaitTime | No | 5 | No | Time period (in milliseconds) to wait before a retry. | 6000 |
batchSize | No | - | No | Maximum size of the batches that will be created. | 50 |
simultaneousBatches | No | - | No | Number of batches that will be processed simultaneously. | 5 |
batchTimeout | No | - | No | Period (in ms) after which a batch of documents will be closed and executed. | 5000 |
debug | No | - | No | Set to true to enable debug mode to show debug messages from the publisher. | true / false |
{ "type": "application", "_type": "publisher", "description": "ElasticsearchPublisherTest", "config": "com.accenture.aspire:aspire-elasticsearch-publisher-source", "appType": "elasticsearch-publisher", "appName": "Elasticsearch Publisher", "properties": { "elasticNoUrl": true, "elasticHost": "myEShost", "elasticPort": 9200, "elasticIndex": "test-index", "authType": "none", "transformType": "JSON", "transformFile": "${component.home}/config/groovy/transform.groovy", "processClear": false, "idleConnectionTimeout": 3600000, "maxConnections": 100, "maxConnectionsPerRoute": 10, "connectionTimeout": 15000, "socketTimeout": 15000, "useThrottling": false, "maxRetries": 3, "retryWaitTime": 5000, "batchSize": 50, "simultaneousBatches": 5, "batchTimeout": 5000, "debug": false } }