Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make data.search.aggs available on the server. #74472

Merged
merged 11 commits into from
Aug 13, 2020
  •  
  •  
  •  
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@
<b>Signature:</b>

```typescript
baseFormattersPublic: (import("../../common").FieldFormatInstanceType | typeof DateNanosFormat | typeof DateFormat)[]
baseFormattersPublic: (import("../../common").FieldFormatInstanceType | typeof DateFormat | typeof DateNanosFormat)[]
```
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ search: {
intervalOptions: ({
display: string;
val: string;
enabled(agg: import("./search/aggs/buckets/bucket_agg_type").IBucketAggConfig): boolean | "" | undefined;
enabled(agg: import("../common").IBucketAggConfig): boolean | "" | undefined;
} | {
display: string;
val: string;
Expand All @@ -23,9 +23,9 @@ search: {
InvalidEsIntervalFormatError: typeof InvalidEsIntervalFormatError;
Ipv4Address: typeof Ipv4Address;
isDateHistogramBucketAggConfig: typeof isDateHistogramBucketAggConfig;
isNumberType: (agg: import("./search").AggConfig) => boolean;
isStringType: (agg: import("./search").AggConfig) => boolean;
isType: (...types: string[]) => (agg: import("./search").AggConfig) => boolean;
isNumberType: (agg: import("../common").AggConfig) => boolean;
isStringType: (agg: import("../common").AggConfig) => boolean;
isType: (...types: string[]) => (agg: import("../common").AggConfig) => boolean;
isValidEsInterval: typeof isValidEsInterval;
isValidInterval: typeof isValidInterval;
parentPipelineType: string;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [AggConfigOptions](./kibana-plugin-plugins-data-server.aggconfigoptions.md)

## AggConfigOptions type

<b>Signature:</b>

```typescript
export declare type AggConfigOptions = Assign<AggConfigSerialized, {
type: IAggType;
}>;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [AggGroupLabels](./kibana-plugin-plugins-data-server.agggrouplabels.md)

## AggGroupLabels variable

<b>Signature:</b>

```typescript
AggGroupLabels: {
buckets: string;
metrics: string;
none: string;
}
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [AggGroupName](./kibana-plugin-plugins-data-server.agggroupname.md)

## AggGroupName type

<b>Signature:</b>

```typescript
export declare type AggGroupName = $Values<typeof AggGroupNames>;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [AggGroupNames](./kibana-plugin-plugins-data-server.agggroupnames.md)

## AggGroupNames variable

<b>Signature:</b>

```typescript
AggGroupNames: Readonly<{
Buckets: "buckets";
Metrics: "metrics";
None: "none";
}>
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [AggParam](./kibana-plugin-plugins-data-server.aggparam.md)

## AggParam type

<b>Signature:</b>

```typescript
export declare type AggParam = BaseParamType;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [AggParamOption](./kibana-plugin-plugins-data-server.aggparamoption.md) &gt; [display](./kibana-plugin-plugins-data-server.aggparamoption.display.md)

## AggParamOption.display property

<b>Signature:</b>

```typescript
display: string;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [AggParamOption](./kibana-plugin-plugins-data-server.aggparamoption.md) &gt; [enabled](./kibana-plugin-plugins-data-server.aggparamoption.enabled.md)

## AggParamOption.enabled() method

<b>Signature:</b>

```typescript
enabled?(agg: AggConfig): boolean;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| agg | <code>AggConfig</code> | |

<b>Returns:</b>

`boolean`

Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [AggParamOption](./kibana-plugin-plugins-data-server.aggparamoption.md)

## AggParamOption interface

<b>Signature:</b>

```typescript
export interface AggParamOption
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [display](./kibana-plugin-plugins-data-server.aggparamoption.display.md) | <code>string</code> | |
| [val](./kibana-plugin-plugins-data-server.aggparamoption.val.md) | <code>string</code> | |

## Methods

| Method | Description |
| --- | --- |
| [enabled(agg)](./kibana-plugin-plugins-data-server.aggparamoption.enabled.md) | |

Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [AggParamOption](./kibana-plugin-plugins-data-server.aggparamoption.md) &gt; [val](./kibana-plugin-plugins-data-server.aggparamoption.val.md)

## AggParamOption.val property

<b>Signature:</b>

```typescript
val: string;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [AggParamType](./kibana-plugin-plugins-data-server.aggparamtype.md) &gt; [(constructor)](./kibana-plugin-plugins-data-server.aggparamtype._constructor_.md)

## AggParamType.(constructor)

Constructs a new instance of the `AggParamType` class

<b>Signature:</b>

```typescript
constructor(config: Record<string, any>);
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| config | <code>Record&lt;string, any&gt;</code> | |

Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [AggParamType](./kibana-plugin-plugins-data-server.aggparamtype.md) &gt; [allowedAggs](./kibana-plugin-plugins-data-server.aggparamtype.allowedaggs.md)

## AggParamType.allowedAggs property

<b>Signature:</b>

```typescript
allowedAggs: string[];
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [AggParamType](./kibana-plugin-plugins-data-server.aggparamtype.md) &gt; [makeAgg](./kibana-plugin-plugins-data-server.aggparamtype.makeagg.md)

## AggParamType.makeAgg property

<b>Signature:</b>

```typescript
makeAgg: (agg: TAggConfig, state?: AggConfigSerialized) => TAggConfig;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [AggParamType](./kibana-plugin-plugins-data-server.aggparamtype.md)

## AggParamType class

<b>Signature:</b>

```typescript
export declare class AggParamType<TAggConfig extends IAggConfig = IAggConfig> extends BaseParamType<TAggConfig>
```

## Constructors

| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(config)](./kibana-plugin-plugins-data-server.aggparamtype._constructor_.md) | | Constructs a new instance of the <code>AggParamType</code> class |

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [allowedAggs](./kibana-plugin-plugins-data-server.aggparamtype.allowedaggs.md) | | <code>string[]</code> | |
| [makeAgg](./kibana-plugin-plugins-data-server.aggparamtype.makeagg.md) | | <code>(agg: TAggConfig, state?: AggConfigSerialized) =&gt; TAggConfig</code> | |

Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [BUCKET\_TYPES](./kibana-plugin-plugins-data-server.bucket_types.md)

## BUCKET\_TYPES enum

<b>Signature:</b>

```typescript
export declare enum BUCKET_TYPES
```

## Enumeration Members

| Member | Value | Description |
| --- | --- | --- |
| DATE\_HISTOGRAM | <code>&quot;date_histogram&quot;</code> | |
| DATE\_RANGE | <code>&quot;date_range&quot;</code> | |
| FILTER | <code>&quot;filter&quot;</code> | |
| FILTERS | <code>&quot;filters&quot;</code> | |
| GEOHASH\_GRID | <code>&quot;geohash_grid&quot;</code> | |
| GEOTILE\_GRID | <code>&quot;geotile_grid&quot;</code> | |
| HISTOGRAM | <code>&quot;histogram&quot;</code> | |
| IP\_RANGE | <code>&quot;ip_range&quot;</code> | |
| RANGE | <code>&quot;range&quot;</code> | |
| SIGNIFICANT\_TERMS | <code>&quot;significant_terms&quot;</code> | |
| TERMS | <code>&quot;terms&quot;</code> | |

Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [IAggConfig](./kibana-plugin-plugins-data-server.iaggconfig.md)

## IAggConfig type

AggConfig

This class represents an aggregation, which is displayed in the left-hand nav of the Visualize app.

<b>Signature:</b>

```typescript
export declare type IAggConfig = AggConfig;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [IAggType](./kibana-plugin-plugins-data-server.iaggtype.md)

## IAggType type

<b>Signature:</b>

```typescript
export declare type IAggType = AggType;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [IFieldParamType](./kibana-plugin-plugins-data-server.ifieldparamtype.md)

## IFieldParamType type

<b>Signature:</b>

```typescript
export declare type IFieldParamType = FieldParamType;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [IMetricAggType](./kibana-plugin-plugins-data-server.imetricaggtype.md)

## IMetricAggType type

<b>Signature:</b>

```typescript
export declare type IMetricAggType = MetricAggType;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [ISearchSetup](./kibana-plugin-plugins-data-server.isearchsetup.md) &gt; [aggs](./kibana-plugin-plugins-data-server.isearchsetup.aggs.md)

## ISearchSetup.aggs property

<b>Signature:</b>

```typescript
aggs: AggsSetup;
```
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ export interface ISearchSetup

| Property | Type | Description |
| --- | --- | --- |
| [aggs](./kibana-plugin-plugins-data-server.isearchsetup.aggs.md) | <code>AggsSetup</code> | |
| [registerSearchStrategy](./kibana-plugin-plugins-data-server.isearchsetup.registersearchstrategy.md) | <code>(name: string, strategy: ISearchStrategy) =&gt; void</code> | Extension point exposed for other plugins to register their own search strategies. |
| [usage](./kibana-plugin-plugins-data-server.isearchsetup.usage.md) | <code>SearchUsage</code> | Used internally for telemetry |

Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [ISearchStart](./kibana-plugin-plugins-data-server.isearchstart.md) &gt; [aggs](./kibana-plugin-plugins-data-server.isearchstart.aggs.md)

## ISearchStart.aggs property

<b>Signature:</b>

```typescript
aggs: AggsStart;
```
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ export interface ISearchStart

| Property | Type | Description |
| --- | --- | --- |
| [aggs](./kibana-plugin-plugins-data-server.isearchstart.aggs.md) | <code>AggsStart</code> | |
| [getSearchStrategy](./kibana-plugin-plugins-data-server.isearchstart.getsearchstrategy.md) | <code>(name: string) =&gt; ISearchStrategy</code> | Get other registered search strategies. For example, if a new strategy needs to use the already-registered ES search strategy, it can use this function to accomplish that. |
| [search](./kibana-plugin-plugins-data-server.isearchstart.search.md) | <code>(context: RequestHandlerContext, request: IKibanaSearchRequest, options: ISearchOptions) =&gt; Promise&lt;IKibanaSearchResponse&gt;</code> | |

Loading