1 | name | Specify the name of this engine |
| string (pattern: "[a-zA-Z\d_-]+") | Yes |
2 | type | Type of the engine to use for searches |
| string (enum: "elasticsearch", "opensearch") | Yes |
3 | default | If more than one, default = True indicates which engines will be used for GAIA API storage | false | boolean | No |
4 | engine_url | URLs to the engine nodes |
| string or array of strings (minLength: 1, maxLength: 65536, format: uri) | Yes |
5 | index_prefix | Prefix for all GAIA API indexes | "sa" | string (pattern: "[a-zA-Z\d_]+") | No |
6 | pool_connections | The number of connection pools to cache | 10 | integer | No |
7 | pool_maxsize | The maximum number of connections to save in the pool. | 100 | integer | No |
8 | pool_block | Whether the connection pool should block for connections. | false | boolean | No |
9 | headers | Dictionary with the predefined headers, express has header name (key), and its value | {} | object | No |
10 | proxies |
| {} | object | No |
11 | params | Dictionary with the predefined parameters, express has parameter name (key), and its value | {} | object | No |
12 | auth | Section for the authentication of the connection | Auth | object | No |
13 | verify | Defaults to True , requiring requests to verify the TLS certificate at the remote end. | true | boolean | No |
14 | cookies | Dictionary with the predefined cookies, express has cookie name (key), and its value | {} | object | No |
15 | cert | If String, path to ssl client cert file (.pem). If Tuple, ('cert', 'key') pair or ('cert', 'key', 'key_password') triplet |
| string or array or string or file-path | No |
16 | max_redirects | Maximum times the request is allowed to be redirected. | 30 | integer (minimum: 1) | No |
17 | max_retries | Number of times the server will retry a failed request before throwing an error. | 10 | integer (minimum: 0) | No |
18 | retry_backoff_factor | A backoff factor to apply between attempts after the second try. The connection will sleep for {backoff factor} * (2 ** ({number of total retries} - 1)) seconds. If the backoff_factor is 0.1, then will sleep for [0.0s, 0.2s, 0.4s, ...] between retries | 2.5 | number (minimum: 0) | No |
19 | retry_on_timeout | Should timeout trigger a retry on a different node? | false | boolean | No |
20 | timeout | Maximum time the server will wait for a request to be answered. | 30 | integer (minimum: 1) | No |
21 | allow_redirects | Allow the request to be redirected | true | boolean | No |
22 | trust_env | Trust environment settings for proxy configuration, default authentication, and similar. | true | boolean | No |
23 | use_throttling | Limit the number of API requests the server can make in a certain period. | false | boolean | No |
24 | throttling_rate | Number of simultaneous calls allowed per minute | 5000 | integer (minimum: 100) | No |
25 | throttling_connection_rate |
| 50 | integer (minimum: 1) | No |
26 | randomize_nodes_in_pool | Set to false to not randomize nodes within the pool. | true | boolean | No |
27 | node_selector_class | Class to be used to select nodes within the NodePool | "round_robin" | string (enum: "round_robin", "random") | No |
28 | dead_node_backoff_factor | Exponential backoff factor to calculate the amount of time to timeout a node after an unsuccessful API call |
| number | No |
29 | max_dead_node_backoff | Maximum amount of time to timeout a node after an unsuccessful API call |
| number | No |
30 | log_requests | If True, every request done by the engine will be logged | false | boolean | No |