json.schema.entity.services.connections.search.openSearchConnection.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/services/connections/search/openSearchConnection.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "OpenSearch Connection",
  "description": "OpenSearch Connection.",
  "type": "object",
  "javaType": "org.openmetadata.schema.services.connections.search.OpenSearchConnection",
  "definitions": {
    "openSearchType": {
      "description": "OpenSearch service type",
      "type": "string",
      "enum": ["OpenSearch"],
      "default": "OpenSearch"
    }
  },
  "properties": {
    "type": {
      "title": "Service Type",
      "description": "Service Type",
      "$ref": "#/definitions/openSearchType",
      "default": "OpenSearch"
    },
    "hostPort": {
      "title": "Host and Port",
      "description": "Host and port of the OpenSearch service.",
      "type": "string"
    },
    "scheme": {
      "description": "Http/Https connection scheme",
      "type": "string"
    },
    "username": {
      "description": "OpenSearch Username for Login",
      "type": "string"
    },
    "password": {
      "description": "OpenSearch 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"
    },
    "connectionOptions": {
      "title": "Connection Options",
      "$ref": "../connectionBasicType.json#/definitions/connectionOptions"
    },
    "connectionArguments": {
      "title": "Connection Arguments",
      "$ref": "../connectionBasicType.json#/definitions/connectionArguments"
    },
    "supportsMetadataExtraction": {
      "title": "Supports Metadata Extraction",
      "$ref": "../connectionBasicType.json#/definitions/supportsMetadataExtraction"
    }
  },
  "additionalProperties": false,
  "required": [
    "hostPort"
  ]
}