From 7814527439b34a00e7f5685d6fae70afbf80ecca Mon Sep 17 00:00:00 2001 From: delvedor Date: Mon, 16 Aug 2021 11:27:58 +0200 Subject: [PATCH] Updated types --- api/kibana.d.ts | 4 +- api/new.d.ts | 13 ++--- api/types.d.ts | 134 ++++++++++++++++++------------------------------ 3 files changed, 59 insertions(+), 92 deletions(-) diff --git a/api/kibana.d.ts b/api/kibana.d.ts index 7b4c6ea49..a80431ec2 100644 --- a/api/kibana.d.ts +++ b/api/kibana.d.ts @@ -345,7 +345,7 @@ interface KibanaClient { info(params?: T.MlInfoRequest, options?: TransportRequestOptions): TransportRequestPromise> openJob(params: T.MlOpenJobRequest, options?: TransportRequestOptions): TransportRequestPromise> postCalendarEvents(params?: T.MlPostCalendarEventsRequest, options?: TransportRequestOptions): TransportRequestPromise> - postData(params: T.MlPostDataRequest, options?: TransportRequestOptions): TransportRequestPromise> + postData(params: T.MlPostJobDataRequest, options?: TransportRequestOptions): TransportRequestPromise> previewDataFrameAnalytics(params?: T.MlPreviewDataFrameAnalyticsRequest, options?: TransportRequestOptions): TransportRequestPromise> previewDatafeed(params?: T.MlPreviewDatafeedRequest, options?: TransportRequestOptions): TransportRequestPromise, TContext>> putCalendar(params: T.MlPutCalendarRequest, options?: TransportRequestOptions): TransportRequestPromise> @@ -366,7 +366,7 @@ interface KibanaClient { updateDataFrameAnalytics(params: T.MlUpdateDataFrameAnalyticsRequest, options?: TransportRequestOptions): TransportRequestPromise> updateDatafeed(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise> updateFilter(params: T.MlUpdateFilterRequest, options?: TransportRequestOptions): TransportRequestPromise> - updateJob(params: T.MlUpdateJobRequest, options?: TransportRequestOptions): TransportRequestPromise> + updateJob(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise> updateModelSnapshot(params: T.MlUpdateModelSnapshotRequest, options?: TransportRequestOptions): TransportRequestPromise> upgradeJobSnapshot(params: T.MlUpgradeJobSnapshotRequest, options?: TransportRequestOptions): TransportRequestPromise> validate(params?: T.MlValidateJobRequest, options?: TransportRequestOptions): TransportRequestPromise> diff --git a/api/new.d.ts b/api/new.d.ts index a7d882b02..c06583c75 100644 --- a/api/new.d.ts +++ b/api/new.d.ts @@ -950,9 +950,9 @@ declare class Client { postCalendarEvents(callback: callbackFn): TransportRequestCallback postCalendarEvents(params: T.MlPostCalendarEventsRequest, callback: callbackFn): TransportRequestCallback postCalendarEvents(params: T.MlPostCalendarEventsRequest, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback - postData(params: T.MlPostDataRequest, options?: TransportRequestOptions): TransportRequestPromise> - postData(params: T.MlPostDataRequest, callback: callbackFn): TransportRequestCallback - postData(params: T.MlPostDataRequest, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback + postData(params: T.MlPostJobDataRequest, options?: TransportRequestOptions): TransportRequestPromise> + postData(params: T.MlPostJobDataRequest, callback: callbackFn): TransportRequestCallback + postData(params: T.MlPostJobDataRequest, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback previewDataFrameAnalytics(params?: T.MlPreviewDataFrameAnalyticsRequest, options?: TransportRequestOptions): TransportRequestPromise> previewDataFrameAnalytics(callback: callbackFn): TransportRequestCallback previewDataFrameAnalytics(params: T.MlPreviewDataFrameAnalyticsRequest, callback: callbackFn): TransportRequestCallback @@ -1018,9 +1018,10 @@ declare class Client { updateFilter(params: T.MlUpdateFilterRequest, options?: TransportRequestOptions): TransportRequestPromise> updateFilter(params: T.MlUpdateFilterRequest, callback: callbackFn): TransportRequestCallback updateFilter(params: T.MlUpdateFilterRequest, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback - updateJob(params: T.MlUpdateJobRequest, options?: TransportRequestOptions): TransportRequestPromise> - updateJob(params: T.MlUpdateJobRequest, callback: callbackFn): TransportRequestCallback - updateJob(params: T.MlUpdateJobRequest, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback + updateJob(params?: TODO, options?: TransportRequestOptions): TransportRequestPromise> + updateJob(callback: callbackFn): TransportRequestCallback + updateJob(params: TODO, callback: callbackFn): TransportRequestCallback + updateJob(params: TODO, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback updateModelSnapshot(params: T.MlUpdateModelSnapshotRequest, options?: TransportRequestOptions): TransportRequestPromise> updateModelSnapshot(params: T.MlUpdateModelSnapshotRequest, callback: callbackFn): TransportRequestCallback updateModelSnapshot(params: T.MlUpdateModelSnapshotRequest, options: TransportRequestOptions, callback: callbackFn): TransportRequestCallback diff --git a/api/types.d.ts b/api/types.d.ts index 5678de767..9536d1616 100644 --- a/api/types.d.ts +++ b/api/types.d.ts @@ -10135,7 +10135,7 @@ export interface MlAnalysisConfig { categorization_field_name?: Field categorization_filters?: string[] detectors: MlDetector[] - influencers?: Field[] + influencers: Field[] model_prune_window?: Time latency?: Time multivariate_by_fields?: boolean @@ -10266,28 +10266,26 @@ export type MlChunkingMode = 'auto' | 'manual' | 'off' export type MlConditionOperator = 'gt' | 'gte' | 'lt' | 'lte' -export interface MlCustomSettingsKeys { +export interface MlCustomSettings { custom_urls?: XpackUsageUrlConfig[] created_by?: string job_tags?: Record } -export type MlCustomSettings = MlCustomSettingsKeys | - { [property: string]: any } export interface MlDataCounts { bucket_count: long - earliest_record_timestamp?: long + earliest_record_timestamp: long empty_bucket_count: long input_bytes: long input_field_count: long input_record_count: long invalid_date_count: long job_id: Id - last_data_time?: long - latest_empty_bucket_timestamp?: long - latest_record_timestamp?: long - latest_sparse_bucket_timestamp?: long - latest_bucket_timestamp?: long + last_data_time: long + latest_empty_bucket_timestamp: long + latest_record_timestamp: long + latest_sparse_bucket_timestamp: long + latest_bucket_timestamp: long missing_field_count: long out_of_order_timestamp_count: long processed_field_count: long @@ -10328,12 +10326,12 @@ export interface MlDatafeedConfig { datafeed_id?: Id delayed_data_check_config?: MlDelayedDataCheckConfig frequency?: Timestamp - indexes?: Indices - indices?: Indices + indexes?: string[] + indices: string[] indices_options?: MlDatafeedIndicesOptions job_id?: Id max_empty_searches?: integer - query?: QueryDslQueryContainer + query: QueryDslQueryContainer query_delay?: Timestamp runtime_mappings?: MappingRuntimeFields script_fields?: Record @@ -10347,20 +10345,14 @@ export interface MlDatafeedIndicesOptions { ignore_throttled?: boolean } -export interface MlDatafeedRunningState { - real_time_configured: boolean - real_time_running: boolean -} - export type MlDatafeedState = 'started' | 'stopped' | 'starting' | 'stopping' export interface MlDatafeedStats { - assignment_explanation?: string + assignment_explanation: string datafeed_id: Id - node?: MlDiscoveryNode + node: MlDiscoveryNode state: MlDatafeedState timing_stats: MlDatafeedTimingStats - running_state?: MlDatafeedRunningState } export interface MlDatafeedTimingStats { @@ -10369,7 +10361,7 @@ export interface MlDatafeedTimingStats { job_id: Id search_count: long total_search_time_ms: double - average_search_time_per_bucket_ms?: number + average_search_time_per_bucket_ms: number } export interface MlDataframeAnalysis { @@ -10634,11 +10626,10 @@ export interface MlDetector { detector_index?: integer exclude_frequent?: MlExcludeFrequent field_name?: Field - function?: string + function: string over_field_name?: Field partition_field_name?: Field use_null?: boolean - description?: string } export interface MlDiscoveryNode { @@ -10698,9 +10689,9 @@ export interface MlJob { allow_lazy_open: boolean analysis_config: MlAnalysisConfig analysis_limits?: MlAnalysisLimits - background_persist_interval?: Time + background_persist_interval: Time blocked?: MlJobBlocked - create_time?: integer + create_time: integer custom_settings?: MlCustomSettings daily_model_snapshot_retention_after_days?: long data_description: MlDataDescription @@ -10710,8 +10701,8 @@ export interface MlJob { finished_time?: integer groups?: string[] job_id: Id - job_type?: string - job_version?: VersionString + job_type: string + job_version: VersionString model_plot_config?: MlModelPlotConfig model_snapshot_id?: Id model_snapshot_retention_days: long @@ -10766,12 +10757,12 @@ export interface MlJobStatistics { } export interface MlJobStats { - assignment_explanation?: string + assignment_explanation: string data_counts: MlDataCounts forecasts_stats: MlJobForecastStatistics job_id: string model_size_stats: MlModelSizeStats - node?: MlDiscoveryNode + node: MlDiscoveryNode open_time?: DateString state: MlJobState timing_stats: MlJobTimingStats @@ -10779,14 +10770,14 @@ export interface MlJobStats { } export interface MlJobTimingStats { - average_bucket_processing_time_ms?: double + average_bucket_processing_time_ms: double bucket_count: long - exponential_average_bucket_processing_time_ms?: double + exponential_average_bucket_processing_time_ms: double exponential_average_bucket_processing_time_per_hour_ms: double job_id: Id total_bucket_processing_time_ms: double - maximum_bucket_processing_time_ms?: double - minimum_bucket_processing_time_ms?: double + maximum_bucket_processing_time_ms: double + minimum_bucket_processing_time_ms: double } export type MlMemoryStatus = 'ok' | 'soft_limit' | 'hard_limit' @@ -10803,9 +10794,9 @@ export interface MlModelSizeStats { log_time: Time memory_status: MlMemoryStatus model_bytes: long - model_bytes_exceeded?: long - model_bytes_memory_limit?: long - peak_model_bytes?: long + model_bytes_exceeded: long + model_bytes_memory_limit: long + peak_model_bytes: long assignment_memory_basis?: string result_type: string total_by_field_count: long @@ -10824,10 +10815,10 @@ export interface MlModelSizeStats { export interface MlModelSnapshot { description?: string job_id: Id - latest_record_time_stamp?: integer - latest_result_time_stamp?: integer + latest_record_time_stamp: integer + latest_result_time_stamp: integer min_version: VersionString - model_size_stats?: MlModelSizeStats + model_size_stats: MlModelSizeStats retain: boolean snapshot_doc_count: long snapshot_id: Id @@ -11550,7 +11541,6 @@ export interface MlOpenJobRequest extends RequestBase { export interface MlOpenJobResponse { opened: boolean - node: Id } export interface MlPostCalendarEventsRequest extends RequestBase { @@ -11564,22 +11554,18 @@ export interface MlPostCalendarEventsResponse { events: MlCalendarEvent[] } -export type MlPostDataInput = any | MlPostDataMultipleInputs - -export interface MlPostDataMultipleInputs { - data: any[] -} - -export interface MlPostDataRequest extends RequestBase { +export interface MlPostJobDataRequest extends RequestBase { job_id: Id reset_end?: DateString reset_start?: DateString - body?: MlPostDataInput + body?: { + data?: any[] + } } -export interface MlPostDataResponse { +export interface MlPostJobDataResponse { bucket_count: long - earliest_record_timestamp?: integer + earliest_record_timestamp: integer empty_bucket_count: long input_bytes: long input_field_count: long @@ -11587,7 +11573,7 @@ export interface MlPostDataResponse { invalid_date_count: long job_id: Id last_data_time: integer - latest_record_timestamp?: integer + latest_record_timestamp: integer missing_field_count: long out_of_order_timestamp_count: long processed_field_count: long @@ -11622,19 +11608,20 @@ export interface MlPreviewDatafeedRequest extends RequestBase { } } -export type MlPreviewDatafeedResponse = TDocument[] +export interface MlPreviewDatafeedResponse { + data: TDocument[] +} export interface MlPutCalendarRequest extends RequestBase { calendar_id: Id body?: { - job_ids?: Ids description?: string } } export interface MlPutCalendarResponse { calendar_id: Id - description?: string + description: string job_ids: Ids } @@ -11684,13 +11671,12 @@ export interface MlPutDatafeedRequest extends RequestBase { ignore_throttled?: boolean ignore_unavailable?: boolean body?: { - aggs?: Record aggregations?: Record chunking_config?: MlChunkingConfig delayed_data_check_config?: MlDelayedDataCheckConfig frequency?: Time - indices?: Indices - indexes?: Indices + indices?: string[] + indexes?: string[] indices_options?: MlDatafeedIndicesOptions job_id?: Id max_empty_searches?: integer @@ -11703,15 +11689,15 @@ export interface MlPutDatafeedRequest extends RequestBase { } export interface MlPutDatafeedResponse { - aggregations?: Record + aggregations: Record chunking_config: MlChunkingConfig delayed_data_check_config?: MlDelayedDataCheckConfig datafeed_id: Id - frequency?: Time + frequency: Time indices: string[] job_id: Id indices_options?: MlDatafeedIndicesOptions - max_empty_searches?: integer + max_empty_searches: integer query: QueryDslQueryContainer query_delay: Time runtime_mappings?: MappingRuntimeFields @@ -11728,7 +11714,7 @@ export interface MlPutFilterRequest extends RequestBase { } export interface MlPutFilterResponse { - description?: string + description: string filter_id: Id items: string[] } @@ -11808,7 +11794,6 @@ export interface MlResetJobResponse extends AcknowledgedResponseBase { export interface MlRevertModelSnapshotRequest extends RequestBase { job_id: Id snapshot_id: Id - delete_intervening_results?: boolean body?: { delete_intervening_results?: boolean } @@ -11935,27 +11920,7 @@ export interface MlUpdateJobRequest extends RequestBase { } export interface MlUpdateJobResponse { - allow_lazy_open: boolean - analysis_config: MlAnalysisConfig - analysis_limits: MlAnalysisLimits - background_persist_interval?: Time - create_time: Time - custom_settings?: MlCustomSettings - daily_model_snapshot_retention_after_days: long - data_description: MlDataDescription - datafeed_config?: MlDatafeed - description?: string - groups?: string[] - job_id: Id - job_type: string - job_version: string - finished_time?: Time - model_plot_config?: MlModelPlotConfig - model_snapshot_id?: Id - model_snapshot_retention_days: long - renormalization_window_days?: long - results_index_name: string - results_retention_days?: long + stub: boolean } export interface MlUpdateModelSnapshotRequest extends RequestBase { @@ -13814,6 +13779,7 @@ export interface SnapshotCreateRequest extends RequestBase { ignore_unavailable?: boolean include_global_state?: boolean indices?: Indices + feature_states?: string[] metadata?: Metadata partial?: boolean }