|
| 1 | +<!-- Do not edit this file. It is automatically generated by API Documenter. --> |
| 2 | + |
| 3 | +[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [ElasticsearchConfig](./kibana-plugin-server.elasticsearchconfig.md) |
| 4 | + |
| 5 | +## ElasticsearchConfig class |
| 6 | + |
| 7 | +Wrapper of config schema. |
| 8 | + |
| 9 | +<b>Signature:</b> |
| 10 | + |
| 11 | +```typescript |
| 12 | +export declare class ElasticsearchConfig |
| 13 | +``` |
| 14 | + |
| 15 | +## Constructors |
| 16 | + |
| 17 | +| Constructor | Modifiers | Description | |
| 18 | +| --- | --- | --- | |
| 19 | +| [(constructor)(rawConfig)](./kibana-plugin-server.elasticsearchconfig._constructor_.md) | | Constructs a new instance of the <code>ElasticsearchConfig</code> class | |
| 20 | + |
| 21 | +## Properties |
| 22 | + |
| 23 | +| Property | Modifiers | Type | Description | |
| 24 | +| --- | --- | --- | --- | |
| 25 | +| [apiVersion](./kibana-plugin-server.elasticsearchconfig.apiversion.md) | | <code>string</code> | Version of the Elasticsearch (6.7, 7.1 or <code>master</code>) client will be connecting to. | |
| 26 | +| [customHeaders](./kibana-plugin-server.elasticsearchconfig.customheaders.md) | | <code>ElasticsearchConfigType['customHeaders']</code> | Header names and values to send to Elasticsearch with every request. These headers cannot be overwritten by client-side headers and aren't affected by <code>requestHeadersWhitelist</code> configuration. | |
| 27 | +| [healthCheckDelay](./kibana-plugin-server.elasticsearchconfig.healthcheckdelay.md) | | <code>Duration</code> | The interval between health check requests Kibana sends to the Elasticsearch. | |
| 28 | +| [hosts](./kibana-plugin-server.elasticsearchconfig.hosts.md) | | <code>string[]</code> | Hosts that the client will connect to. If sniffing is enabled, this list will be used as seeds to discover the rest of your cluster. | |
| 29 | +| [ignoreVersionMismatch](./kibana-plugin-server.elasticsearchconfig.ignoreversionmismatch.md) | | <code>boolean</code> | Whether to allow kibana to connect to a non-compatible elasticsearch node. | |
| 30 | +| [logQueries](./kibana-plugin-server.elasticsearchconfig.logqueries.md) | | <code>boolean</code> | Specifies whether all queries to the client should be logged (status code, method, query etc.). | |
| 31 | +| [password](./kibana-plugin-server.elasticsearchconfig.password.md) | | <code>string</code> | If Elasticsearch is protected with basic authentication, this setting provides the password that the Kibana server uses to perform its administrative functions. | |
| 32 | +| [pingTimeout](./kibana-plugin-server.elasticsearchconfig.pingtimeout.md) | | <code>Duration</code> | Timeout after which PING HTTP request will be aborted and retried. | |
| 33 | +| [requestHeadersWhitelist](./kibana-plugin-server.elasticsearchconfig.requestheaderswhitelist.md) | | <code>string[]</code> | List of Kibana client-side headers to send to Elasticsearch when request scoped cluster client is used. If this is an empty array then \*no\* client-side will be sent. | |
| 34 | +| [requestTimeout](./kibana-plugin-server.elasticsearchconfig.requesttimeout.md) | | <code>Duration</code> | Timeout after which HTTP request will be aborted and retried. | |
| 35 | +| [shardTimeout](./kibana-plugin-server.elasticsearchconfig.shardtimeout.md) | | <code>Duration</code> | Timeout for Elasticsearch to wait for responses from shards. Set to 0 to disable. | |
| 36 | +| [sniffInterval](./kibana-plugin-server.elasticsearchconfig.sniffinterval.md) | | <code>false | Duration</code> | Interval to perform a sniff operation and make sure the list of nodes is complete. If <code>false</code> then sniffing is disabled. | |
| 37 | +| [sniffOnConnectionFault](./kibana-plugin-server.elasticsearchconfig.sniffonconnectionfault.md) | | <code>boolean</code> | Specifies whether the client should immediately sniff for a more current list of nodes when a connection dies. | |
| 38 | +| [sniffOnStart](./kibana-plugin-server.elasticsearchconfig.sniffonstart.md) | | <code>boolean</code> | Specifies whether the client should attempt to detect the rest of the cluster when it is first instantiated. | |
| 39 | +| [ssl](./kibana-plugin-server.elasticsearchconfig.ssl.md) | | <code>Pick<SslConfigSchema, Exclude<keyof SslConfigSchema, 'certificateAuthorities' | 'keystore' | 'truststore'>> & {</code><br/><code> certificateAuthorities?: string[];</code><br/><code> }</code> | Set of settings configure SSL connection between Kibana and Elasticsearch that are required when <code>xpack.ssl.verification_mode</code> in Elasticsearch is set to either <code>certificate</code> or <code>full</code>. | |
| 40 | +| [username](./kibana-plugin-server.elasticsearchconfig.username.md) | | <code>string</code> | If Elasticsearch is protected with basic authentication, this setting provides the username that the Kibana server uses to perform its administrative functions. | |
| 41 | + |
0 commit comments