reveal-sdk-node/lib/dts/sdk-model/Elasticsearch/RVElasticsearchDataSourceItem.d.ts

RevealBI Node.js SDK

import { RVDataSourceItem } from "../AbstractClasses/RVDataSourceItem";
import { RVElasticsearchDataSource } from "./RVElasticsearchDataSource";
/** Elasticsearch data source item */
export declare class RVElasticsearchDataSourceItem extends RVDataSourceItem {
    constructor(dataSource: RVElasticsearchDataSource);
    /** @hidden */
    constructor(json: any);
    private _index;
    /**
     * The name of the Elasticsearch index to query.
     */
    get index(): string | null;
    set index(value: string | null);
    private _fieldMultiValueLeniency;
    /**
     * (Optional) Controls behavior when SQL queries encounter fields with multiple values.
     * If false, an error is returned for fields containing array values.
     * If true, returns the first value from the array with no guarantee of consistent ordering.
     * Defaults to `false`.
     */
    get fieldMultiValueLeniency(): boolean | null;
    set fieldMultiValueLeniency(value: boolean | null);
    private _customQuery;
    /**
     * (Optional) Custom Elasticsearch SQL query to execute instead of using the default index query.
     */
    get customQuery(): string | null;
    set customQuery(value: string | null);
    private _customQueryParameters;
    get customQueryParameters(): any;
    set customQueryParameters(value: any);
    private _processDataOnServer;
    /** Configures if the "Process Data on Server" option is turned on for this item, defaults to "true" */
    get processDataOnServer(): boolean;
    set processDataOnServer(value: boolean);
    /** @hidden */
    toJson(): any;
    /** @hidden */
    getType(): string;
}