diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 0e53f9ad41..e3695e82bc 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -123542,6 +123542,14 @@ "default": 500.0, "type": "number" }, + "use_point_in_time": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/8.19/point-in-time-api.html" + }, + "description": "Specifies whether the transform checkpoint will use the Point In Time API while searching over the source index.\nIn general, Point In Time is an optimization that will reduce pressure on the source index by reducing the amount\nof refreshes and merges, but it can be expensive if a large number of Point In Times are opened and closed for a\ngiven index. The benefits and impact depend on the data being searched, the ingest rate into the source index, and\nthe amount of other consumers searching the same source index.", + "default": true, + "type": "boolean" + }, "unattended": { "description": "If `true`, the transform runs in unattended mode. In unattended mode, the transform retries indefinitely in case\nof an error which means the transform never fails. Setting the number of retries other than infinite fails in\nvalidation.", "default": false, diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index d609668481..9fa4728f76 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -78141,6 +78141,14 @@ "default": 500.0, "type": "number" }, + "use_point_in_time": { + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/point-in-time-api.html" + }, + "description": "Specifies whether the transform checkpoint will use the Point In Time API while searching over the source index.\nIn general, Point In Time is an optimization that will reduce pressure on the source index by reducing the amount\nof refreshes and merges, but it can be expensive if a large number of Point In Times are opened and closed for a\ngiven index. The benefits and impact depend on the data being searched, the ingest rate into the source index, and\nthe amount of other consumers searching the same source index.", + "default": true, + "type": "boolean" + }, "unattended": { "description": "If `true`, the transform runs in unattended mode. In unattended mode, the transform retries indefinitely in case\nof an error which means the transform never fails. Setting the number of retries other than infinite fails in\nvalidation.", "default": false, diff --git a/output/schema/schema.json b/output/schema/schema.json index b305b82ec2..af9bdd2fa2 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -259294,6 +259294,21 @@ } } }, + { + "description": "Specifies whether the transform checkpoint will use the Point In Time API while searching over the source index.\nIn general, Point In Time is an optimization that will reduce pressure on the source index by reducing the amount\nof refreshes and merges, but it can be expensive if a large number of Point In Times are opened and closed for a\ngiven index. The benefits and impact depend on the data being searched, the ingest rate into the source index, and\nthe amount of other consumers searching the same source index.", + "extDocId": "point-in-time-api", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/point-in-time-api.html", + "name": "use_point_in_time", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, { "availability": { "serverless": {}, @@ -259314,7 +259329,7 @@ } } ], - "specLocation": "transform/_types/Transform.ts#L98-L144" + "specLocation": "transform/_types/Transform.ts#L98-L154" }, { "kind": "interface", @@ -259366,7 +259381,7 @@ } } ], - "specLocation": "transform/_types/Transform.ts#L146-L165" + "specLocation": "transform/_types/Transform.ts#L156-L175" }, { "kind": "interface", @@ -259388,7 +259403,7 @@ } } ], - "specLocation": "transform/_types/Transform.ts#L169-L175", + "specLocation": "transform/_types/Transform.ts#L179-L185", "variants": { "kind": "container" } @@ -259426,7 +259441,7 @@ } } ], - "specLocation": "transform/_types/Transform.ts#L177-L189" + "specLocation": "transform/_types/Transform.ts#L187-L199" }, { "kind": "request", diff --git a/output/typescript/types.ts b/output/typescript/types.ts index e0c07e7abe..88ad2f388b 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -22207,6 +22207,7 @@ export interface TransformSettings { deduce_mappings?: boolean docs_per_second?: float max_page_search_size?: integer + use_point_in_time?: boolean unattended?: boolean } diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index 7a82c161f5..8b03144435 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -499,7 +499,7 @@ painless-contexts,https://www.elastic.co/guide/en/elasticsearch/painless/{branch painless-execute-api,https://www.elastic.co/guide/en/elasticsearch/painless/{branch}/painless-execute-api.html,, pipeline-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/pipeline-processor.html,, pki-realm,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/pki-realm.html,, -point-in-time-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/point-in-time-api.html,, +point-in-time-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/point-in-time-api.html,,Open a point in time API prevalidate-node-removal,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/prevalidate-node-removal-api.html,, preview-dfanalytics,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/preview-dfanalytics.html,, preview-transform,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/preview-transform.html,, diff --git a/specification/transform/_types/Transform.ts b/specification/transform/_types/Transform.ts index ed11e0bcb1..f363aa5ac0 100644 --- a/specification/transform/_types/Transform.ts +++ b/specification/transform/_types/Transform.ts @@ -130,6 +130,16 @@ export class Settings { * @server_default 500 */ max_page_search_size?: integer + /** + * Specifies whether the transform checkpoint will use the Point In Time API while searching over the source index. + * In general, Point In Time is an optimization that will reduce pressure on the source index by reducing the amount + * of refreshes and merges, but it can be expensive if a large number of Point In Times are opened and closed for a + * given index. The benefits and impact depend on the data being searched, the ingest rate into the source index, and + * the amount of other consumers searching the same source index. + * @ext_doc_id point-in-time-api + * @server_default true + */ + use_point_in_time?: boolean /** * If `true`, the transform runs in unattended mode. In unattended mode, the transform retries indefinitely in case