SharedDatasourceConfigNoInstance
Structure describing shared config properties of a datasource with no multi-instance support.
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | Unique identifier of datasource instance to which this config applies. | |
| display_name | str | The user-friendly instance label to display. If omitted, falls back to the title-cased `name`. | [optional] |
| datasource_category | str | The type of this datasource. It is an important signal for relevance and must be specified and cannot be UNCATEGORIZED. Please refer to this for more details. | [optional] if omitted the server will use the default value of "UNCATEGORIZED" |
| url_regex | str | Regular expression that matches URLs of documents of the datasource instance. The behavior for multiple matches is non-deterministic. Note: `urlRegex` is a required field for non-entity datasources, but not required if the datasource is used to push custom entities (ie. datasources where isEntityDatasource is false). Please add a regex as specific as possible to this datasource instance. | [optional] |
| icon_url | str | The URL to an image to be displayed as an icon for this datasource instance. Must have a transparency mask. SVG are recommended over PNG. Public, scio-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs). | [optional] |
| object_definitions | [ObjectDefinition] | The list of top-level `objectType`s for the datasource. | [optional] |
| suggestion_text | str | Example text for what to search for in this datasource | [optional] |
| home_url | str | The URL of the landing page for this datasource instance. Should point to the most useful page for users, not the company marketing page. | [optional] |
| crawler_seed_urls | [str] | This only applies to WEB_CRAWL and BROWSER_CRAWL datasources. Defines the seed URLs for crawling. | [optional] |
| icon_dark_url | str | The URL to an image to be displayed as an icon for this datasource instance in dark mode. Must have a transparency mask. SVG are recommended over PNG. Public, scio-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs). | [optional] |
| hide_built_in_facets | [str] | List of built-in facet types that should be hidden for the datasource. | [optional] |
| canonicalizing_url_regex | [CanonicalizingRegexType] | A list of regular expressions to apply to an arbitrary URL to transform it into a canonical URL for this datasource instance. Regexes are to be applied in the order specified in this list. | [optional] |
| canonicalizing_title_regex | [CanonicalizingRegexType] | A list of regular expressions to apply to an arbitrary title to transform it into a title that will be displayed in the search results | [optional] |
| redlist_title_regex | str | A regex that identifies titles that should not be indexed | [optional] |
| connector_type | ConnectorType | [optional] | |
| quicklinks | [Quicklink] | List of actions for this datasource instance that will show up in autocomplete and app card, e.g. "Create new issue" for jira | [optional] |
| render_config_preset | str | The name of a render config to use for displaying results from this datasource. Any well known datasource name may be used to render the same as that source, e.g. `web` or `gdrive`. Please refer to this for more details | [optional] |
| aliases | [str] | Aliases that can be used as `app` operator-values. | [optional] |
| is_on_prem | bool | Whether or not this datasource is hosted on-premise. | [optional] |
| trust_url_regex_for_view_activity | bool | True if browser activity is able to report the correct URL for VIEW events. Set this to true if the URLs reported by Chrome are constant throughout each page load. Set this to false if the page has Javascript that modifies the URL during or after the load. | [optional] if omitted the server will use the default value of True |
| include_utm_source | bool | If true, a utm_source query param will be added to outbound links to this datasource within Glean. | [optional] |
| strip_fragment_in_canonical_url | bool | If true, the fragment part of the URL will be stripped when converting to a canonical url. | [optional] if omitted the server will use the default value of True |
| any string name | bool, date, datetime, dict, float, int, list, str, none_type | any string name can be used but the value must be the correct type | [optional] |