Backstage
    Preparing search index...

    Interface OpenSearchElasticSearchClientOptions

    Options used to configure the @opensearch-project/opensearch client.

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

    interface OpenSearchElasticSearchClientOptions {
        agent?: false | ElasticSearchAgentOptions | ((opts?: any) => unknown);
        auth?: OpenSearchAuth;
        compression?: "gzip";
        connection?: OpenSearchConnectionConstructor;
        disablePrototypePoisoningProtection?: boolean | "proto" | "constructor";
        enableMetaHeader?: boolean;
        headers?: Record<string, any>;
        maxRetries?: number;
        name?: string | symbol;
        node?: string | string[] | OpenSearchNodeOptions | OpenSearchNodeOptions[];
        nodeFilter?: (connection: any) => boolean;
        nodes?: string | string[] | OpenSearchNodeOptions | OpenSearchNodeOptions[];
        nodeSelector?: string | ((connections: any[]) => any);
        opaqueIdPrefix?: string;
        pingTimeout?: number;
        provider?: "aws" | "opensearch";
        proxy?: string | URL;
        region?: string;
        requestTimeout?: number;
        resurrectStrategy?: "ping" | "optimistic" | "none";
        service?: "es" | "aoss";
        sniffEndpoint?: string;
        sniffInterval?: number | boolean;
        sniffOnConnectionFault?: boolean;
        sniffOnStart?: boolean;
        ssl?: ConnectionOptions;
        suggestCompression?: boolean;
        Transport?: ElasticSearchTransportConstructor;
    }

    Hierarchy (View Summary)

    Index

    Properties

    agent? auth? compression? connection? disablePrototypePoisoningProtection? enableMetaHeader? headers? maxRetries? name? node? nodeFilter? nodes? nodeSelector? opaqueIdPrefix? pingTimeout? provider? proxy? region? requestTimeout? resurrectStrategy? service? sniffEndpoint? sniffInterval? sniffOnConnectionFault? sniffOnStart? ssl? suggestCompression? Transport?

    Properties

    agent?: false | ElasticSearchAgentOptions | ((opts?: any) => unknown)
    auth?: OpenSearchAuth
    compression?: "gzip"
    connection?: OpenSearchConnectionConstructor
    disablePrototypePoisoningProtection?: boolean | "proto" | "constructor"
    enableMetaHeader?: boolean
    headers?: Record<string, any>
    maxRetries?: number
    name?: string | symbol
    node?: string | string[] | OpenSearchNodeOptions | OpenSearchNodeOptions[]
    nodeFilter?: (connection: any) => boolean
    nodes?: string | string[] | OpenSearchNodeOptions | OpenSearchNodeOptions[]
    nodeSelector?: string | ((connections: any[]) => any)
    opaqueIdPrefix?: string
    pingTimeout?: number
    provider?: "aws" | "opensearch"
    proxy?: string | URL
    region?: string
    requestTimeout?: number
    resurrectStrategy?: "ping" | "optimistic" | "none"
    service?: "es" | "aoss"
    sniffEndpoint?: string
    sniffInterval?: number | boolean
    sniffOnConnectionFault?: boolean
    sniffOnStart?: boolean
    ssl?: ConnectionOptions
    suggestCompression?: boolean
    Transport?: ElasticSearchTransportConstructor

    Settings

    Member Visibility

    On This Page

    Properties