schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
datalogic-scan2deploy-ce.json
outer-identity
The outer-identity of the EAP method
{"type": "string", "default": "", "examples": [""]}
datalogic-scan2deploy-ce.json
fast-reconnect
Indicate if fast reconnect should be enabled
{"type": "boolean", "default": false, "examples": [false]}
datalogic-scan2deploy-ce.json
inner-method
Inner EAP authentication method to use
{"type": "string", "enum": ["eap-tls", "eap-MsChapV2", "eap-gtc"], "default": "eap-tls", "examples": ["eap-MsChapV2"]}
datalogic-scan2deploy-ce.json
auto-pac
Indicates if automatic PAC provisioning is used for an EAP-FAST network
{"type": "boolean", "default": false, "examples": [true]}
datalogic-scan2deploy-ce.json
pac-file-path
Full path to the PAC file for manual PAC provisioning
{"type": "string", "default": "", "examples": [""]}
datalogic-scan2deploy-ce.json
pac-aid-info
PAC authority identity (AID) information used to select PAC from a list of PACs on the device
{"type": "string", "default": "", "examples": [""]}
datalogic-scan2deploy-ce.json
deployment
Section used to download a ZIP archive from a server and inflate it to the 'target-path' folder
{"type": "object", "properties": {"scheme": {"type": "string", "enum": ["http", "https"], "default": "http", "examples": ["http"]}, "host": {"type": "string", "default": "", "examples": ["10.1.20.123"]}, "port": {"type": "integer", "default": 80, "examples": [8080], "minimum": 0, "maximum": 65535}, "path": {"type": "st...
datalogic-scan2deploy-ce.json
scheme
Deployment download scheme to use
{"type": "string", "enum": ["http", "https"], "default": "http", "examples": ["http"]}
datalogic-scan2deploy-ce.json
host
Host name or internet protocol address of the server from which the resource is to be fetched
{"type": "string", "default": "", "examples": ["10.1.20.123"]}
datalogic-scan2deploy-ce.json
port
TCP/IP port to be used to contact the server
{"type": "integer", "default": 80, "examples": [8080], "minimum": 0, "maximum": 65535}
datalogic-scan2deploy-ce.json
path
Path to server resource to download, complete with query string if needed
{"type": "string", "default": "", "examples": ["target.zip"]}
datalogic-scan2deploy-ce.json
shell
Section for executable shell commands to be performed in the final staging phase
{"type": "object", "required": ["cmds"], "properties": {"cmds": {"type": "array", "items": {"type": "object", "required": ["app-name"], "properties": {"app-name": {"type": "string", "default": "", "examples": ["\\windows\\dldxu.exe"]}, "args": {"type": "string", "default": "", "examples": ["\\FlashDisk\\target\\config....
datalogic-scan2deploy-ce.json
cmds
Each object in 'cmds' is a shell command to execute in the final phase of staging
{"type": "array", "items": {"type": "object", "required": ["app-name"], "properties": {"app-name": {"type": "string", "default": "", "examples": ["\\windows\\dldxu.exe"]}, "args": {"type": "string", "default": "", "examples": ["\\FlashDisk\\target\\config.dxu"]}}}}
datalogic-scan2deploy-ce.json
app-name
Full path to the application to be executed
{"type": "string", "default": "", "examples": ["\\windows\\dldxu.exe"]}
datalogic-scan2deploy-ce.json
args
Command line arguments
{"type": "string", "default": "", "examples": ["\\FlashDisk\\target\\config.dxu"]}
jd2cr.schema.json
A crawler rule. - Anything prefixed as "HTML RegEx" will do Java-flavored pattern-matching on the page's raw (unmodified by javascript) HTML.
{"$schema": "http://json-schema.org/draft-07/schema", "type": "object", "required": ["enabled", "name", "rule", "pattern"], "additionalProperties": false, "properties": {"enabled": {"type": "boolean"}, "cookies": {"examples": [[["cookieName", "cookieValue"]]], "type": "array", "items": {"type": "array", "items": [{"typ...
jd2cr.schema.json
enabled
- Type: Boolean - Applies to rule: ALL - Purpose: Enables or disables this rule
{"type": "boolean"}
jd2cr.schema.json
cookies
- Type: Array of length-2 Arrays - Applies to rule: DIRECTHTTP, DEEPDECRYPT, SUBMITFORM or FOLLOWREDIRECT - Purpose: A list of length-2 arrays in the form [["cookieName", "cookieValue"],[..., ...]...]. Here you can put in your personal cookies e.g. login cookies of websites which JD otherwise fails to parse.Also if "up...
{"examples": [[["cookieName", "cookieValue"]]], "type": "array", "items": {"type": "array", "items": [{"type": "string"}, {"type": "string"}]}}
jd2cr.schema.json
updateCookies
- Type: Boolean - Applies to rule: DIRECTHTTP, DEEPDECRYPT, SUBMITFORM or FOLLOWREDIRECT - Purpose: If the target websites returns new cookies, save these inside this rule and update this rule.
{"type": "boolean"}
jd2cr.schema.json
logging
- Type: Boolean - Applies to rule: ALL - Purpose: Enable this for support purposes. Logs of your LinkCrawler Rules can be found in your JD install dir/logs/: LinkCrawlerRule.<RuleID>.log.0 and /LinkCrawlerDeep.*
{"type": "boolean"}
jd2cr.schema.json
maxDecryptDepth
- Type: Integer - Applies to rule: ALL - Purpose: How many layers deep do should your rule crawl (e.g. rule returns URLs matching the same rule again recursively - how often is this chain allowed to happen?)
{"examples": [1], "type": "integer"}
jd2cr.schema.json
id
- Type: Integer - Applies to rule: ALL - Purpose: Auto generated ID of the rule. Normally leave this blank and JD2 will autoinsert.
{"type": "integer"}
jd2cr.schema.json
name
- Type: String - Applies to rule: ALL - Purpose: name of the rule.
{"type": "string"}
jd2cr.schema.json
pattern
- Type: RegEx - Applies to rule: ALL - Purpose: defines on which URLs will this rule apply by matching it to the pattern
{"examples": ["https?://www\\.example\\.com/subdir1/subdir2/subdir3"], "type": "string", "format": "regex"}
jd2cr.schema.json
packageNamePattern
- Type: HTML RegEx - Applies to rule: DEEPDECRYPT - Purpose: All URLs crawled by this rule will be grouped into the same package that is the HTML RegEx's first capture
{"examples": ["<title>(.*?)</title>"], "type": "string", "format": "regex"}
jd2cr.schema.json
passwordPattern
- Type: HTML RegEx or null - Applies to rule: DEEPDECRYPT - Purpose: Matches against archive extraction password that may be found as text inside the page's (unmodified by javascript) HTML code. First returned capture must be the password.
{"examples": ["password:([^>]+)>"], "type": "string", "format": "regex"}
jd2cr.schema.json
formPattern
- Type: HTML RegEx - Applies to rule: DEEPDECRYPT - Purpose:
{"examples": ["<form id=\"example\">(.*?)</form>"], "type": "string", "format": "regex"}
jd2cr.schema.json
deepPattern
- Type: HTML RegEx or null - Applies to rule: DEEPDECRYPT - Purpose: Which URLs should this rule look for inside the page's (unmodified by javascript) HTML code. null (or blank) = auto scan and return all supported URLs found in HTML code. Keep in mind that, if the url's found in the html are relative (e.g. starting wi...
{"examples": ["(https?://absolute\\.url\\.example\\.com/subdir1/.*?\\.ext)", "\"((?:https?://missing\\.domain\\.example\\.com\\)?/partial_url_existing_in_page)\""], "oneOf": [{"type": "string"}, {"type": "null"}], "format": "regex"}
jd2cr.schema.json
rewriteReplaceWith
- Type: String - Applies to rule: REWRITE - Purpose:Pattern for new URL, can use captures from "pattern" in the $1 form
{"examples": ["https://example.com/$1"], "type": "string", "format": "regex"}
datahub_ingestion_schema.json
Root schema of Datahub Ingestion
{"$schema": "http://json-schema.org/draft-04/schema#", "id": "https://json.schemastore.org/datahub-ingestion", "definitions": {"console_sink": {"type": "object", "properties": {"type": {"type": "string", "enum": ["console"]}}, "required": ["type"]}, "file_sink": {"type": "object", "properties": {"type": {"type": "strin...
datahub_ingestion_schema.json
filename
Path to file to write to.
{"type": "string"}
datahub_ingestion_schema.json
ca_certificate_path
Path to server's CA certificate for verification of HTTPS communications
{"type": "string"}
datahub_ingestion_schema.json
max_threads
Experimental: Max parallelism for REST API calls
{"type": "number", "default": 15}
datahub_ingestion_schema.json
retry_status_codes
Retry HTTP request also on these status codes
{"type": "array", "items": {"type": "number"}, "default": [429, 502, 503, 504]}
datahub_ingestion_schema.json
server
URL of DataHub GMS endpoint.
{"type": "string"}
datahub_ingestion_schema.json
timeout_sec
Per-HTTP request timeout.
{"type": "number", "default": 30}
datahub_ingestion_schema.json
token
Bearer token used for authentication.
{"type": "string"}
datahub_ingestion_schema.json
extra_headers
Extra headers which will be added to the request.
{"type": "string"}
datahub_ingestion_schema.json
disable_ssl_verification
Disable SSL verification for HTTPS communications.
{"type": "boolean", "default": false}
datahub_ingestion_schema.json
bootstrap
Kafka bootstrap URL.
{"type": "string", "default": "localhost:9092"}
datahub_ingestion_schema.json
producer_config
Passed to https://docs.confluent.io/platform/current/clients/confluent-kafka-python/html/index.html#confluent_kafka.SerializingProducer
{"type": "object"}
datahub_ingestion_schema.json
schema_registry_url
URL of schema registry being used.
{"type": "string", "default": "http://localhost:8081"}
datahub_ingestion_schema.json
schema_registry_config
Passed to https://docs.confluent.io/platform/current/clients/confluent-kafka-python/html/index.html#confluent_kafka.schema_registry.SchemaRegistryClient
{"type": "object"}
datahub_ingestion_schema.json
MetadataChangeEvent
Overridden Kafka topic name for the MetadataChangeEvent
{"type": "string", "default": "MetadataChangeEvent"}
datahub_ingestion_schema.json
MetadataChangeProposal
Overridden Kafka topic name for the MetadataChangeProposal
{"type": "string", "default": "MetadataChangeProposal"}
datahub_ingestion_schema.json
mysql_config
Base configuration class for stateful ingestion for source configs to inherit from.
{"type": "object", "properties": {"env": {"default": "PROD", "type": "string"}, "platform_instance": {"type": "string"}, "stateful_ingestion": {}, "options": {"type": "object"}, "schema_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "table_pattern": {"default": {"allow": [".*"]...
datahub_ingestion_schema.json
env
The environment that all assets produced by this connector belong to
{"default": "PROD", "type": "string"}
datahub_ingestion_schema.json
platform_instance
The instance of the platform that all assets produced by this recipe belong to
{"type": "string"}
datahub_ingestion_schema.json
options
Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.
{"type": "object"}
datahub_ingestion_schema.json
schema_pattern
Deprecated in favour of database_pattern.
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
table_pattern
Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
view_pattern
Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
profile_pattern
Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
domain
Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like "Marketing".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. Ther...
{"default": {}, "type": "object", "additionalProperties": {}}
datahub_ingestion_schema.json
include_views
Whether views should be ingested.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_tables
Whether tables should be ingested.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_table_location_lineage
If the source supports it, include table lineage to the underlying storage location.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
username
username
{"type": "string"}
datahub_ingestion_schema.json
password
password
{"type": "string", "writeOnly": true, "format": "password"}
datahub_ingestion_schema.json
host_port
MySQL host URL.
{"default": "localhost:3306", "type": "string"}
datahub_ingestion_schema.json
database
database (catalog)
{"type": "string"}
datahub_ingestion_schema.json
database_alias
[Deprecated] Alias to apply to database when ingesting.
{"type": "string"}
datahub_ingestion_schema.json
sqlalchemy_uri
URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.
{"type": "string"}
datahub_ingestion_schema.json
database_pattern
Regex patterns for databases to filter in ingestion.
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
oracle_config
Base configuration class for stateful ingestion for source configs to inherit from.
{"type": "object", "properties": {"env": {"default": "PROD", "type": "string"}, "platform_instance": {"type": "string"}, "stateful_ingestion": {}, "options": {"type": "object"}, "schema_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "table_pattern": {"default": {"allow": [".*"]...
datahub_ingestion_schema.json
env
The environment that all assets produced by this connector belong to
{"default": "PROD", "type": "string"}
datahub_ingestion_schema.json
platform_instance
The instance of the platform that all assets produced by this recipe belong to
{"type": "string"}
datahub_ingestion_schema.json
options
Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.
{"type": "object"}
datahub_ingestion_schema.json
schema_pattern
Regex patterns for schemas to filter in ingestion. Specify regex to only match the schema name. e.g. to match all tables in schema analytics, use the regex 'analytics'
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
table_pattern
Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
view_pattern
Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
profile_pattern
Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
domain
Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like "Marketing".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. Ther...
{"default": {}, "type": "object", "additionalProperties": {}}
datahub_ingestion_schema.json
include_views
Whether views should be ingested.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_tables
Whether tables should be ingested.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_table_location_lineage
If the source supports it, include table lineage to the underlying storage location.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
username
username
{"type": "string"}
datahub_ingestion_schema.json
password
password
{"type": "string", "writeOnly": true, "format": "password"}
datahub_ingestion_schema.json
host_port
host URL
{"type": "string"}
datahub_ingestion_schema.json
database
If using, omit `service_name`.
{"type": "string"}
datahub_ingestion_schema.json
database_alias
[Deprecated] Alias to apply to database when ingesting.
{"type": "string"}
datahub_ingestion_schema.json
scheme
Will be set automatically to default value.
{"default": "oracle+cx_oracle", "type": "string"}
datahub_ingestion_schema.json
sqlalchemy_uri
URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.
{"type": "string"}
datahub_ingestion_schema.json
service_name
Oracle service name. If using, omit `database`.
{"type": "string"}
datahub_ingestion_schema.json
add_database_name_to_urn
Add oracle database name to urn, default urn is schema.table
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
powerbi-report-server_config
Any source that produces dataset urns in a single environment should inherit this class
{"type": "object", "properties": {"env": {"default": "PROD", "type": "string"}, "username": {"type": "string"}, "password": {"type": "string"}, "workstation_name": {"default": "localhost", "type": "string"}, "host_port": {"type": "string"}, "server_alias": {"default": "", "type": "string"}, "graphql_url": {"type": "str...
datahub_ingestion_schema.json
env
The environment that all assets produced by this connector belong to
{"default": "PROD", "type": "string"}
datahub_ingestion_schema.json
username
Windows account username
{"type": "string"}
datahub_ingestion_schema.json
password
Windows account password
{"type": "string"}
datahub_ingestion_schema.json
workstation_name
Workstation name
{"default": "localhost", "type": "string"}
datahub_ingestion_schema.json
host_port
Power BI Report Server host URL
{"type": "string"}
datahub_ingestion_schema.json
server_alias
Alias for Power BI Report Server host URL
{"default": "", "type": "string"}
datahub_ingestion_schema.json
graphql_url
[deprecated] Not used
{"type": "string"}
datahub_ingestion_schema.json
report_virtual_directory_name
Report Virtual Directory URL name
{"type": "string"}
datahub_ingestion_schema.json
report_server_virtual_directory_name
Report Server Virtual Directory URL name
{"type": "string"}
datahub_ingestion_schema.json
extract_ownership
Whether ownership should be ingested
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
ownership_type
Ownership type of owner
{"default": "NONE", "type": "string"}
datahub_ingestion_schema.json
datahub_config
Base configuration class for stateful ingestion for source configs to inherit from.
{"type": "object", "properties": {"stateful_ingestion": {"default": {"enabled": true, "max_checkpoint_state_size": 16777216, "state_provider": {"type": "datahub", "config": null}, "ignore_old_state": false, "ignore_new_state": false}, "allOf": [{}]}, "mysql_connection": {"default": {"username": null, "host_port": "loca...
datahub_ingestion_schema.json
stateful_ingestion
Stateful Ingestion Config
{"default": {"enabled": true, "max_checkpoint_state_size": 16777216, "state_provider": {"type": "datahub", "config": null}, "ignore_old_state": false, "ignore_new_state": false}, "allOf": [{}]}
datahub_ingestion_schema.json
mysql_connection
MySQL connection config
{"default": {"username": null, "host_port": "localhost:3306", "database": null, "database_alias": null, "scheme": "mysql+pymysql", "sqlalchemy_uri": null, "options": {}}, "allOf": [{}]}