github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 17:59:23 -04:00
Code Issues Projects Releases Packages Wiki Activity

[data.search.aggs] Remove legacy aggs APIs. (#64719) (#64987)

Browse source 
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
This commit is contained in:
Luke Elmers 2020-05-01 06:33:01 -06:00 • committed by GitHub
parent 50ff9cad57
commit 35ba9653df
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
56 changed files with 247 additions and 884 deletions
Download patch file Download diff file Expand all files Collapse all files

15
docs/development/plugins/data/public/kibana-plugin-plugins-data-public.agggrouplabels.md Normal file
View file

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggGroupLabels](./kibana-plugin-plugins-data-public.agggrouplabels.md)
## AggGroupLabels variable
<b>Signature:</b>
```typescript
AggGroupLabels: {
[AggGroupNames.Buckets]: string;
[AggGroupNames.Metrics]: string;
[AggGroupNames.None]: string;
}
```

11
docs/development/plugins/data/public/kibana-plugin-plugins-data-public.agggroupname.md Normal file
View file

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggGroupName](./kibana-plugin-plugins-data-public.agggroupname.md)
## AggGroupName type
<b>Signature:</b>
```typescript
export declare type AggGroupName = $Values<typeof AggGroupNames>;
```

24
docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggtypefieldfilters.addfilter.md
View file

@ -1,24 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggTypeFieldFilters](./kibana-plugin-plugins-data-public.aggtypefieldfilters.md) &gt; [addFilter](./kibana-plugin-plugins-data-public.aggtypefieldfilters.addfilter.md)
## AggTypeFieldFilters.addFilter() method
Register a new with this registry. This will be used by the .
<b>Signature:</b>
```typescript
addFilter(filter: AggTypeFieldFilter): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| filter | <code>AggTypeFieldFilter</code> | |
<b>Returns:</b>
`void`

25
docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggtypefieldfilters.filter.md
View file

@ -1,25 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggTypeFieldFilters](./kibana-plugin-plugins-data-public.aggtypefieldfilters.md) &gt; [filter](./kibana-plugin-plugins-data-public.aggtypefieldfilters.filter.md)
## AggTypeFieldFilters.filter() method
Returns the filtered by all registered filters.
<b>Signature:</b>
```typescript
filter(fields: IndexPatternField[], aggConfig: IAggConfig): IndexPatternField[];
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| fields | <code>IndexPatternField[]</code> | |
| aggConfig | <code>IAggConfig</code> | |
<b>Returns:</b>
`IndexPatternField[]`

21
docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggtypefieldfilters.md
View file

@ -1,21 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggTypeFieldFilters](./kibana-plugin-plugins-data-public.aggtypefieldfilters.md)
## AggTypeFieldFilters class
A registry to store which are used to filter down available fields for a specific visualization and .
<b>Signature:</b>
```typescript
declare class AggTypeFieldFilters
```
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
| [addFilter(filter)](./kibana-plugin-plugins-data-public.aggtypefieldfilters.addfilter.md) | | Register a new with this registry. This will be used by the . |
| [filter(fields, aggConfig)](./kibana-plugin-plugins-data-public.aggtypefieldfilters.filter.md) | | Returns the filtered by all registered filters. |

24
docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggtypefilters.addfilter.md
View file

@ -1,24 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggTypeFilters](./kibana-plugin-plugins-data-public.aggtypefilters.md) &gt; [addFilter](./kibana-plugin-plugins-data-public.aggtypefilters.addfilter.md)
## AggTypeFilters.addFilter() method
Register a new with this registry.
<b>Signature:</b>
```typescript
addFilter(filter: AggTypeFilter): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| filter | <code>AggTypeFilter</code> | |
<b>Returns:</b>
`void`

27
docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggtypefilters.filter.md
View file

@ -1,27 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggTypeFilters](./kibana-plugin-plugins-data-public.aggtypefilters.md) &gt; [filter](./kibana-plugin-plugins-data-public.aggtypefilters.filter.md)
## AggTypeFilters.filter() method
Returns the filtered by all registered filters.
<b>Signature:</b>
```typescript
filter(aggTypes: IAggType[], indexPattern: IndexPattern, aggConfig: IAggConfig, aggFilter: string[]): IAggType[];
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| aggTypes | <code>IAggType[]</code> | |
| indexPattern | <code>IndexPattern</code> | |
| aggConfig | <code>IAggConfig</code> | |
| aggFilter | <code>string[]</code> | |
<b>Returns:</b>
`IAggType[]`

21
docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggtypefilters.md
View file

@ -1,21 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggTypeFilters](./kibana-plugin-plugins-data-public.aggtypefilters.md)
## AggTypeFilters class
A registry to store which are used to filter down available aggregations for a specific visualization and .
<b>Signature:</b>
```typescript
declare class AggTypeFilters
```
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
| [addFilter(filter)](./kibana-plugin-plugins-data-public.aggtypefilters.addfilter.md) | | Register a new with this registry. |
| [filter(aggTypes, indexPattern, aggConfig, aggFilter)](./kibana-plugin-plugins-data-public.aggtypefilters.filter.md) | | Returns the filtered by all registered filters. |

11
docs/development/plugins/data/public/kibana-plugin-plugins-data-public.daterangekey.from.md
View file

@ -1,11 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [DateRangeKey](./kibana-plugin-plugins-data-public.daterangekey.md) &gt; [from](./kibana-plugin-plugins-data-public.daterangekey.from.md)
## DateRangeKey.from property
<b>Signature:</b>
```typescript
from: number;
```

19
docs/development/plugins/data/public/kibana-plugin-plugins-data-public.daterangekey.md
View file

@ -1,19 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [DateRangeKey](./kibana-plugin-plugins-data-public.daterangekey.md)
## DateRangeKey interface
<b>Signature:</b>
```typescript
export interface DateRangeKey
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [from](./kibana-plugin-plugins-data-public.daterangekey.from.md) | <code>number</code> | |
| [to](./kibana-plugin-plugins-data-public.daterangekey.to.md) | <code>number</code> | |

11
docs/development/plugins/data/public/kibana-plugin-plugins-data-public.daterangekey.to.md
View file

@ -1,11 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [DateRangeKey](./kibana-plugin-plugins-data-public.daterangekey.md) &gt; [to](./kibana-plugin-plugins-data-public.daterangekey.to.md)
## DateRangeKey.to property
<b>Signature:</b>
```typescript
to: number;
```

11
docs/development/plugins/data/public/kibana-plugin-plugins-data-public.iagggroupnames.md
View file

@ -1,11 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [IAggGroupNames](./kibana-plugin-plugins-data-public.iagggroupnames.md)
## IAggGroupNames type
<b>Signature:</b>
```typescript
export declare type IAggGroupNames = $Values<typeof AggGroupNames>;
```

18
docs/development/plugins/data/public/kibana-plugin-plugins-data-public.iprangekey.md
View file

@ -1,18 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [IpRangeKey](./kibana-plugin-plugins-data-public.iprangekey.md)
## IpRangeKey type
<b>Signature:</b>
```typescript
export declare type IpRangeKey = {
type: 'mask';
mask: string;
} | {
type: 'range';
from: string;
to: string;
};
```

8
docs/development/plugins/data/public/kibana-plugin-plugins-data-public.md
View file

@ -9,8 +9,6 @@
| Class | Description |
| --- | --- |
| [AggParamType](./kibana-plugin-plugins-data-public.aggparamtype.md) | |
| [AggTypeFieldFilters](./kibana-plugin-plugins-data-public.aggtypefieldfilters.md) | A registry to store which are used to filter down available fields for a specific visualization and . |
| [AggTypeFilters](./kibana-plugin-plugins-data-public.aggtypefilters.md) | A registry to store which are used to filter down available aggregations for a specific visualization and . |
| [Field](./kibana-plugin-plugins-data-public.field.md) | |
| [FieldFormat](./kibana-plugin-plugins-data-public.fieldformat.md) | |
| [FilterManager](./kibana-plugin-plugins-data-public.filtermanager.md) | |
@ -53,7 +51,6 @@
| [AggParamOption](./kibana-plugin-plugins-data-public.aggparamoption.md) | |
| [DataPublicPluginSetup](./kibana-plugin-plugins-data-public.datapublicpluginsetup.md) | |
| [DataPublicPluginStart](./kibana-plugin-plugins-data-public.datapublicpluginstart.md) | |
| [DateRangeKey](./kibana-plugin-plugins-data-public.daterangekey.md) | |
| [EsQueryConfig](./kibana-plugin-plugins-data-public.esqueryconfig.md) | |
| [FetchOptions](./kibana-plugin-plugins-data-public.fetchoptions.md) | |
| [FieldFormatConfig](./kibana-plugin-plugins-data-public.fieldformatconfig.md) | |
@ -75,7 +72,6 @@
| [ISearchStrategy](./kibana-plugin-plugins-data-public.isearchstrategy.md) | Search strategy interface contains a search method that takes in a request and returns a promise that resolves to a response. |
| [ISyncSearchRequest](./kibana-plugin-plugins-data-public.isyncsearchrequest.md) | |
| [KueryNode](./kibana-plugin-plugins-data-public.kuerynode.md) | |
| [OptionedParamEditorProps](./kibana-plugin-plugins-data-public.optionedparameditorprops.md) | |
| [OptionedValueProp](./kibana-plugin-plugins-data-public.optionedvalueprop.md) | |
| [Query](./kibana-plugin-plugins-data-public.query.md) | |
| [QueryState](./kibana-plugin-plugins-data-public.querystate.md) | All query state service state |
@ -95,6 +91,7 @@
| Variable | Description |
| --- | --- |
| [AggGroupLabels](./kibana-plugin-plugins-data-public.agggrouplabels.md) | |
| [AggGroupNames](./kibana-plugin-plugins-data-public.agggroupnames.md) | |
| [baseFormattersPublic](./kibana-plugin-plugins-data-public.baseformatterspublic.md) | |
| [castEsToKbnFieldTypeName](./kibana-plugin-plugins-data-public.castestokbnfieldtypename.md) | Get the KbnFieldType name for an esType string |
@ -119,6 +116,7 @@
| Type Alias | Description |
| --- | --- |
| [AggConfigOptions](./kibana-plugin-plugins-data-public.aggconfigoptions.md) | |
| [AggGroupName](./kibana-plugin-plugins-data-public.agggroupname.md) | |
| [AggParam](./kibana-plugin-plugins-data-public.aggparam.md) | |
| [CustomFilter](./kibana-plugin-plugins-data-public.customfilter.md) | |
| [EsQuerySortValue](./kibana-plugin-plugins-data-public.esquerysortvalue.md) | |
@ -127,7 +125,6 @@
| [FieldFormatsContentType](./kibana-plugin-plugins-data-public.fieldformatscontenttype.md) | \* |
| [FieldFormatsGetConfigFn](./kibana-plugin-plugins-data-public.fieldformatsgetconfigfn.md) | |
| [IAggConfig](./kibana-plugin-plugins-data-public.iaggconfig.md) | AggConfig This class represents an aggregation, which is displayed in the left-hand nav of the Visualize app. |
| [IAggGroupNames](./kibana-plugin-plugins-data-public.iagggroupnames.md) | |
| [IAggType](./kibana-plugin-plugins-data-public.iaggtype.md) | |
| [IFieldFormat](./kibana-plugin-plugins-data-public.ifieldformat.md) | |
| [IFieldFormatsRegistry](./kibana-plugin-plugins-data-public.ifieldformatsregistry.md) | |
@ -136,7 +133,6 @@
| [IndexPatternAggRestrictions](./kibana-plugin-plugins-data-public.indexpatternaggrestrictions.md) | |
| [IndexPatternsContract](./kibana-plugin-plugins-data-public.indexpatternscontract.md) | |
| [InputTimeRange](./kibana-plugin-plugins-data-public.inputtimerange.md) | |
| [IpRangeKey](./kibana-plugin-plugins-data-public.iprangekey.md) | |
| [ISearch](./kibana-plugin-plugins-data-public.isearch.md) | |
| [ISearchGeneric](./kibana-plugin-plugins-data-public.isearchgeneric.md) | |
| [ISearchSource](./kibana-plugin-plugins-data-public.isearchsource.md) | \* |

13
docs/development/plugins/data/public/kibana-plugin-plugins-data-public.optionedparameditorprops.aggparam.md
View file

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [OptionedParamEditorProps](./kibana-plugin-plugins-data-public.optionedparameditorprops.md) &gt; [aggParam](./kibana-plugin-plugins-data-public.optionedparameditorprops.aggparam.md)
## OptionedParamEditorProps.aggParam property
<b>Signature:</b>
```typescript
aggParam: {
options: T[];
};
```

18
docs/development/plugins/data/public/kibana-plugin-plugins-data-public.optionedparameditorprops.md
View file

@ -1,18 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [OptionedParamEditorProps](./kibana-plugin-plugins-data-public.optionedparameditorprops.md)
## OptionedParamEditorProps interface
<b>Signature:</b>
```typescript
export interface OptionedParamEditorProps<T = OptionedValueProp>
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [aggParam](./kibana-plugin-plugins-data-public.optionedparameditorprops.aggparam.md) | <code>{</code><br/><code> options: T[];</code><br/><code> }</code> | |

5
docs/development/plugins/data/public/kibana-plugin-plugins-data-public.search.md
View file

@ -9,12 +9,7 @@
```typescript
search: {
aggs: {
AggConfigs: typeof AggConfigs;
aggGroupNamesMap: () => Record<"metrics" | "buckets", string>;
aggTypeFilters: import("./search/aggs/filter/agg_type_filters").AggTypeFilters;
CidrMask: typeof CidrMask;
convertDateRangeToString: typeof convertDateRangeToString;
convertIPRangeToString: (range: import("./search").IpRangeKey, format: (val: any) => string) => string;
dateHistogramInterval: typeof dateHistogramInterval;
intervalOptions: ({
display: string;