Add system_annotations_retention_days to ML APIs (#522)

lcawl · web-flow · commit 18d4e03c163c · 2021-07-30T11:14:06.000+02:00
diff --git a/output/schema/schema.json b/output/schema/schema.json
@@ -105303,6 +105303,17 @@
               "namespace": "_types"
             }
           }
+        },
+        {
+          "name": "system_annotations_retention_days",
+          "required": false,
+          "type": {
+            "kind": "instance_of",
+            "type": {
+              "name": "long",
+              "namespace": "_types"
+            }
+          }
         }
       ]
     },
@@ -105502,6 +105513,17 @@
               "namespace": "_types"
             }
           }
+        },
+        {
+          "name": "system_annotations_retention_days",
+          "required": false,
+          "type": {
+            "kind": "instance_of",
+            "type": {
+              "name": "long",
+              "namespace": "_types"
+            }
+          }
         }
       ]
     },
@@ -114070,6 +114092,18 @@
                 "namespace": "_types"
               }
             }
+          },
+          {
+            "description": "Advanced configuration option. The period of time (in days) that automatically created annotations are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), annotations that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all annotations are retained. User created annotations are never deleted automatically.",
+            "name": "system_annotations_retention_days",
+            "required": false,
+            "type": {
+              "kind": "instance_of",
+              "type": {
+                "name": "long",
+                "namespace": "_types"
+              }
+            }
           }
         ]
       },
@@ -114326,6 +114360,17 @@
                 "namespace": "_types"
               }
             }
+          },
+          {
+            "name": "system_annotations_retention_days",
+            "required": false,
+            "type": {
+              "kind": "instance_of",
+              "type": {
+                "name": "long",
+                "namespace": "_types"
+              }
+            }
           }
         ]
       },
@@ -115573,6 +115618,18 @@
                 "namespace": "ml._types"
               }
             }
+          },
+          {
+            "description": "Advanced configuration option. The period of time (in days) that automatically created annotations are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), annotations that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all annotations are retained. User created annotations are never deleted automatically.",
+            "name": "system_annotations_retention_days",
+            "required": false,
+            "type": {
+              "kind": "instance_of",
+              "type": {
+                "name": "long",
+                "namespace": "_types"
+              }
+            }
           }
         ]
       },
diff --git a/output/typescript/types.ts b/output/typescript/types.ts
@@ -10707,6 +10707,7 @@ export interface MlJob {
   renormalization_window_days?: long
   results_index_name: IndexName
   results_retention_days?: long
+  system_annotations_retention_days?: long
 }
 
 export interface MlJobConfig {
@@ -10727,6 +10728,7 @@ export interface MlJobConfig {
   renormalization_window_days?: long
   results_index_name?: IndexName
   results_retention_days?: long
+  system_annotations_retention_days?: long
 }
 
 export interface MlJobForecastStatistics {
@@ -11731,6 +11733,7 @@ export interface MlPutJobRequest extends RequestBase {
     renormalization_window_days?: long
     results_index_name?: IndexName
     results_retention_days?: long
+    system_annotations_retention_days?: long
   }
 }
 
@@ -11755,6 +11758,7 @@ export interface MlPutJobResponse {
   renormalization_window_days?: long
   results_index_name: string
   results_retention_days?: long
+  system_annotations_retention_days?: long
 }
 
 export interface MlPutTrainedModelRequest extends RequestBase {
@@ -11903,6 +11907,7 @@ export interface MlUpdateJobRequest extends RequestBase {
     groups?: string[]
     detectors?: MlDetector[]
     per_partition_categorization?: MlPerPartitionCategorization
+    system_annotations_retention_days?: long
   }
 }
 
diff --git a/specification/ml/_types/Job.ts b/specification/ml/_types/Job.ts
@@ -66,6 +66,7 @@ export class Job {
   renormalization_window_days?: long
   results_index_name: IndexName
   results_retention_days?: long
+  system_annotations_retention_days?: long
 }
 
 export class JobConfig {
@@ -86,6 +87,7 @@ export class JobConfig {
   renormalization_window_days?: long
   results_index_name?: IndexName
   results_retention_days?: long
+  system_annotations_retention_days?: long
 }
 export class JobStats {
   assignment_explanation: string
diff --git a/specification/ml/put_job/MlPutJobRequest.ts b/specification/ml/put_job/MlPutJobRequest.ts
@@ -104,5 +104,9 @@ export interface Request extends RequestBase {
      * Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained.
      */
     results_retention_days?: long
+    /**
+     * Advanced configuration option. The period of time (in days) that automatically created annotations are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), annotations that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all annotations are retained. User created annotations are never deleted automatically.
+     */
+    system_annotations_retention_days?: long
   }
 }
diff --git a/specification/ml/put_job/MlPutJobResponse.ts b/specification/ml/put_job/MlPutJobResponse.ts
@@ -48,5 +48,6 @@ export class Response {
     renormalization_window_days?: long
     results_index_name: string
     results_retention_days?: long
+    system_annotations_retention_days?: long
   }
 }
diff --git a/specification/ml/update_job/MlUpdateJobRequest.ts b/specification/ml/update_job/MlUpdateJobRequest.ts
@@ -89,5 +89,9 @@ export interface Request extends RequestBase {
      * Settings related to how categorization interacts with partition fields.
      */
     per_partition_categorization?: PerPartitionCategorization
+    /**
+     * Advanced configuration option. The period of time (in days) that automatically created annotations are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), annotations that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all annotations are retained. User created annotations are never deleted automatically.
+     */
+    system_annotations_retention_days?: long
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -105303,6 +105303,17 @@`
`105303`	`105303`	`"namespace": "_types"`
`105304`	`105304`	`}`
`105305`	`105305`	`}`
	`105306`	`+ },`
	`105307`	`+ {`
	`105308`	`+ "name": "system_annotations_retention_days",`
	`105309`	`+ "required": false,`
	`105310`	`+ "type": {`
	`105311`	`+ "kind": "instance_of",`
	`105312`	`+ "type": {`
	`105313`	`+ "name": "long",`
	`105314`	`+ "namespace": "_types"`
	`105315`	`+ }`
	`105316`	`+ }`
`105306`	`105317`	`}`
`105307`	`105318`	`]`
`105308`	`105319`	`},`
`@@ -105502,6 +105513,17 @@`
`105502`	`105513`	`"namespace": "_types"`
`105503`	`105514`	`}`
`105504`	`105515`	`}`
	`105516`	`+ },`
	`105517`	`+ {`
	`105518`	`+ "name": "system_annotations_retention_days",`
	`105519`	`+ "required": false,`
	`105520`	`+ "type": {`
	`105521`	`+ "kind": "instance_of",`
	`105522`	`+ "type": {`
	`105523`	`+ "name": "long",`
	`105524`	`+ "namespace": "_types"`
	`105525`	`+ }`
	`105526`	`+ }`
`105505`	`105527`	`}`
`105506`	`105528`	`]`
`105507`	`105529`	`},`
`@@ -114070,6 +114092,18 @@`
`114070`	`114092`	`"namespace": "_types"`
`114071`	`114093`	`}`
`114072`	`114094`	`}`
	`114095`	`+ },`
	`114096`	`+ {`
	`114097`	+ "description": "Advanced configuration option. The period of time (in days) that automatically created annotations are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), annotations that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all annotations are retained. User created annotations are never deleted automatically.",
	`114098`	`+ "name": "system_annotations_retention_days",`
	`114099`	`+ "required": false,`
	`114100`	`+ "type": {`
	`114101`	`+ "kind": "instance_of",`
	`114102`	`+ "type": {`
	`114103`	`+ "name": "long",`
	`114104`	`+ "namespace": "_types"`
	`114105`	`+ }`
	`114106`	`+ }`
`114073`	`114107`	`}`
`114074`	`114108`	`]`
`114075`	`114109`	`},`
`@@ -114326,6 +114360,17 @@`
`114326`	`114360`	`"namespace": "_types"`
`114327`	`114361`	`}`
`114328`	`114362`	`}`
	`114363`	`+ },`
	`114364`	`+ {`
	`114365`	`+ "name": "system_annotations_retention_days",`
	`114366`	`+ "required": false,`
	`114367`	`+ "type": {`
	`114368`	`+ "kind": "instance_of",`
	`114369`	`+ "type": {`
	`114370`	`+ "name": "long",`
	`114371`	`+ "namespace": "_types"`
	`114372`	`+ }`
	`114373`	`+ }`
`114329`	`114374`	`}`
`114330`	`114375`	`]`
`114331`	`114376`	`},`
`@@ -115573,6 +115618,18 @@`
`115573`	`115618`	`"namespace": "ml._types"`
`115574`	`115619`	`}`
`115575`	`115620`	`}`
	`115621`	`+ },`
	`115622`	`+ {`
	`115623`	+ "description": "Advanced configuration option. The period of time (in days) that automatically created annotations are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), annotations that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all annotations are retained. User created annotations are never deleted automatically.",
	`115624`	`+ "name": "system_annotations_retention_days",`
	`115625`	`+ "required": false,`
	`115626`	`+ "type": {`
	`115627`	`+ "kind": "instance_of",`
	`115628`	`+ "type": {`
	`115629`	`+ "name": "long",`
	`115630`	`+ "namespace": "_types"`
	`115631`	`+ }`
	`115632`	`+ }`
`115576`	`115633`	`}`
`115577`	`115634`	`]`
`115578`	`115635`	`},`
Original file line number	Diff line number	Diff line change
`@@ -10707,6 +10707,7 @@ export interface MlJob {`
`10707`	`10707`	`renormalization_window_days?: long`
`10708`	`10708`	`results_index_name: IndexName`
`10709`	`10709`	`results_retention_days?: long`
	`10710`	`+ system_annotations_retention_days?: long`
`10710`	`10711`	`}`
`10711`	`10712`
`10712`	`10713`	`export interface MlJobConfig {`
`@@ -10727,6 +10728,7 @@ export interface MlJobConfig {`
`10727`	`10728`	`renormalization_window_days?: long`
`10728`	`10729`	`results_index_name?: IndexName`
`10729`	`10730`	`results_retention_days?: long`
	`10731`	`+ system_annotations_retention_days?: long`
`10730`	`10732`	`}`
`10731`	`10733`
`10732`	`10734`	`export interface MlJobForecastStatistics {`
`@@ -11731,6 +11733,7 @@ export interface MlPutJobRequest extends RequestBase {`
`11731`	`11733`	`renormalization_window_days?: long`
`11732`	`11734`	`results_index_name?: IndexName`
`11733`	`11735`	`results_retention_days?: long`
	`11736`	`+ system_annotations_retention_days?: long`
`11734`	`11737`	`}`
`11735`	`11738`	`}`
`11736`	`11739`
`@@ -11755,6 +11758,7 @@ export interface MlPutJobResponse {`
`11755`	`11758`	`renormalization_window_days?: long`
`11756`	`11759`	`results_index_name: string`
`11757`	`11760`	`results_retention_days?: long`
	`11761`	`+ system_annotations_retention_days?: long`
`11758`	`11762`	`}`
`11759`	`11763`
`11760`	`11764`	`export interface MlPutTrainedModelRequest extends RequestBase {`
`@@ -11903,6 +11907,7 @@ export interface MlUpdateJobRequest extends RequestBase {`
`11903`	`11907`	`groups?: string[]`
`11904`	`11908`	`detectors?: MlDetector[]`
`11905`	`11909`	`per_partition_categorization?: MlPerPartitionCategorization`
	`11910`	`+ system_annotations_retention_days?: long`
`11906`	`11911`	`}`
`11907`	`11912`	`}`
`11908`	`11913`
Original file line number	Diff line number	Diff line change
`@@ -66,6 +66,7 @@ export class Job {`
`66`	`66`	`renormalization_window_days?: long`
`67`	`67`	`results_index_name: IndexName`
`68`	`68`	`results_retention_days?: long`
	`69`	`+ system_annotations_retention_days?: long`
`69`	`70`	`}`
`70`	`71`
`71`	`72`	`export class JobConfig {`
`@@ -86,6 +87,7 @@ export class JobConfig {`
`86`	`87`	`renormalization_window_days?: long`
`87`	`88`	`results_index_name?: IndexName`
`88`	`89`	`results_retention_days?: long`
	`90`	`+ system_annotations_retention_days?: long`
`89`	`91`	`}`
`90`	`92`	`export class JobStats {`
`91`	`93`	`assignment_explanation: string`
Original file line number	Diff line number	Diff line change
`@@ -104,5 +104,9 @@ export interface Request extends RequestBase {`
`104`	`104`	`* Advanced configuration option. The period of time (in days) that results are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), results that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all results are retained.`
`105`	`105`	`*/`
`106`	`106`	`results_retention_days?: long`
	`107`	`+ /**`
	`108`	+ * Advanced configuration option. The period of time (in days) that automatically created annotations are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), annotations that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all annotations are retained. User created annotations are never deleted automatically.
	`109`	`+ */`
	`110`	`+ system_annotations_retention_days?: long`
`107`	`111`	`}`
`108`	`112`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,5 +48,6 @@ export class Response {`
`48`	`48`	`renormalization_window_days?: long`
`49`	`49`	`results_index_name: string`
`50`	`50`	`results_retention_days?: long`
	`51`	`+ system_annotations_retention_days?: long`
`51`	`52`	`}`
`52`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -89,5 +89,9 @@ export interface Request extends RequestBase {`
`89`	`89`	`* Settings related to how categorization interacts with partition fields.`
`90`	`90`	`*/`
`91`	`91`	`per_partition_categorization?: PerPartitionCategorization`
	`92`	`+ /**`
	`93`	+ * Advanced configuration option. The period of time (in days) that automatically created annotations are retained. Age is calculated relative to the timestamp of the latest bucket result. If this property has a non-null value, once per day at 00:30 (server time), annotations that are the specified number of days older than the latest bucket result are deleted from Elasticsearch. The default value is null, which means all annotations are retained. User created annotations are never deleted automatically.
	`94`	`+ */`
	`95`	`+ system_annotations_retention_days?: long`
`92`	`96`	`}`
`93`	`97`	`}`