Interface ElasticsearchNodeParameters

Source
interface ElasticsearchNodeParameters {
    additionalFields?:
        | {
            documentId?: string;
            routing?: string;
            timeout?: string;
        }
        | {
            aliases?: string;
            include_type_name?: boolean;
            mappings?: string;
            master_timeout?: string;
            settings?: string;
            timeout?: string;
            wait_for_active_shards?: string;
        }
        | {
            allow_no_indices?: boolean;
            expand_wildcards?: | "all"
            | "none"
            | "open"
            | "closed"
            | "hidden";
            flat_settings?: boolean;
            ignore_unavailable?: boolean;
            include_defaults?: boolean;
            local?: boolean;
            master_timeout?: string;
        };
    dataToSend?: "autoMapInputData"
    | "defineBelow";
    documentId?: string;
    fieldsUi?: {
        fieldValues: {
            fieldId?: string;
            fieldValue?: string;
        }[];
    };
    indexId?: string;
    inputsToIgnore?: string;
    limit?: number;
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete";
    options?: | { bulkOperation?: boolean }
    | {
        _source_excludes?: string;
        _source_includes?: string;
        stored_fields?: boolean;
    }
    | {
        _source_excludes?: string;
        _source_includes?: string;
        allow_no_indices?: boolean;
        allow_partial_search_results?: boolean;
        batched_reduce_size?: number;
        ccs_minimize_roundtrips?: boolean;
        docvalue_fields?: string;
        expand_wildcards?: | "all"
        | "none"
        | "open"
        | "closed"
        | "hidden";
        explain?: boolean;
        ignore_throttled?: boolean;
        ignore_unavailable?: boolean;
        max_concurrent_shard_requests?: number;
        pre_filter_shard_size?: number;
        query?: string;
        request_cache?: boolean;
        routing?: string;
        search_type?: | "dfs_query_then_fetch"
        | "query_then_fetch";
        seq_no_primary_term?: boolean;
        sort?: string;
        stats?: string;
        stored_fields?: boolean;
        terminate_after?: number;
        timeout?: string;
        track_scores?: boolean;
        track_total_hits?: number;
        version?: boolean;
    }
    | {
        bulkOperation?: boolean;
        pipeline?: string;
        refresh?: "true"
        | "wait_for"
        | "false";
    }
    | {
        bulkOperation?: boolean;
        refresh?: "true"
        | "wait_for"
        | "false";
    };
    resource?: "document"
    | "index";
    returnAll?: boolean;
    simple?: boolean;
}

Properties§

Source§

readonly additionalFields?:
    | {
        documentId?: string;
        routing?: string;
        timeout?: string;
    }
    | {
        aliases?: string;
        include_type_name?: boolean;
        mappings?: string;
        master_timeout?: string;
        settings?: string;
        timeout?: string;
        wait_for_active_shards?: string;
    }
    | {
        allow_no_indices?: boolean;
        expand_wildcards?: | "all"
        | "none"
        | "open"
        | "closed"
        | "hidden";
        flat_settings?: boolean;
        ignore_unavailable?: boolean;
        include_defaults?: boolean;
        local?: boolean;
        master_timeout?: string;
    }

Default: {}

Source§

readonly dataToSend?: "autoMapInputData" | "defineBelow"

Whether to insert the input data this node receives in the new row Default: "defineBelow"

Source§

readonly documentId?: string

ID of the document to delete

Source§

readonly fieldsUi?: { fieldValues: { fieldId?: string; fieldValue?: string }[] }

Default: {} Type options: {"multipleValueButtonText":"Add Field to Send","multipleValues":true}

Source§

readonly indexId?: string

ID of the index containing the document to delete

Source§

readonly inputsToIgnore?: string

List of input properties to avoid sending, separated by commas. Leave empty to send all properties.

Source§

readonly limit?: number

Max number of results to return Default: 50 Type options: {"minValue":1}

Source§

readonly operation?: "create" | "get" | "getAll" | "update" | "delete"

Default: "get"

Source§

readonly options?:
    | { bulkOperation?: boolean }
    | {
        _source_excludes?: string;
        _source_includes?: string;
        stored_fields?: boolean;
    }
    | {
        _source_excludes?: string;
        _source_includes?: string;
        allow_no_indices?: boolean;
        allow_partial_search_results?: boolean;
        batched_reduce_size?: number;
        ccs_minimize_roundtrips?: boolean;
        docvalue_fields?: string;
        expand_wildcards?: | "all"
        | "none"
        | "open"
        | "closed"
        | "hidden";
        explain?: boolean;
        ignore_throttled?: boolean;
        ignore_unavailable?: boolean;
        max_concurrent_shard_requests?: number;
        pre_filter_shard_size?: number;
        query?: string;
        request_cache?: boolean;
        routing?: string;
        search_type?: | "dfs_query_then_fetch"
        | "query_then_fetch";
        seq_no_primary_term?: boolean;
        sort?: string;
        stats?: string;
        stored_fields?: boolean;
        terminate_after?: number;
        timeout?: string;
        track_scores?: boolean;
        track_total_hits?: number;
        version?: boolean;
    }
    | {
        bulkOperation?: boolean;
        pipeline?: string;
        refresh?: "true"
        | "wait_for"
        | "false";
    }
    | {
        bulkOperation?: boolean;
        refresh?: "true"
        | "wait_for"
        | "false";
    }

Default: {}

Source§

readonly resource?: "document" | "index"

Default: "document"

Source§

readonly returnAll?: boolean

Whether to return all results or only up to a given limit

Source§

readonly simple?: boolean

Whether to return a simplified version of the response instead of the raw data Default: true