Backstage
    Preparing search index...

    Options used to configure the @elastic/elasticsearch client.

    They are drawn from the ClientOptions class of @elastic/elasticsearch, but are maintained separately so that this interface is not coupled to it.

    interface ElasticSearchElasticSearchClientOptions {
        agent?: false | ElasticSearchAgentOptions | ((opts?: any) => unknown);
        auth?: ElasticSearchAuth;
        cloud?: { id: string; password?: string; username?: string };
        compression?: "gzip";
        Connection?: ElasticSearchConnectionConstructor;
        disablePrototypePoisoningProtection?: boolean | "proto" | "constructor";
        enableMetaHeader?: boolean;
        headers?: Record<string, any>;
        maxRetries?: number;
        name?: string | symbol;
        node?:
            | string
            | string[]
            | ElasticSearchNodeOptions
            | ElasticSearchNodeOptions[];
        nodeFilter?: (connection: any) => boolean;
        nodes?:
            | string
            | string[]
            | ElasticSearchNodeOptions
            | ElasticSearchNodeOptions[];
        nodeSelector?: string
        | ((connections: any[]) => any);
        opaqueIdPrefix?: string;
        pingTimeout?: number;
        provider?: "elastic";
        proxy?: string | URL;
        requestTimeout?: number;
        resurrectStrategy?: "ping" | "optimistic" | "none";
        sniffEndpoint?: string;
        sniffInterval?: number | boolean;
        sniffOnConnectionFault?: boolean;
        sniffOnStart?: boolean;
        ssl?: ConnectionOptions;
        suggestCompression?: boolean;
        Transport?: ElasticSearchTransportConstructor;
    }

    Hierarchy (View Summary)

    Index

    Properties

    agent?: false | ElasticSearchAgentOptions | ((opts?: any) => unknown)
    cloud?: { id: string; password?: string; username?: string }
    compression?: "gzip"
    disablePrototypePoisoningProtection?: boolean | "proto" | "constructor"
    enableMetaHeader?: boolean
    headers?: Record<string, any>
    maxRetries?: number
    name?: string | symbol
    node?: string | string[] | ElasticSearchNodeOptions | ElasticSearchNodeOptions[]
    nodeFilter?: (connection: any) => boolean
    nodes?:
        | string
        | string[]
        | ElasticSearchNodeOptions
        | ElasticSearchNodeOptions[]
    nodeSelector?: string | ((connections: any[]) => any)
    opaqueIdPrefix?: string
    pingTimeout?: number
    provider?: "elastic"
    proxy?: string | URL
    requestTimeout?: number
    resurrectStrategy?: "ping" | "optimistic" | "none"
    sniffEndpoint?: string
    sniffInterval?: number | boolean
    sniffOnConnectionFault?: boolean
    sniffOnStart?: boolean
    ssl?: ConnectionOptions
    suggestCompression?: boolean