Skip to content

Commit

Permalink
API doc changes
Browse files Browse the repository at this point in the history
  • Loading branch information
afharo committed Aug 24, 2021
1 parent 31e6fdc commit c34f8aa
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ export declare class ElasticsearchConfig
| [requestTimeout](./kibana-plugin-core-server.elasticsearchconfig.requesttimeout.md) | | <code>Duration</code> | Timeout after which HTTP request will be aborted and retried. |
| [serviceAccountToken](./kibana-plugin-core-server.elasticsearchconfig.serviceaccounttoken.md) | | <code>string</code> | If Elasticsearch security features are enabled, this setting provides the service account token that the Kibana server users to perform its administrative functions.<!-- -->This is an alternative to specifying a username and password. |
| [shardTimeout](./kibana-plugin-core-server.elasticsearchconfig.shardtimeout.md) | | <code>Duration</code> | Timeout for Elasticsearch to wait for responses from shards. Set to 0 to disable. |
| [skipStartupConnectionCheck](./kibana-plugin-core-server.elasticsearchconfig.skipstartupconnectioncheck.md) | | <code>boolean</code> | Skip the valid connection check during startup. |
| [sniffInterval](./kibana-plugin-core-server.elasticsearchconfig.sniffinterval.md) | | <code>false &#124; 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. |
| [sniffOnConnectionFault](./kibana-plugin-core-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. |
| [sniffOnStart](./kibana-plugin-core-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. |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [ElasticsearchConfig](./kibana-plugin-core-server.elasticsearchconfig.md) &gt; [skipStartupConnectionCheck](./kibana-plugin-core-server.elasticsearchconfig.skipstartupconnectioncheck.md)

## ElasticsearchConfig.skipStartupConnectionCheck property

Skip the valid connection check during startup.

<b>Signature:</b>

```typescript
readonly skipStartupConnectionCheck: boolean;
```
2 changes: 2 additions & 0 deletions src/core/server/server.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,7 @@ export const config: {
delay: Type<import("moment").Duration>;
}>;
ignoreVersionMismatch: import("@kbn/config-schema/target_types/types").ConditionalType<false, boolean, boolean>;
skipStartupConnectionCheck: Type<boolean>;
}>;
};
logging: {
Expand Down Expand Up @@ -825,6 +826,7 @@ export class ElasticsearchConfig {
readonly requestTimeout: Duration;
readonly serviceAccountToken?: string;
readonly shardTimeout: Duration;
readonly skipStartupConnectionCheck: boolean;
readonly sniffInterval: false | Duration;
readonly sniffOnConnectionFault: boolean;
readonly sniffOnStart: boolean;
Expand Down

0 comments on commit c34f8aa

Please sign in to comment.