## API Report File for "opensearch-dashboards" > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts import { $Values } from '@osd/utility-types'; import { ApiResponse } from '@opensearch-project/opensearch'; import { Assign } from '@osd/utility-types'; import { BehaviorSubject } from 'rxjs'; import { ConfigDeprecationProvider } from '@osd/config'; import { CoreSetup } from 'src/core/server'; import { CoreSetup as CoreSetup_2 } from 'opensearch-dashboards/server'; import { CoreStart } from 'src/core/server'; import { CoreStart as CoreStart_2 } from 'opensearch-dashboards/server'; import { Duration } from 'moment'; import { Ensure } from '@osd/utility-types'; import { EnvironmentMode } from '@osd/config'; import { ErrorToastOptions } from 'src/core/public/notifications'; import { ExpressionAstFunction } from 'src/plugins/expressions/common'; import { ExpressionsServerSetup } from 'src/plugins/expressions/server'; import { ISearchOptions as ISearchOptions_2 } from 'src/plugins/data/public'; import { ISearchSource } from 'src/plugins/data/public'; import { LegacyAPICaller } from 'opensearch-dashboards/server'; import { Logger } from 'opensearch-dashboards/server'; import { LoggerFactory } from '@osd/logging'; import { Moment } from 'moment'; import moment from 'moment'; import { NameList } from 'elasticsearch'; import { Observable } from 'rxjs'; import { OpenSearchClient } from 'opensearch-dashboards/server'; import { OpenSearchDashboardsRequest } from 'src/core/server'; import { OpenSearchDashboardsRequest as OpenSearchDashboardsRequest_2 } from 'opensearch-dashboards/server'; import { PackageInfo } from '@osd/config'; import { PathConfigType } from '@osd/utils'; import { Plugin as Plugin_2 } from 'src/core/server'; import { Plugin as Plugin_3 } from 'opensearch-dashboards/server'; import { PluginInitializerContext as PluginInitializerContext_2 } from 'src/core/server'; import { RecursiveReadonly } from '@osd/utility-types'; import { RequestAdapter } from 'src/plugins/inspector/common'; import { RequestHandlerContext } from 'src/core/server'; import { RequestStatistics } from 'src/plugins/inspector/common'; import { SavedObject } from 'src/core/server'; import { SavedObjectsClientContract } from 'src/core/server'; import { Search } from '@opensearch-project/opensearch/api/requestParams'; import { SearchResponse } from 'elasticsearch'; import { SerializedFieldFormat as SerializedFieldFormat_2 } from 'src/plugins/expressions/common'; import { ShardsResponse } from 'elasticsearch'; import { ToastInputFields } from 'src/core/public/notifications'; import { TransportRequestPromise } from '@opensearch-project/opensearch/lib/Transport'; import { Type } from '@osd/config-schema'; import { TypeOf } from '@osd/config-schema'; import { Unit } from '@elastic/datemath'; import { UnwrapPromiseOrReturn } from '@osd/utility-types'; // Warning: (ae-forgotten-export) The symbol "AggConfigSerialized" needs to be exported by the entry point index.d.ts // Warning: (ae-missing-release-tag) "AggConfigOptions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export type AggConfigOptions = Assign<AggConfigSerialized, { type: IAggType; }>; // Warning: (ae-missing-release-tag) "AggGroupLabels" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export const AggGroupLabels: { buckets: string; metrics: string; none: string; }; // Warning: (ae-missing-release-tag) "AggGroupName" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export type AggGroupName = $Values<typeof AggGroupNames>; // Warning: (ae-missing-release-tag) "AggGroupNames" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export const AggGroupNames: Readonly<{ Buckets: "buckets"; Metrics: "metrics"; None: "none"; }>; // Warning: (ae-forgotten-export) The symbol "BaseParamType" needs to be exported by the entry point index.d.ts // Warning: (ae-missing-release-tag) "AggParam" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export type AggParam = BaseParamType; // Warning: (ae-missing-release-tag) "AggParamOption" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export interface AggParamOption { // (undocumented) display: string; // Warning: (ae-forgotten-export) The symbol "AggConfig" needs to be exported by the entry point index.d.ts // // (undocumented) enabled?(agg: AggConfig): boolean; // (undocumented) val: string; } // Warning: (ae-missing-release-tag) "AggParamType" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export class AggParamType<TAggConfig extends IAggConfig = IAggConfig> extends BaseParamType<TAggConfig> { constructor(config: Record<string, any>); // (undocumented) allowedAggs: string[]; // (undocumented) makeAgg: (agg: TAggConfig, state?: AggConfigSerialized) => TAggConfig; } // Warning: (ae-missing-release-tag) "BUCKET_TYPES" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export enum BUCKET_TYPES { // (undocumented) DATE_HISTOGRAM = "date_histogram", // (undocumented) DATE_RANGE = "date_range", // (undocumented) FILTER = "filter", // (undocumented) FILTERS = "filters", // (undocumented) GEOHASH_GRID = "geohash_grid", // (undocumented) GEOTILE_GRID = "geotile_grid", // (undocumented) HISTOGRAM = "histogram", // (undocumented) IP_RANGE = "ip_range", // (undocumented) RANGE = "range", // (undocumented) SIGNIFICANT_TERMS = "significant_terms", // (undocumented) TERMS = "terms" } // Warning: (ae-missing-release-tag) "castOpenSearchToOsdFieldTypeName" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public export const castOpenSearchToOsdFieldTypeName: (opensearchType: OPENSEARCH_FIELD_TYPES | string) => OSD_FIELD_TYPES; // Warning: (ae-forgotten-export) The symbol "PluginConfigDescriptor" needs to be exported by the entry point index.d.ts // Warning: (ae-forgotten-export) The symbol "ConfigSchema" needs to be exported by the entry point index.d.ts // Warning: (ae-missing-release-tag) "config" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export const config: PluginConfigDescriptor<ConfigSchema>; // Warning: (ae-missing-release-tag) "FieldDescriptor" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) interface FieldDescriptor { // (undocumented) aggregatable: boolean; // (undocumented) name: string; // (undocumented) esTypes: string[]; // (undocumented) readFromDocValues: boolean; // (undocumented) searchable: boolean; // Warning: (ae-forgotten-export) The symbol "FieldSubType" needs to be exported by the entry point index.d.ts // // (undocumented) subType?: FieldSubType; // (undocumented) type: string; } export { FieldDescriptor } export { FieldDescriptor as IndexPatternFieldDescriptor } // Warning: (ae-missing-release-tag) "FieldFormatConfig" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export interface FieldFormatConfig { // Warning: (ae-forgotten-export) The symbol "FieldFormatId" needs to be exported by the entry point index.d.ts // // (undocumented) id: FieldFormatId; // (undocumented) opensearch?: boolean; // (undocumented) params: Record<string, any>; } // Warning: (ae-missing-release-tag) "fieldFormats" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export const fieldFormats: { FieldFormatsRegistry: typeof FieldFormatsRegistry; FieldFormat: typeof FieldFormat; BoolFormat: typeof BoolFormat; BytesFormat: typeof BytesFormat; ColorFormat: typeof ColorFormat; DurationFormat: typeof DurationFormat; IpFormat: typeof IpFormat; NumberFormat: typeof NumberFormat; PercentFormat: typeof PercentFormat; RelativeDateFormat: typeof RelativeDateFormat; SourceFormat: typeof SourceFormat; StaticLookupFormat: typeof StaticLookupFormat; UrlFormat: typeof UrlFormat; StringFormat: typeof StringFormat; TruncateFormat: typeof TruncateFormat; }; // Warning: (ae-forgotten-export) The symbol "GetConfigFn" needs to be exported by the entry point index.d.ts // Warning: (ae-missing-release-tag) "FieldFormatsGetConfigFn" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export type FieldFormatsGetConfigFn = GetConfigFn; // Warning: (ae-missing-release-tag) "Filter" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export type Filter = { $state?: FilterState; meta: FilterMeta; query?: any; }; // @internal (undocumented) export const getAsyncOptions: () => { waitForCompletionTimeout: string; keepAlive: string; }; // Warning: (ae-forgotten-export) The symbol "IUiSettingsClient" needs to be exported by the entry point index.d.ts // Warning: (ae-missing-release-tag) "getDefaultSearchParams" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export function getDefaultSearchParams(uiSettingsClient: IUiSettingsClient): Promise<{ maxConcurrentShardRequests: number | undefined; ignoreThrottled: boolean; ignoreUnavailable: boolean; trackTotalHits: boolean; }>; // Warning: (ae-forgotten-export) The symbol "SharedGlobalConfig" needs to be exported by the entry point index.d.ts // Warning: (ae-missing-release-tag) "getShardTimeout" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export function getShardTimeout(config: SharedGlobalConfig): { timeout: string; } | { timeout?: undefined; }; // Warning: (ae-forgotten-export) The symbol "IIndexPattern" needs to be exported by the entry point index.d.ts // Warning: (ae-missing-release-tag) "getTime" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export function getTime(indexPattern: IIndexPattern | undefined, timeRange: TimeRange, options?: { forceNow?: Date; fieldName?: string; }): import("../..").RangeFilter | undefined; // @internal export function getTotalLoaded({ total, failed, successful }: ShardsResponse): { total: number; loaded: number; }; // Warning: (ae-missing-release-tag) "IAggConfig" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public export type IAggConfig = AggConfig; // Warning: (ae-forgotten-export) The symbol "AggConfigs" needs to be exported by the entry point index.d.ts // // @internal export type IAggConfigs = AggConfigs; // Warning: (ae-forgotten-export) The symbol "AggType" needs to be exported by the entry point index.d.ts // Warning: (ae-missing-release-tag) "IAggType" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export type IAggType = AggType; // Warning: (ae-missing-release-tag) "IFieldFormatsRegistry" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export type IFieldFormatsRegistry = PublicMethodsOf<FieldFormatsRegistry>; // Warning: (ae-forgotten-export) The symbol "FieldParamType" needs to be exported by the entry point index.d.ts // Warning: (ae-missing-release-tag) "IFieldParamType" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export type IFieldParamType = FieldParamType; // Warning: (ae-missing-release-tag) "IFieldSubType" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export interface IFieldSubType { // (undocumented) multi?: { parent: string; }; // (undocumented) nested?: { path: string; }; } // Warning: (ae-missing-release-tag) "IFieldType" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export interface IFieldType { // (undocumented) aggregatable?: boolean; // (undocumented) count?: number; // (undocumented) displayName?: string; // (undocumented) filterable?: boolean; // (undocumented) format?: any; // (undocumented) lang?: string; // (undocumented) name: string; // (undocumented) esTypes?: string[]; // (undocumented) readFromDocValues?: boolean; // (undocumented) script?: string; // (undocumented) scripted?: boolean; // (undocumented) searchable?: boolean; // (undocumented) sortable?: boolean; // (undocumented) subType?: IFieldSubType; // Warning: (ae-forgotten-export) The symbol "FieldSpec" needs to be exported by the entry point index.d.ts // // (undocumented) toSpec?: (options?: { getFormatterForField?: IndexPattern['getFormatterForField']; }) => FieldSpec; // (undocumented) type: string; // (undocumented) visualizable?: boolean; } // Warning: (ae-forgotten-export) The symbol "MetricAggType" needs to be exported by the entry point index.d.ts // Warning: (ae-missing-release-tag) "IMetricAggType" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export type IMetricAggType = MetricAggType; // Warning: (ae-missing-release-tag) "IndexPattern" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export class IndexPattern implements IIndexPattern { // Warning: (ae-forgotten-export) The symbol "IndexPatternDeps" needs to be exported by the entry point index.d.ts constructor({ spec, fieldFormats, shortDotsEnable, metaFields, }: IndexPatternDeps); addScriptedField(name: string, script: string, fieldType?: string): Promise<void>; // (undocumented) fieldFormatMap: Record<string, any>; // Warning: (ae-forgotten-export) The symbol "IIndexPatternFieldList" needs to be exported by the entry point index.d.ts // // (undocumented) fields: IIndexPatternFieldList & { toSpec: () => IndexPatternFieldMap; }; // (undocumented) flattenHit: (hit: Record<string, any>, deep?: boolean) => Record<string, any>; // (undocumented) formatField: FormatFieldFn; // (undocumented) formatHit: { (hit: Record<string, any>, type?: string): any; formatField: FormatFieldFn; }; // (undocumented) getAggregationRestrictions(): Record<string, Record<string, { agg?: string | undefined; interval?: number | undefined; fixed_interval?: string | undefined; calendar_interval?: string | undefined; delay?: string | undefined; time_zone?: string | undefined; }>> | undefined; getAsSavedObjectBody(): { title: string; timeFieldName: string | undefined; intervalName: string | undefined; sourceFilters: string | undefined; fields: string | undefined; fieldFormatMap: string | undefined; type: string | undefined; typeMeta: string | undefined; }; // (undocumented) getComputedFields(): { storedFields: string[]; scriptFields: any; docvalueFields: { field: any; format: string; }[]; }; // (undocumented) getFieldByName(name: string): IndexPatternField | undefined; getFormatterForField(field: IndexPatternField | IndexPatternField['spec'] | IFieldType): FieldFormat; // (undocumented) getIndex(): string; // Warning: (ae-forgotten-export) The symbol "IndexPatternField" needs to be exported by the entry point index.d.ts // // (undocumented) getNonScriptedFields(): IndexPatternField[]; getOriginalSavedObjectBody: () => { title?: string | undefined; timeFieldName?: string | undefined; intervalName?: string | undefined; fields?: string | undefined; sourceFilters?: string | undefined; fieldFormatMap?: string | undefined; typeMeta?: string | undefined; type?: string | undefined; }; // (undocumented) getScriptedFields(): IndexPatternField[]; getSourceFiltering(): { excludes: any[]; }; // (undocumented) getTimeField(): IndexPatternField | undefined; // (undocumented) id?: string; // (undocumented) intervalName: string | undefined; // (undocumented) isTimeBased(): boolean; // (undocumented) isTimeNanosBased(): boolean; // (undocumented) isUnsupportedTimePattern(): boolean; // (undocumented) metaFields: string[]; removeScriptedField(fieldName: string): void; resetOriginalSavedObjectBody: () => void; // Warning: (ae-forgotten-export) The symbol "SourceFilter" needs to be exported by the entry point index.d.ts // // (undocumented) sourceFilters?: SourceFilter[]; // (undocumented) timeFieldName: string | undefined; // (undocumented) title: string; // Warning: (ae-forgotten-export) The symbol "IndexPatternSpec" needs to be exported by the entry point index.d.ts // // (undocumented) toSpec(): IndexPatternSpec; // (undocumented) type: string | undefined; // Warning: (ae-forgotten-export) The symbol "TypeMeta" needs to be exported by the entry point index.d.ts // // (undocumented) typeMeta?: TypeMeta; // (undocumented) version: string | undefined; } // Warning: (ae-missing-release-tag) "IndexPatternAttributes" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export interface IndexPatternAttributes { // (undocumented) fieldFormatMap?: string; // (undocumented) fields: string; // (undocumented) intervalName?: string; // (undocumented) sourceFilters?: string; // (undocumented) timeFieldName?: string; // (undocumented) title: string; // (undocumented) type: string; // (undocumented) typeMeta: string; } // Warning: (ae-missing-release-tag) "indexPatterns" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export const indexPatterns: { isFilterable: typeof isFilterable; isNestedField: typeof isNestedField; }; // Warning: (ae-missing-release-tag) "IndexPatternsFetcher" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export class IndexPatternsFetcher { constructor(callDataCluster: LegacyAPICaller); getFieldsForTimePattern(options: { pattern: string; metaFields: string[]; lookBack: number; interval: string; }): Promise<FieldDescriptor[]>; getFieldsForWildcard(options: { pattern: string | string[]; metaFields?: string[]; fieldCapsOptions?: { allowNoIndices: boolean; }; }): Promise<FieldDescriptor[]>; } // Warning: (ae-forgotten-export) The symbol "IndexPatternsServiceStart" needs to be exported by the entry point index.d.ts // Warning: (ae-missing-release-tag) "IndexPatternsService" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export class IndexPatternsService implements Plugin_3<void, IndexPatternsServiceStart> { // (undocumented) setup(core: CoreSetup_2): void; // Warning: (ae-forgotten-export) The symbol "IndexPatternsServiceStartDeps" needs to be exported by the entry point index.d.ts // // (undocumented) start(core: CoreStart_2, { fieldFormats, logger }: IndexPatternsServiceStartDeps): { indexPatternsServiceFactory: (opensearchDashboardsRequest: OpenSearchDashboardsRequest_2) => Promise<IndexPatternsService_2>; }; } // Warning: (ae-forgotten-export) The symbol "IOpenSearchDashboardsSearchRequest" needs to be exported by the entry point index.d.ts // Warning: (ae-forgotten-export) The symbol "ISearchRequestParams" needs to be exported by the entry point index.d.ts // Warning: (ae-missing-release-tag) "IOpenSearchSearchRequest" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export interface IOpenSearchSearchRequest extends IOpenSearchDashboardsSearchRequest<ISearchRequestParams> { // (undocumented) indexType?: string; } // Warning: (ae-forgotten-export) The symbol "IOpenSearchDashboardsSearchResponse" needs to be exported by the entry point index.d.ts // Warning: (ae-missing-release-tag) "IOpenSearchSearchResponse" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export type IOpenSearchSearchResponse<Source = any> = IOpenSearchDashboardsSearchResponse<SearchResponse<Source>>; // Warning: (ae-missing-release-tag) "ISearchOptions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export interface ISearchOptions { abortSignal?: AbortSignal; strategy?: string; } // Warning: (ae-missing-release-tag) "ISearchSetup" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export interface ISearchSetup { // Warning: (ae-forgotten-export) The symbol "SearchEnhancements" needs to be exported by the entry point index.d.ts // // @internal (undocumented) __enhance: (enhancements: SearchEnhancements) => void; // Warning: (ae-forgotten-export) The symbol "AggsSetup" needs to be exported by the entry point index.d.ts // // (undocumented) aggs: AggsSetup; registerSearchStrategy: <SearchStrategyRequest extends IOpenSearchDashboardsSearchRequest = IOpenSearchSearchRequest, SearchStrategyResponse extends IOpenSearchDashboardsSearchResponse = IOpenSearchSearchResponse>(name: string, strategy: ISearchStrategy<SearchStrategyRequest, SearchStrategyResponse>) => void; usage?: SearchUsage; } // Warning: (ae-missing-release-tag) "ISearchStart" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export interface ISearchStart<SearchStrategyRequest extends IOpenSearchDashboardsSearchRequest = IOpenSearchSearchRequest, SearchStrategyResponse extends IOpenSearchDashboardsSearchResponse = IOpenSearchSearchResponse> { // Warning: (ae-forgotten-export) The symbol "AggsStart" needs to be exported by the entry point index.d.ts // // (undocumented) aggs: AggsStart; getSearchStrategy: (name: string) => ISearchStrategy<SearchStrategyRequest, SearchStrategyResponse>; // (undocumented) search: (context: RequestHandlerContext, request: SearchStrategyRequest, options: ISearchOptions) => Promise<SearchStrategyResponse>; // (undocumented) searchSource: { asScoped: (request: OpenSearchDashboardsRequest) => Promise<ISearchStartSearchSource>; }; } // Warning: (ae-missing-release-tag) "ISearchStrategy" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public export interface ISearchStrategy<SearchStrategyRequest extends IOpenSearchDashboardsSearchRequest = IOpenSearchSearchRequest, SearchStrategyResponse extends IOpenSearchDashboardsSearchResponse = IOpenSearchSearchResponse> { // (undocumented) cancel?: (context: RequestHandlerContext, id: string) => Promise<void>; // (undocumented) search: (context: RequestHandlerContext, request: SearchStrategyRequest, options?: ISearchOptions) => Promise<SearchStrategyResponse>; } // Warning: (ae-missing-release-tag) "KueryNode" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export interface KueryNode { // (undocumented) [key: string]: any; // Warning: (ae-forgotten-export) The symbol "NodeTypes" needs to be exported by the entry point index.d.ts // // (undocumented) type: keyof NodeTypes; } // Warning: (ae-missing-release-tag) "METRIC_TYPES" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export enum METRIC_TYPES { // (undocumented) AVG = "avg", // (undocumented) AVG_BUCKET = "avg_bucket", // (undocumented) CARDINALITY = "cardinality", // (undocumented) COUNT = "count", // (undocumented) CUMULATIVE_SUM = "cumulative_sum", // (undocumented) DERIVATIVE = "derivative", // (undocumented) GEO_BOUNDS = "geo_bounds", // (undocumented) GEO_CENTROID = "geo_centroid", // (undocumented) MAX = "max", // (undocumented) MAX_BUCKET = "max_bucket", // (undocumented) MEDIAN = "median", // (undocumented) MIN = "min", // (undocumented) MIN_BUCKET = "min_bucket", // (undocumented) MOVING_FN = "moving_avg", // (undocumented) PERCENTILE_RANKS = "percentile_ranks", // (undocumented) PERCENTILES = "percentiles", // (undocumented) SERIAL_DIFF = "serial_diff", // (undocumented) STD_DEV = "std_dev", // (undocumented) SUM = "sum", // (undocumented) SUM_BUCKET = "sum_bucket", // (undocumented) TOP_HITS = "top_hits" } // @public (undocumented) export enum OPENSEARCH_FIELD_TYPES { // (undocumented) ATTACHMENT = "attachment", // (undocumented) BOOLEAN = "boolean", // (undocumented) BYTE = "byte", // (undocumented) DATE = "date", // (undocumented) DATE_NANOS = "date_nanos", // (undocumented) DOUBLE = "double", // (undocumented) FLOAT = "float", // (undocumented) GEO_POINT = "geo_point", // (undocumented) GEO_SHAPE = "geo_shape", // (undocumented) HALF_FLOAT = "half_float", // (undocumented) HISTOGRAM = "histogram", // (undocumented) _ID = "_id", // (undocumented) _INDEX = "_index", // (undocumented) INTEGER = "integer", // (undocumented) IP = "ip", // (undocumented) KEYWORD = "keyword", // (undocumented) LONG = "long", // (undocumented) MURMUR3 = "murmur3", // (undocumented) NESTED = "nested", // (undocumented) OBJECT = "object", // (undocumented) SCALED_FLOAT = "scaled_float", // (undocumented) SHORT = "short", // (undocumented) _SOURCE = "_source", // (undocumented) STRING = "string", // (undocumented) TEXT = "text", // (undocumented) TOKEN_COUNT = "token_count", // (undocumented) _TYPE = "_type", // (undocumented) UNSIGNED_LONG = "unsigned_long" } // Warning: (ae-missing-release-tag) "OPENSEARCH_SEARCH_STRATEGY" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export const OPENSEARCH_SEARCH_STRATEGY = "opensearch"; // Warning: (ae-forgotten-export) The symbol "ExpressionFunctionDefinition" needs to be exported by the entry point index.d.ts // Warning: (ae-forgotten-export) The symbol "Input" needs to be exported by the entry point index.d.ts // Warning: (ae-forgotten-export) The symbol "Arguments" needs to be exported by the entry point index.d.ts // Warning: (ae-forgotten-export) The symbol "Output" needs to be exported by the entry point index.d.ts // Warning: (ae-missing-release-tag) "OpenSearchaggsExpressionFunctionDefinition" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export type OpenSearchaggsExpressionFunctionDefinition = ExpressionFunctionDefinition<'opensearchaggs', Input, Arguments, Output>; // Warning: (ae-missing-release-tag) "opensearchFilters" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export const opensearchFilters: { buildQueryFilter: (query: any, index: string, alias: string) => import("../common").QueryStringFilter; buildCustomFilter: typeof buildCustomFilter; buildEmptyFilter: (isPinned: boolean, index?: string | undefined) => import("../common").Filter; buildExistsFilter: (field: import("../common").IFieldType, indexPattern: import("../common").IIndexPattern) => import("../common").ExistsFilter; buildFilter: typeof buildFilter; buildPhraseFilter: (field: import("../common").IFieldType, value: any, indexPattern: import("../common").IIndexPattern) => import("../common").PhraseFilter; buildPhrasesFilter: (field: import("../common").IFieldType, params: any[], indexPattern: import("../common").IIndexPattern) => import("../common").PhrasesFilter; buildRangeFilter: (field: import("../common").IFieldType, params: import("../common").RangeFilterParams, indexPattern: import("../common").IIndexPattern, formattedValue?: string | undefined) => import("../common").RangeFilter; isFilterDisabled: (filter: import("../common").Filter) => boolean; }; // Warning: (ae-missing-release-tag) "opensearchKuery" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export const opensearchKuery: { nodeTypes: import("../common/opensearch_query/kuery/node_types").NodeTypes; fromKueryExpression: (expression: any, parseOptions?: Partial<import("../common").KueryParseOptions>) => import("../common").KueryNode; toOpenSearchQuery: (node: import("../common").KueryNode, indexPattern?: import("../common").IIndexPattern | undefined, config?: Record<string, any> | undefined, context?: Record<string, any> | undefined) => import("../../opensearch_dashboards_utils/common").JsonObject; }; // Warning: (ae-missing-release-tag) "opensearchQuery" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export const opensearchQuery: { buildQueryFromFilters: (filters: import("../common").Filter[] | undefined, indexPattern: import("../common").IIndexPattern | undefined, ignoreFilterIfFieldNotInIndex?: boolean) => { must: never[]; filter: import("../common").Filter[]; should: never[]; must_not: import("../common").Filter[]; }; getOpenSearchQueryConfig: typeof getOpenSearchQueryConfig; buildOpenSearchQuery: typeof buildOpenSearchQuery; }; // Warning: (ae-missing-release-tag) "OpenSearchQueryConfig" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export interface OpenSearchQueryConfig { // (undocumented) allowLeadingWildcards: boolean; // (undocumented) dateFormatTZ?: string; // (undocumented) ignoreFilterIfFieldNotInIndex: boolean; // (undocumented) queryStringOptions: Record<string, any>; } // Warning: (ae-missing-release-tag) "OptionedParamType" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export class OptionedParamType extends BaseParamType { constructor(config: Record<string, any>); // (undocumented) options: OptionedValueProp[]; } // Warning: (ae-missing-release-tag) "OptionedValueProp" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export interface OptionedValueProp { // (undocumented) disabled?: boolean; // (undocumented) isCompatible: (agg: IAggConfig) => boolean; // (undocumented) text: string; // (undocumented) value: string; } // @public (undocumented) export enum OSD_FIELD_TYPES { // (undocumented) ATTACHMENT = "attachment", // (undocumented) BOOLEAN = "boolean", // (undocumented) CONFLICT = "conflict", // (undocumented) DATE = "date", // (undocumented) GEO_POINT = "geo_point", // (undocumented) GEO_SHAPE = "geo_shape", // (undocumented) HISTOGRAM = "histogram", // (undocumented) IP = "ip", // (undocumented) MURMUR3 = "murmur3", // (undocumented) NESTED = "nested", // (undocumented) NUMBER = "number", // (undocumented) OBJECT = "object", // (undocumented) _SOURCE = "_source", // (undocumented) STRING = "string", // (undocumented) UNKNOWN = "unknown" } // Warning: (ae-forgotten-export) The symbol "parseOpenSearchInterval" needs to be exported by the entry point index.d.ts // Warning: (ae-missing-release-tag) "ParsedInterval" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export type ParsedInterval = ReturnType<typeof parseOpenSearchInterval>; // Warning: (ae-missing-release-tag) "parseInterval" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export function parseInterval(interval: string): moment.Duration | null; // Warning: (ae-forgotten-export) The symbol "DataPluginSetupDependencies" needs to be exported by the entry point index.d.ts // Warning: (ae-forgotten-export) The symbol "DataPluginStartDependencies" needs to be exported by the entry point index.d.ts // Warning: (ae-missing-release-tag) "DataServerPlugin" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export class Plugin implements Plugin_2<PluginSetup, PluginStart, DataPluginSetupDependencies, DataPluginStartDependencies> { constructor(initializerContext: PluginInitializerContext_2<ConfigSchema>); // (undocumented) setup(core: CoreSetup<DataPluginStartDependencies, PluginStart>, { expressions, usageCollection }: DataPluginSetupDependencies): { __enhance: (enhancements: DataEnhancements) => void; search: ISearchSetup; fieldFormats: { register: (customFieldFormat: import("../public").FieldFormatInstanceType) => number; }; }; // (undocumented) start(core: CoreStart): { fieldFormats: { fieldFormatServiceFactory: (uiSettings: import("../../../core/server").IUiSettingsClient) => Promise<import("../common").FieldFormatsRegistry>; }; indexPatterns: { indexPatternsServiceFactory: (opensearchDashboardsRequest: import("../../../core/server").OpenSearchDashboardsRequest<unknown, unknown, unknown, any>) => Promise<import("../public").IndexPatternsService>; }; search: ISearchStart<import("./search").IOpenSearchSearchRequest, import("./search").IOpenSearchSearchResponse<any>>; }; // (undocumented) stop(): void; } // Warning: (ae-forgotten-export) The symbol "PluginInitializerContext" needs to be exported by the entry point index.d.ts // // @public export function plugin(initializerContext: PluginInitializerContext<ConfigSchema>): Plugin; // Warning: (ae-missing-release-tag) "DataPluginSetup" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export interface PluginSetup { // @internal (undocumented) __enhance: (enhancements: DataEnhancements) => void; // Warning: (ae-forgotten-export) The symbol "FieldFormatsSetup" needs to be exported by the entry point index.d.ts // // (undocumented) fieldFormats: FieldFormatsSetup; // (undocumented) search: ISearchSetup; } // Warning: (ae-missing-release-tag) "DataPluginStart" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export interface PluginStart { // Warning: (ae-forgotten-export) The symbol "FieldFormatsStart" needs to be exported by the entry point index.d.ts // // (undocumented) fieldFormats: FieldFormatsStart; // (undocumented) indexPatterns: IndexPatternsServiceStart; // (undocumented) search: ISearchStart; } // Warning: (ae-missing-release-tag) "Query" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export type Query = { query: string | { [key: string]: any; }; language: string; }; // Warning: (ae-missing-release-tag) "RefreshInterval" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export interface RefreshInterval { // (undocumented) pause: boolean; // (undocumented) value: number; } // Warning: (ae-missing-release-tag) "search" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export const search: { aggs: { CidrMask: typeof CidrMask; dateHistogramInterval: typeof dateHistogramInterval; intervalOptions: ({ display: string; val: string; enabled(agg: import("../common").IBucketAggConfig): boolean | "" | undefined; } | { display: string; val: string; })[]; InvalidOpenSearchCalendarIntervalError: typeof InvalidOpenSearchCalendarIntervalError; InvalidOpenSearchIntervalFormatError: typeof InvalidOpenSearchIntervalFormatError; Ipv4Address: typeof Ipv4Address; isNumberType: (agg: import("../common").AggConfig) => boolean; isStringType: (agg: import("../common").AggConfig) => boolean; isType: (...types: string[]) => (agg: import("../common").AggConfig) => boolean; isValidOpenSearchInterval: typeof isValidOpenSearchInterval; isValidInterval: typeof isValidInterval; parentPipelineType: string; parseOpenSearchInterval: typeof parseOpenSearchInterval; parseInterval: typeof parseInterval; propFilter: typeof propFilter; siblingPipelineType: string; termsAggFilter: string[]; toAbsoluteDates: typeof toAbsoluteDates; }; getRequestInspectorStats: typeof getRequestInspectorStats; getResponseInspectorStats: typeof getResponseInspectorStats; tabifyAggResponse: typeof tabifyAggResponse; tabifyGetColumns: typeof tabifyGetColumns; }; // Warning: (ae-missing-release-tag) "SearchUsage" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export interface SearchUsage { // (undocumented) trackError(): Promise<void>; // (undocumented) trackSuccess(duration: number): Promise<void>; } // @internal export const shimAbortSignal: <T extends TransportRequestPromise<unknown>>(promise: T, signal: AbortSignal | undefined) => T; // @internal export function shimHitsTotal(response: SearchResponse<any>): { hits: { total: any; max_score: number; hits: { _index: string; _type: string; _id: string; _score: number; _source: any; _version?: number | undefined; _explanation?: import("elasticsearch").Explanation | undefined; fields?: any; highlight?: any; inner_hits?: any; matched_queries?: string[] | undefined; sort?: string[] | undefined; }[]; }; took: number; timed_out: boolean; _scroll_id?: string | undefined; _shards: import("elasticsearch").ShardsResponse; aggregations?: any; }; // Warning: (ae-missing-release-tag) "shouldReadFieldFromDocValues" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export function shouldReadFieldFromDocValues(aggregatable: boolean, opensearchType: string): boolean; // @public (undocumented) export interface TabbedAggColumn { // (undocumented) aggConfig: IAggConfig; // (undocumented) id: string; // (undocumented) name: string; } // @public (undocumented) export type TabbedAggRow = Record<TabbedAggColumn['id'], string | number>; // @public (undocumented) export interface TabbedTable { // (undocumented) columns: TabbedAggColumn[]; // (undocumented) rows: TabbedAggRow[]; } // Warning: (ae-missing-release-tag) "TimeRange" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export type TimeRange = { from: string; to: string; mode?: 'absolute' | 'relative'; }; // Warning: (ae-missing-release-tag) "toSnakeCase" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export function toSnakeCase(obj: Record<string, any>): import("lodash").Dictionary<any>; // Warning: (ae-missing-release-tag) "UI_SETTINGS" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export const UI_SETTINGS: { readonly META_FIELDS: "metaFields"; readonly DOC_HIGHLIGHT: "doc_table:highlight"; readonly QUERY_STRING_OPTIONS: "query:queryString:options"; readonly QUERY_ALLOW_LEADING_WILDCARDS: "query:allowLeadingWildcards"; readonly SEARCH_QUERY_LANGUAGE: "search:queryLanguage"; readonly SORT_OPTIONS: "sort:options"; readonly COURIER_IGNORE_FILTER_IF_FIELD_NOT_IN_INDEX: "courier:ignoreFilterIfFieldNotInIndex"; readonly COURIER_SET_REQUEST_PREFERENCE: "courier:setRequestPreference"; readonly COURIER_CUSTOM_REQUEST_PREFERENCE: "courier:customRequestPreference"; readonly COURIER_MAX_CONCURRENT_SHARD_REQUESTS: "courier:maxConcurrentShardRequests"; readonly COURIER_BATCH_SEARCHES: "courier:batchSearches"; readonly SEARCH_INCLUDE_FROZEN: "search:includeFrozen"; readonly SEARCH_TIMEOUT: "search:timeout"; readonly HISTOGRAM_BAR_TARGET: "histogram:barTarget"; readonly HISTOGRAM_MAX_BARS: "histogram:maxBars"; readonly HISTORY_LIMIT: "history:limit"; readonly SHORT_DOTS_ENABLE: "shortDots:enable"; readonly FORMAT_DEFAULT_TYPE_MAP: "format:defaultTypeMap"; readonly FORMAT_NUMBER_DEFAULT_PATTERN: "format:number:defaultPattern"; readonly FORMAT_PERCENT_DEFAULT_PATTERN: "format:percent:defaultPattern"; readonly FORMAT_BYTES_DEFAULT_PATTERN: "format:bytes:defaultPattern"; readonly FORMAT_CURRENCY_DEFAULT_PATTERN: "format:currency:defaultPattern"; readonly FORMAT_NUMBER_DEFAULT_LOCALE: "format:number:defaultLocale"; readonly TIMEPICKER_REFRESH_INTERVAL_DEFAULTS: "timepicker:refreshIntervalDefaults"; readonly TIMEPICKER_QUICK_RANGES: "timepicker:quickRanges"; readonly TIMEPICKER_TIME_DEFAULTS: "timepicker:timeDefaults"; readonly INDEXPATTERN_PLACEHOLDER: "indexPattern:placeholder"; readonly FILTERS_PINNED_BY_DEFAULT: "filters:pinnedByDefault"; readonly FILTERS_EDITOR_SUGGEST_VALUES: "filterEditor:suggestValues"; }; // Warning: (ae-missing-release-tag) "usageProvider" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export function usageProvider(core: CoreSetup_2): SearchUsage; // Warnings were encountered during analysis: // // src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts:64:45 - (ae-forgotten-export) The symbol "IndexPatternFieldMap" needs to be exported by the entry point index.d.ts // src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts:70:5 - (ae-forgotten-export) The symbol "FormatFieldFn" needs to be exported by the entry point index.d.ts // src/plugins/data/common/opensearch_query/filters/meta_filter.ts:53:3 - (ae-forgotten-export) The symbol "FilterState" needs to be exported by the entry point index.d.ts // src/plugins/data/common/opensearch_query/filters/meta_filter.ts:54:3 - (ae-forgotten-export) The symbol "FilterMeta" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:40:31 - (ae-forgotten-export) The symbol "buildCustomFilter" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:40:31 - (ae-forgotten-export) The symbol "buildFilter" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:71:29 - (ae-forgotten-export) The symbol "getOpenSearchQueryConfig" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:71:29 - (ae-forgotten-export) The symbol "buildOpenSearchQuery" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:101:26 - (ae-forgotten-export) The symbol "FieldFormatsRegistry" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:101:26 - (ae-forgotten-export) The symbol "FieldFormat" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:101:26 - (ae-forgotten-export) The symbol "BoolFormat" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:101:26 - (ae-forgotten-export) The symbol "BytesFormat" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:101:26 - (ae-forgotten-export) The symbol "ColorFormat" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:101:26 - (ae-forgotten-export) The symbol "DurationFormat" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:101:26 - (ae-forgotten-export) The symbol "IpFormat" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:101:26 - (ae-forgotten-export) The symbol "NumberFormat" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:101:26 - (ae-forgotten-export) The symbol "PercentFormat" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:101:26 - (ae-forgotten-export) The symbol "RelativeDateFormat" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:101:26 - (ae-forgotten-export) The symbol "SourceFormat" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:101:26 - (ae-forgotten-export) The symbol "StaticLookupFormat" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:101:26 - (ae-forgotten-export) The symbol "UrlFormat" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:101:26 - (ae-forgotten-export) The symbol "StringFormat" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:101:26 - (ae-forgotten-export) The symbol "TruncateFormat" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:127:27 - (ae-forgotten-export) The symbol "isFilterable" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:127:27 - (ae-forgotten-export) The symbol "isNestedField" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:228:20 - (ae-forgotten-export) The symbol "getRequestInspectorStats" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:228:20 - (ae-forgotten-export) The symbol "getResponseInspectorStats" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:228:20 - (ae-forgotten-export) The symbol "tabifyAggResponse" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:228:20 - (ae-forgotten-export) The symbol "tabifyGetColumns" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:230:1 - (ae-forgotten-export) The symbol "CidrMask" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:231:1 - (ae-forgotten-export) The symbol "dateHistogramInterval" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:240:1 - (ae-forgotten-export) The symbol "InvalidOpenSearchCalendarIntervalError" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:241:1 - (ae-forgotten-export) The symbol "InvalidOpenSearchIntervalFormatError" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:242:1 - (ae-forgotten-export) The symbol "Ipv4Address" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:246:1 - (ae-forgotten-export) The symbol "isValidOpenSearchInterval" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:247:1 - (ae-forgotten-export) The symbol "isValidInterval" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:251:1 - (ae-forgotten-export) The symbol "propFilter" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index.ts:254:1 - (ae-forgotten-export) The symbol "toAbsoluteDates" needs to be exported by the entry point index.d.ts // src/plugins/data/server/index_patterns/index_patterns_service.ts:56:14 - (ae-forgotten-export) The symbol "IndexPatternsService" needs to be exported by the entry point index.d.ts // src/plugins/data/server/plugin.ts:88:66 - (ae-forgotten-export) The symbol "DataEnhancements" needs to be exported by the entry point index.d.ts // src/plugins/data/server/search/types.ts:78:5 - (ae-forgotten-export) The symbol "ISearchStartSearchSource" needs to be exported by the entry point index.d.ts // (No @packageDocumentation comment for this package) ```