dsl-builder
Version:
OpenSearch Query Builder - Extract from OpenSearch Dashboards
57 lines (56 loc) • 1.89 kB
TypeScript
import { IFieldType } from './types';
import { FieldSpec, IndexPattern } from '../..';
export declare class IndexPatternField implements IFieldType {
readonly spec: FieldSpec;
readonly displayName: string;
private readonly osdFieldType;
constructor(spec: FieldSpec, displayName: string);
/**
* Count is used for field popularity
*/
get count(): number;
set count(count: number);
/**
* Script field code
*/
get script(): string | undefined;
set script(script: string | undefined);
/**
* Script field language
*/
get lang(): string | undefined;
set lang(lang: string | undefined);
/**
* Description of field type conflicts across different indices in the same index pattern
*/
get conflictDescriptions(): Record<string, string[]> | undefined;
set conflictDescriptions(conflictDescriptions: Record<string, string[]> | undefined);
get name(): string;
get type(): string;
get esTypes(): string[] | undefined;
get scripted(): boolean;
get searchable(): boolean;
get aggregatable(): boolean;
get readFromDocValues(): boolean;
get subType(): import("../types").IFieldSubType | undefined;
get sortable(): boolean;
get filterable(): boolean;
get visualizable(): boolean;
toJSON(): {
count: number;
script: string | undefined;
lang: string | undefined;
conflictDescriptions: Record<string, string[]> | undefined;
name: string;
type: string;
esTypes: string[] | undefined;
scripted: boolean;
searchable: boolean;
aggregatable: boolean;
readFromDocValues: boolean;
subType: import("../types").IFieldSubType | undefined;
};
toSpec({ getFormatterForField, }?: {
getFormatterForField?: IndexPattern['getFormatterForField'];
}): FieldSpec;
}