Skip to content

Commit

Permalink
Merge branch 'master' of github.com:elastic/kibana into matrix-testing
Browse files Browse the repository at this point in the history
  • Loading branch information
dgieselaar committed Jan 22, 2021
2 parents 761e59e + a0bfdf8 commit 8275837
Show file tree
Hide file tree
Showing 189 changed files with 5,429 additions and 4,110 deletions.
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-public](./kibana-plugin-plugins-data-public.md) &gt; [IndexPattern](./kibana-plugin-plugins-data-public.indexpattern.md) &gt; [addRuntimeField](./kibana-plugin-plugins-data-public.indexpattern.addruntimefield.md)

## IndexPattern.addRuntimeField() method

Add a runtime field - Appended to existing mapped field or a new field is created as appropriate

<b>Signature:</b>

```typescript
addRuntimeField(name: string, runtimeField: RuntimeField): void;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | |
| runtimeField | <code>RuntimeField</code> | |

<b>Returns:</b>

`void`

Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ getAsSavedObjectBody(): {
type: string | undefined;
typeMeta: string | undefined;
allowNoIndex: true | undefined;
runtimeFieldMap: string | undefined;
};
```
<b>Returns:</b>
Expand All @@ -35,5 +36,6 @@ getAsSavedObjectBody(): {
type: string | undefined;
typeMeta: string | undefined;
allowNoIndex: true | undefined;
runtimeFieldMap: string | undefined;
}`

Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ getComputedFields(): {
field: any;
format: string;
}[];
runtimeFields: Record<string, RuntimeField>;
};
```
<b>Returns:</b>
Expand All @@ -25,5 +26,6 @@ getComputedFields(): {
field: any;
format: string;
}[];
runtimeFields: Record<string, RuntimeField>;
}`

Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ export declare class IndexPattern implements IIndexPattern
| Method | Modifiers | Description |
| --- | --- | --- |
| [addRuntimeField(name, runtimeField)](./kibana-plugin-plugins-data-public.indexpattern.addruntimefield.md) | | Add a runtime field - Appended to existing mapped field or a new field is created as appropriate |
| [addScriptedField(name, script, fieldType)](./kibana-plugin-plugins-data-public.indexpattern.addscriptedfield.md) | | Add scripted field to field list |
| [getAggregationRestrictions()](./kibana-plugin-plugins-data-public.indexpattern.getaggregationrestrictions.md) | | |
| [getAsSavedObjectBody()](./kibana-plugin-plugins-data-public.indexpattern.getassavedobjectbody.md) | | Returns index pattern as saved object body for saving |
Expand All @@ -58,6 +59,7 @@ export declare class IndexPattern implements IIndexPattern
| [getTimeField()](./kibana-plugin-plugins-data-public.indexpattern.gettimefield.md) | | |
| [isTimeBased()](./kibana-plugin-plugins-data-public.indexpattern.istimebased.md) | | |
| [isTimeNanosBased()](./kibana-plugin-plugins-data-public.indexpattern.istimenanosbased.md) | | |
| [removeRuntimeField(name)](./kibana-plugin-plugins-data-public.indexpattern.removeruntimefield.md) | | Remove a runtime field - removed from mapped field or removed unmapped field as appropriate |
| [removeScriptedField(fieldName)](./kibana-plugin-plugins-data-public.indexpattern.removescriptedfield.md) | | Remove scripted field from field list |
| [setFieldAttrs(fieldName, attrName, value)](./kibana-plugin-plugins-data-public.indexpattern.setfieldattrs.md) | | |
| [setFieldCount(fieldName, count)](./kibana-plugin-plugins-data-public.indexpattern.setfieldcount.md) | | |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!-- 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; [IndexPattern](./kibana-plugin-plugins-data-public.indexpattern.md) &gt; [removeRuntimeField](./kibana-plugin-plugins-data-public.indexpattern.removeruntimefield.md)

## IndexPattern.removeRuntimeField() method

Remove a runtime field - removed from mapped field or removed unmapped field as appropriate

<b>Signature:</b>

```typescript
removeRuntimeField(name: string): void;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | |

<b>Returns:</b>

`void`

Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ export interface IndexPatternAttributes
| [fieldFormatMap](./kibana-plugin-plugins-data-public.indexpatternattributes.fieldformatmap.md) | <code>string</code> | |
| [fields](./kibana-plugin-plugins-data-public.indexpatternattributes.fields.md) | <code>string</code> | |
| [intervalName](./kibana-plugin-plugins-data-public.indexpatternattributes.intervalname.md) | <code>string</code> | |
| [runtimeFieldMap](./kibana-plugin-plugins-data-public.indexpatternattributes.runtimefieldmap.md) | <code>string</code> | |
| [sourceFilters](./kibana-plugin-plugins-data-public.indexpatternattributes.sourcefilters.md) | <code>string</code> | |
| [timeFieldName](./kibana-plugin-plugins-data-public.indexpatternattributes.timefieldname.md) | <code>string</code> | |
| [title](./kibana-plugin-plugins-data-public.indexpatternattributes.title.md) | <code>string</code> | |
Expand Down
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-public](./kibana-plugin-plugins-data-public.md) &gt; [IndexPatternAttributes](./kibana-plugin-plugins-data-public.indexpatternattributes.md) &gt; [runtimeFieldMap](./kibana-plugin-plugins-data-public.indexpatternattributes.runtimefieldmap.md)

## IndexPatternAttributes.runtimeFieldMap property

<b>Signature:</b>

```typescript
runtimeFieldMap?: string;
```
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-public](./kibana-plugin-plugins-data-public.md) &gt; [IndexPatternField](./kibana-plugin-plugins-data-public.indexpatternfield.md) &gt; [isMapped](./kibana-plugin-plugins-data-public.indexpatternfield.ismapped.md)

## IndexPatternField.isMapped property

Is the field part of the index mapping?

<b>Signature:</b>

```typescript
get isMapped(): boolean | undefined;
```
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,11 @@ export declare class IndexPatternField implements IFieldType
| [displayName](./kibana-plugin-plugins-data-public.indexpatternfield.displayname.md) | | <code>string</code> | |
| [esTypes](./kibana-plugin-plugins-data-public.indexpatternfield.estypes.md) | | <code>string[] &#124; undefined</code> | |
| [filterable](./kibana-plugin-plugins-data-public.indexpatternfield.filterable.md) | | <code>boolean</code> | |
| [isMapped](./kibana-plugin-plugins-data-public.indexpatternfield.ismapped.md) | | <code>boolean &#124; undefined</code> | Is the field part of the index mapping? |
| [lang](./kibana-plugin-plugins-data-public.indexpatternfield.lang.md) | | <code>string &#124; undefined</code> | Script field language |
| [name](./kibana-plugin-plugins-data-public.indexpatternfield.name.md) | | <code>string</code> | |
| [readFromDocValues](./kibana-plugin-plugins-data-public.indexpatternfield.readfromdocvalues.md) | | <code>boolean</code> | |
| [runtimeField](./kibana-plugin-plugins-data-public.indexpatternfield.runtimefield.md) | | <code>RuntimeField &#124; undefined</code> | |
| [script](./kibana-plugin-plugins-data-public.indexpatternfield.script.md) | | <code>string &#124; undefined</code> | Script field code |
| [scripted](./kibana-plugin-plugins-data-public.indexpatternfield.scripted.md) | | <code>boolean</code> | |
| [searchable](./kibana-plugin-plugins-data-public.indexpatternfield.searchable.md) | | <code>boolean</code> | |
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-public](./kibana-plugin-plugins-data-public.md) &gt; [IndexPatternField](./kibana-plugin-plugins-data-public.indexpatternfield.md) &gt; [runtimeField](./kibana-plugin-plugins-data-public.indexpatternfield.runtimefield.md)

## IndexPatternField.runtimeField property

<b>Signature:</b>

```typescript
get runtimeField(): RuntimeField | undefined;

set runtimeField(runtimeField: RuntimeField | undefined);
```
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ export interface IndexPatternSpec
| [fields](./kibana-plugin-plugins-data-public.indexpatternspec.fields.md) | <code>IndexPatternFieldMap</code> | |
| [id](./kibana-plugin-plugins-data-public.indexpatternspec.id.md) | <code>string</code> | saved object id |
| [intervalName](./kibana-plugin-plugins-data-public.indexpatternspec.intervalname.md) | <code>string</code> | |
| [runtimeFieldMap](./kibana-plugin-plugins-data-public.indexpatternspec.runtimefieldmap.md) | <code>Record&lt;string, RuntimeField&gt;</code> | |
| [sourceFilters](./kibana-plugin-plugins-data-public.indexpatternspec.sourcefilters.md) | <code>SourceFilter[]</code> | |
| [timeFieldName](./kibana-plugin-plugins-data-public.indexpatternspec.timefieldname.md) | <code>string</code> | |
| [title](./kibana-plugin-plugins-data-public.indexpatternspec.title.md) | <code>string</code> | |
Expand Down
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-public](./kibana-plugin-plugins-data-public.md) &gt; [IndexPatternSpec](./kibana-plugin-plugins-data-public.indexpatternspec.md) &gt; [runtimeFieldMap](./kibana-plugin-plugins-data-public.indexpatternspec.runtimefieldmap.md)

## IndexPatternSpec.runtimeFieldMap property

<b>Signature:</b>

```typescript
runtimeFieldMap?: Record<string, RuntimeField>;
```
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; [IndexPattern](./kibana-plugin-plugins-data-server.indexpattern.md) &gt; [addRuntimeField](./kibana-plugin-plugins-data-server.indexpattern.addruntimefield.md)

## IndexPattern.addRuntimeField() method

Add a runtime field - Appended to existing mapped field or a new field is created as appropriate

<b>Signature:</b>

```typescript
addRuntimeField(name: string, runtimeField: RuntimeField): void;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | |
| runtimeField | <code>RuntimeField</code> | |

<b>Returns:</b>

`void`

Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ getAsSavedObjectBody(): {
type: string | undefined;
typeMeta: string | undefined;
allowNoIndex: true | undefined;
runtimeFieldMap: string | undefined;
};
```
<b>Returns:</b>
Expand All @@ -35,5 +36,6 @@ getAsSavedObjectBody(): {
type: string | undefined;
typeMeta: string | undefined;
allowNoIndex: true | undefined;
runtimeFieldMap: string | undefined;
}`

Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ getComputedFields(): {
field: any;
format: string;
}[];
runtimeFields: Record<string, RuntimeField>;
};
```
<b>Returns:</b>
Expand All @@ -25,5 +26,6 @@ getComputedFields(): {
field: any;
format: string;
}[];
runtimeFields: Record<string, RuntimeField>;
}`

Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ export declare class IndexPattern implements IIndexPattern
| Method | Modifiers | Description |
| --- | --- | --- |
| [addRuntimeField(name, runtimeField)](./kibana-plugin-plugins-data-server.indexpattern.addruntimefield.md) | | Add a runtime field - Appended to existing mapped field or a new field is created as appropriate |
| [addScriptedField(name, script, fieldType)](./kibana-plugin-plugins-data-server.indexpattern.addscriptedfield.md) | | Add scripted field to field list |
| [getAggregationRestrictions()](./kibana-plugin-plugins-data-server.indexpattern.getaggregationrestrictions.md) | | |
| [getAsSavedObjectBody()](./kibana-plugin-plugins-data-server.indexpattern.getassavedobjectbody.md) | | Returns index pattern as saved object body for saving |
Expand All @@ -58,6 +59,7 @@ export declare class IndexPattern implements IIndexPattern
| [getTimeField()](./kibana-plugin-plugins-data-server.indexpattern.gettimefield.md) | | |
| [isTimeBased()](./kibana-plugin-plugins-data-server.indexpattern.istimebased.md) | | |
| [isTimeNanosBased()](./kibana-plugin-plugins-data-server.indexpattern.istimenanosbased.md) | | |
| [removeRuntimeField(name)](./kibana-plugin-plugins-data-server.indexpattern.removeruntimefield.md) | | Remove a runtime field - removed from mapped field or removed unmapped field as appropriate |
| [removeScriptedField(fieldName)](./kibana-plugin-plugins-data-server.indexpattern.removescriptedfield.md) | | Remove scripted field from field list |
| [setFieldAttrs(fieldName, attrName, value)](./kibana-plugin-plugins-data-server.indexpattern.setfieldattrs.md) | | |
| [setFieldCount(fieldName, count)](./kibana-plugin-plugins-data-server.indexpattern.setfieldcount.md) | | |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!-- 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; [IndexPattern](./kibana-plugin-plugins-data-server.indexpattern.md) &gt; [removeRuntimeField](./kibana-plugin-plugins-data-server.indexpattern.removeruntimefield.md)

## IndexPattern.removeRuntimeField() method

Remove a runtime field - removed from mapped field or removed unmapped field as appropriate

<b>Signature:</b>

```typescript
removeRuntimeField(name: string): void;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | |

<b>Returns:</b>

`void`

Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ export interface IndexPatternAttributes
| [fieldFormatMap](./kibana-plugin-plugins-data-server.indexpatternattributes.fieldformatmap.md) | <code>string</code> | |
| [fields](./kibana-plugin-plugins-data-server.indexpatternattributes.fields.md) | <code>string</code> | |
| [intervalName](./kibana-plugin-plugins-data-server.indexpatternattributes.intervalname.md) | <code>string</code> | |
| [runtimeFieldMap](./kibana-plugin-plugins-data-server.indexpatternattributes.runtimefieldmap.md) | <code>string</code> | |
| [sourceFilters](./kibana-plugin-plugins-data-server.indexpatternattributes.sourcefilters.md) | <code>string</code> | |
| [timeFieldName](./kibana-plugin-plugins-data-server.indexpatternattributes.timefieldname.md) | <code>string</code> | |
| [title](./kibana-plugin-plugins-data-server.indexpatternattributes.title.md) | <code>string</code> | |
Expand Down
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; [IndexPatternAttributes](./kibana-plugin-plugins-data-server.indexpatternattributes.md) &gt; [runtimeFieldMap](./kibana-plugin-plugins-data-server.indexpatternattributes.runtimefieldmap.md)

## IndexPatternAttributes.runtimeFieldMap property

<b>Signature:</b>

```typescript
runtimeFieldMap?: string;
```
2 changes: 1 addition & 1 deletion docs/user/alerting/alert-types.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[role="xpack"]
[[alert-types]]
== Alert types
== Standard stack alert types

{kib} supplies alert types in two ways: some are built into {kib} (these are known as stack alerts), while domain-specific alert types are registered by {kib} apps such as <<xpack-apm,*APM*>>, <<metrics-app,*Metrics*>>, and <<uptime-app,*Uptime*>>.

Expand Down
Loading

0 comments on commit 8275837

Please sign in to comment.