|
3639 | 3639 | "deprecated": false, |
3640 | 3640 | "trackAdoption": false |
3641 | 3641 | }, |
3642 | | - { |
3643 | | - "parentPluginId": "alerting", |
3644 | | - "id": "def-server.RuleExecutorOptions.maintenanceWindowIds", |
3645 | | - "type": "Array", |
3646 | | - "tags": [], |
3647 | | - "label": "maintenanceWindowIds", |
3648 | | - "description": [], |
3649 | | - "signature": [ |
3650 | | - "string[] | undefined" |
3651 | | - ], |
3652 | | - "path": "x-pack/plugins/alerting/server/types.ts", |
3653 | | - "deprecated": false, |
3654 | | - "trackAdoption": false |
3655 | | - }, |
3656 | 3642 | { |
3657 | 3643 | "parentPluginId": "alerting", |
3658 | 3644 | "id": "def-server.RuleExecutorOptions.getTimeRange", |
|
3712 | 3698 | "children": [ |
3713 | 3699 | { |
3714 | 3700 | "parentPluginId": "alerting", |
3715 | | - "id": "def-server.RuleExecutorServices.savedObjectsClient", |
3716 | | - "type": "Object", |
| 3701 | + "id": "def-server.RuleExecutorServices.alertsClient", |
| 3702 | + "type": "CompoundType", |
3717 | 3703 | "tags": [], |
3718 | | - "label": "savedObjectsClient", |
3719 | | - "description": [], |
3720 | | - "signature": [ |
3721 | | - { |
3722 | | - "pluginId": "@kbn/core-saved-objects-api-server", |
3723 | | - "scope": "server", |
3724 | | - "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", |
3725 | | - "section": "def-server.SavedObjectsClientContract", |
3726 | | - "text": "SavedObjectsClientContract" |
3727 | | - } |
| 3704 | + "label": "alertsClient", |
| 3705 | + "description": [ |
| 3706 | + "\nOnly available when framework alerts are enabled and rule\ntype has registered alert context with the framework with shouldWrite set to true" |
3728 | 3707 | ], |
3729 | | - "path": "x-pack/plugins/alerting/server/types.ts", |
3730 | | - "deprecated": false, |
3731 | | - "trackAdoption": false |
3732 | | - }, |
3733 | | - { |
3734 | | - "parentPluginId": "alerting", |
3735 | | - "id": "def-server.RuleExecutorServices.uiSettingsClient", |
3736 | | - "type": "Object", |
3737 | | - "tags": [], |
3738 | | - "label": "uiSettingsClient", |
3739 | | - "description": [], |
3740 | 3708 | "signature": [ |
3741 | | - { |
3742 | | - "pluginId": "@kbn/core-ui-settings-server", |
3743 | | - "scope": "server", |
3744 | | - "docId": "kibKbnCoreUiSettingsServerPluginApi", |
3745 | | - "section": "def-server.IUiSettingsClient", |
3746 | | - "text": "IUiSettingsClient" |
3747 | | - } |
3748 | | - ], |
3749 | | - "path": "x-pack/plugins/alerting/server/types.ts", |
3750 | | - "deprecated": false, |
3751 | | - "trackAdoption": false |
3752 | | - }, |
3753 | | - { |
3754 | | - "parentPluginId": "alerting", |
3755 | | - "id": "def-server.RuleExecutorServices.scopedClusterClient", |
3756 | | - "type": "Object", |
3757 | | - "tags": [], |
3758 | | - "label": "scopedClusterClient", |
3759 | | - "description": [], |
3760 | | - "signature": [ |
3761 | | - { |
3762 | | - "pluginId": "@kbn/core-elasticsearch-server", |
3763 | | - "scope": "server", |
3764 | | - "docId": "kibKbnCoreElasticsearchServerPluginApi", |
3765 | | - "section": "def-server.IScopedClusterClient", |
3766 | | - "text": "IScopedClusterClient" |
3767 | | - } |
| 3709 | + "PublicAlertsClient", |
| 3710 | + "<AlertData, State, Context, ActionGroupIds> | null" |
3768 | 3711 | ], |
3769 | 3712 | "path": "x-pack/plugins/alerting/server/types.ts", |
3770 | 3713 | "deprecated": false, |
|
3818 | 3761 | }, |
3819 | 3762 | { |
3820 | 3763 | "parentPluginId": "alerting", |
3821 | | - "id": "def-server.RuleExecutorServices.alertsClient", |
3822 | | - "type": "CompoundType", |
| 3764 | + "id": "def-server.RuleExecutorServices.getDataViews", |
| 3765 | + "type": "Function", |
3823 | 3766 | "tags": [], |
3824 | | - "label": "alertsClient", |
3825 | | - "description": [ |
3826 | | - "\nOnly available when framework alerts are enabled and rule\ntype has registered alert context with the framework with shouldWrite set to true" |
3827 | | - ], |
| 3767 | + "label": "getDataViews", |
| 3768 | + "description": [], |
3828 | 3769 | "signature": [ |
3829 | | - "PublicAlertsClient", |
3830 | | - "<AlertData, State, Context, ActionGroupIds> | null" |
| 3770 | + "() => Promise<", |
| 3771 | + { |
| 3772 | + "pluginId": "dataViews", |
| 3773 | + "scope": "common", |
| 3774 | + "docId": "kibDataViewsPluginApi", |
| 3775 | + "section": "def-common.DataViewsContract", |
| 3776 | + "text": "DataViewsContract" |
| 3777 | + }, |
| 3778 | + ">" |
3831 | 3779 | ], |
3832 | 3780 | "path": "x-pack/plugins/alerting/server/types.ts", |
3833 | 3781 | "deprecated": false, |
3834 | | - "trackAdoption": false |
| 3782 | + "trackAdoption": false, |
| 3783 | + "children": [], |
| 3784 | + "returnComment": [] |
3835 | 3785 | }, |
3836 | 3786 | { |
3837 | 3787 | "parentPluginId": "alerting", |
3838 | | - "id": "def-server.RuleExecutorServices.shouldWriteAlerts", |
| 3788 | + "id": "def-server.RuleExecutorServices.getMaintenanceWindowIds", |
3839 | 3789 | "type": "Function", |
3840 | 3790 | "tags": [], |
3841 | | - "label": "shouldWriteAlerts", |
| 3791 | + "label": "getMaintenanceWindowIds", |
3842 | 3792 | "description": [], |
3843 | 3793 | "signature": [ |
3844 | | - "() => boolean" |
| 3794 | + "() => Promise<string[]>" |
3845 | 3795 | ], |
3846 | 3796 | "path": "x-pack/plugins/alerting/server/types.ts", |
3847 | 3797 | "deprecated": false, |
|
3851 | 3801 | }, |
3852 | 3802 | { |
3853 | 3803 | "parentPluginId": "alerting", |
3854 | | - "id": "def-server.RuleExecutorServices.shouldStopExecution", |
| 3804 | + "id": "def-server.RuleExecutorServices.getSearchSourceClient", |
3855 | 3805 | "type": "Function", |
3856 | 3806 | "tags": [], |
3857 | | - "label": "shouldStopExecution", |
| 3807 | + "label": "getSearchSourceClient", |
3858 | 3808 | "description": [], |
3859 | 3809 | "signature": [ |
3860 | | - "() => boolean" |
| 3810 | + "() => Promise<", |
| 3811 | + { |
| 3812 | + "pluginId": "data", |
| 3813 | + "scope": "common", |
| 3814 | + "docId": "kibDataSearchPluginApi", |
| 3815 | + "section": "def-common.ISearchStartSearchSource", |
| 3816 | + "text": "ISearchStartSearchSource" |
| 3817 | + }, |
| 3818 | + ">" |
3861 | 3819 | ], |
3862 | 3820 | "path": "x-pack/plugins/alerting/server/types.ts", |
3863 | 3821 | "deprecated": false, |
|
3880 | 3838 | "deprecated": false, |
3881 | 3839 | "trackAdoption": false |
3882 | 3840 | }, |
| 3841 | + { |
| 3842 | + "parentPluginId": "alerting", |
| 3843 | + "id": "def-server.RuleExecutorServices.ruleResultService", |
| 3844 | + "type": "Object", |
| 3845 | + "tags": [], |
| 3846 | + "label": "ruleResultService", |
| 3847 | + "description": [], |
| 3848 | + "signature": [ |
| 3849 | + "PublicLastRunSetters", |
| 3850 | + " | undefined" |
| 3851 | + ], |
| 3852 | + "path": "x-pack/plugins/alerting/server/types.ts", |
| 3853 | + "deprecated": false, |
| 3854 | + "trackAdoption": false |
| 3855 | + }, |
| 3856 | + { |
| 3857 | + "parentPluginId": "alerting", |
| 3858 | + "id": "def-server.RuleExecutorServices.savedObjectsClient", |
| 3859 | + "type": "Object", |
| 3860 | + "tags": [], |
| 3861 | + "label": "savedObjectsClient", |
| 3862 | + "description": [], |
| 3863 | + "signature": [ |
| 3864 | + { |
| 3865 | + "pluginId": "@kbn/core-saved-objects-api-server", |
| 3866 | + "scope": "server", |
| 3867 | + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", |
| 3868 | + "section": "def-server.SavedObjectsClientContract", |
| 3869 | + "text": "SavedObjectsClientContract" |
| 3870 | + } |
| 3871 | + ], |
| 3872 | + "path": "x-pack/plugins/alerting/server/types.ts", |
| 3873 | + "deprecated": false, |
| 3874 | + "trackAdoption": false |
| 3875 | + }, |
| 3876 | + { |
| 3877 | + "parentPluginId": "alerting", |
| 3878 | + "id": "def-server.RuleExecutorServices.scopedClusterClient", |
| 3879 | + "type": "Object", |
| 3880 | + "tags": [], |
| 3881 | + "label": "scopedClusterClient", |
| 3882 | + "description": [], |
| 3883 | + "signature": [ |
| 3884 | + { |
| 3885 | + "pluginId": "@kbn/core-elasticsearch-server", |
| 3886 | + "scope": "server", |
| 3887 | + "docId": "kibKbnCoreElasticsearchServerPluginApi", |
| 3888 | + "section": "def-server.IScopedClusterClient", |
| 3889 | + "text": "IScopedClusterClient" |
| 3890 | + } |
| 3891 | + ], |
| 3892 | + "path": "x-pack/plugins/alerting/server/types.ts", |
| 3893 | + "deprecated": false, |
| 3894 | + "trackAdoption": false |
| 3895 | + }, |
3883 | 3896 | { |
3884 | 3897 | "parentPluginId": "alerting", |
3885 | 3898 | "id": "def-server.RuleExecutorServices.share", |
|
3902 | 3915 | }, |
3903 | 3916 | { |
3904 | 3917 | "parentPluginId": "alerting", |
3905 | | - "id": "def-server.RuleExecutorServices.ruleResultService", |
3906 | | - "type": "Object", |
| 3918 | + "id": "def-server.RuleExecutorServices.shouldStopExecution", |
| 3919 | + "type": "Function", |
3907 | 3920 | "tags": [], |
3908 | | - "label": "ruleResultService", |
| 3921 | + "label": "shouldStopExecution", |
3909 | 3922 | "description": [], |
3910 | 3923 | "signature": [ |
3911 | | - "PublicLastRunSetters", |
3912 | | - " | undefined" |
| 3924 | + "() => boolean" |
3913 | 3925 | ], |
3914 | 3926 | "path": "x-pack/plugins/alerting/server/types.ts", |
3915 | 3927 | "deprecated": false, |
3916 | | - "trackAdoption": false |
| 3928 | + "trackAdoption": false, |
| 3929 | + "children": [], |
| 3930 | + "returnComment": [] |
3917 | 3931 | }, |
3918 | 3932 | { |
3919 | 3933 | "parentPluginId": "alerting", |
3920 | | - "id": "def-server.RuleExecutorServices.getDataViews", |
| 3934 | + "id": "def-server.RuleExecutorServices.shouldWriteAlerts", |
3921 | 3935 | "type": "Function", |
3922 | 3936 | "tags": [], |
3923 | | - "label": "getDataViews", |
| 3937 | + "label": "shouldWriteAlerts", |
3924 | 3938 | "description": [], |
3925 | 3939 | "signature": [ |
3926 | | - "() => Promise<", |
3927 | | - { |
3928 | | - "pluginId": "dataViews", |
3929 | | - "scope": "common", |
3930 | | - "docId": "kibDataViewsPluginApi", |
3931 | | - "section": "def-common.DataViewsContract", |
3932 | | - "text": "DataViewsContract" |
3933 | | - }, |
3934 | | - ">" |
| 3940 | + "() => boolean" |
3935 | 3941 | ], |
3936 | 3942 | "path": "x-pack/plugins/alerting/server/types.ts", |
3937 | 3943 | "deprecated": false, |
|
3941 | 3947 | }, |
3942 | 3948 | { |
3943 | 3949 | "parentPluginId": "alerting", |
3944 | | - "id": "def-server.RuleExecutorServices.getSearchSourceClient", |
3945 | | - "type": "Function", |
| 3950 | + "id": "def-server.RuleExecutorServices.uiSettingsClient", |
| 3951 | + "type": "Object", |
3946 | 3952 | "tags": [], |
3947 | | - "label": "getSearchSourceClient", |
| 3953 | + "label": "uiSettingsClient", |
3948 | 3954 | "description": [], |
3949 | 3955 | "signature": [ |
3950 | | - "() => Promise<", |
3951 | 3956 | { |
3952 | | - "pluginId": "data", |
3953 | | - "scope": "common", |
3954 | | - "docId": "kibDataSearchPluginApi", |
3955 | | - "section": "def-common.ISearchStartSearchSource", |
3956 | | - "text": "ISearchStartSearchSource" |
3957 | | - }, |
3958 | | - ">" |
| 3957 | + "pluginId": "@kbn/core-ui-settings-server", |
| 3958 | + "scope": "server", |
| 3959 | + "docId": "kibKbnCoreUiSettingsServerPluginApi", |
| 3960 | + "section": "def-server.IUiSettingsClient", |
| 3961 | + "text": "IUiSettingsClient" |
| 3962 | + } |
3959 | 3963 | ], |
3960 | 3964 | "path": "x-pack/plugins/alerting/server/types.ts", |
3961 | 3965 | "deprecated": false, |
3962 | | - "trackAdoption": false, |
3963 | | - "children": [], |
3964 | | - "returnComment": [] |
| 3966 | + "trackAdoption": false |
3965 | 3967 | } |
3966 | 3968 | ], |
3967 | 3969 | "initialIsOpen": false |
|
0 commit comments