json.schema.configuration.elasticSearchConfiguration.json Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openmetadata-spec Show documentation
There is a newer version: 1.6.0-rc1
{
  "$id": "https://open-metadata.org/schema/entity/configuration/elasticSearchConfiguration.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ElasticSearchConfiguration",
  "description": "This schema defines the Elastic Search Configuration.",
  "type": "object",
  "javaType": "org.openmetadata.schema.service.configuration.elasticsearch.ElasticSearchConfiguration",
  "definitions": {
    "searchIndexMappingLanguage": {
      "javaType": "org.openmetadata.schema.type.IndexMappingLanguage",
      "description": "This schema defines the language options available for search index mappings.",
      "type": "string",
      "enum": [
        "EN",
        "JP",
        "ZH"
      ],
      "default": "EN"
    }
  },
  "properties": {
    "host": {
      "description": "Elastic Search Host",
      "type": "string"
    },
    "port": {
      "description": "Elastic Search port",
      "type": "integer"
    },
    "scheme": {
      "description": "Http/Https connection scheme",
      "type": "string"
    },
    "username": {
      "description": "Elastic Search Username for Login",
      "type": "string"
    },
    "password": {
      "description": "Elastic Search Password for Login",
      "type": "string"
    },
    "truststorePath": {
      "description": "Truststore Path",
      "type": "string"
    },
    "truststorePassword": {
      "description": "Truststore Password",
      "type": "string"
    },
    "connectionTimeoutSecs": {
      "description": "Connection Timeout in Seconds",
      "type": "integer",
      "default": 5
    },
    "socketTimeoutSecs": {
      "description": "Socket Timeout in Seconds",
      "type": "integer",
      "default": 60
    },
    "keepAliveTimeoutSecs": {
      "description": "Keep Alive Timeout in Seconds",
      "type": "integer"
    },
    "batchSize": {
      "description": "Batch Size for Requests",
      "type": "integer",
      "default": 10
    },
    "payLoadSize": {
      "description": "Payload size in bytes depending on elasticsearch config",
      "type": "integer",
      "default": 10485760
    },
    "clusterAlias": {
      "description": "Alias for search indexes to provide segregation of indexes.",
      "type": "string",
      "default": null
    },
    "searchIndexMappingLanguage": {
      "$ref": "#/definitions/searchIndexMappingLanguage"
    },
    "searchType": {
      "description": "This enum defines the search Type elastic/open search.",
      "type": "string",
      "enum": [
        "elasticsearch",
        "opensearch"
      ],
      "default": "elasticsearch"
    },
    "searchIndexFactoryClassName": {
      "description": "Index factory name",
      "type": "string"
    }
  },
  "required": ["host", "port", "scheme", "connectionTimeoutSecs", "socketTimeoutSecs", "batchSize", "searchIndexMappingLanguage"],
  "additionalProperties": false
}