json.schema.metadataIngestion.searchServiceMetadataPipeline.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/metadataIngestion/searchServiceMetadataPipeline.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "SearchServiceMetadataPipeline",
  "description": "SearchService Metadata Pipeline Configuration.",
  "type": "object",
  "definitions": {
    "searchMetadataConfigType": {
      "description": "Search Source Config Metadata Pipeline type",
      "type": "string",
      "enum": ["SearchMetadata"],
      "default": "SearchMetadata"
    }
  },
  "properties": {
    "type": {
      "description": "Pipeline type",
      "$ref": "#/definitions/searchMetadataConfigType",
      "default": "SearchMetadata"
    },
    "searchIndexFilterPattern": {
      "title": "Search Index Filter Pattern",
      "description": "Regex to only fetch search indexes that matches the pattern.",
      "$ref": "../type/filterPattern.json#/definitions/filterPattern",
      "title": "Search Index Filter Pattern"
    },
    "markDeletedSearchIndexes": {
      "title": "Mark Deleted Search Indexes",
      "description": "Optional configuration to soft delete search indexes in OpenMetadata if the source search indexes are deleted. Also, if the search index is deleted, all the associated entities like lineage, etc., with that search index will be deleted",
      "type": "boolean",
      "default": true,
      "title": "Mark Deleted Search Index"
    },
    "includeSampleData": {
      "title": "Include Sample Data",
      "description": "Optional configuration to turn off fetching sample data for search index.",
      "type": "boolean",
      "default": true,
      "title": "Include Sample Data"
    },
    "sampleSize": {
      "title": "Sample Size",
      "description": "No. of records of sample data we want to ingest.",
      "default": 10,
      "type": "integer",
      "title": "Sample Size"
    },
    "overrideMetadata":{
      "title": "Override Metadata",
      "description": "Set the 'Override Metadata' toggle to control whether to override the existing metadata in the OpenMetadata server with the metadata fetched from the source. If the toggle is set to true, the metadata fetched from the source will override the existing metadata in the OpenMetadata server. If the toggle is set to false, the metadata fetched from the source will not override the existing metadata in the OpenMetadata server. This is applicable for fields like description, tags, owner and displayName",
      "type": "boolean",
      "default": false
    }
  },
  "additionalProperties": false
}