diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 9533f9fadc..91f04a6537 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -15687,6 +15687,245 @@ ] } }, + "/_data_stream/{name}/_options": { + "get": { + "tags": [ + "data stream" + ], + "summary": "Get data stream options", + "description": "Get the data stream options configuration of one or more data streams.", + "operationId": "indices-get-data-stream-options", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "Comma-separated list of data streams to limit the request.\nSupports wildcards (`*`).\nTo target all data streams, omit this parameter or use `*` or `_all`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types.DataStreamNames" + }, + "style": "simple" + }, + { + "in": "query", + "name": "expand_wildcards", + "description": "Type of data stream that wildcard patterns can match.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types.ExpandWildcards" + }, + "style": "form" + }, + { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types.Duration" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data_streams": { + "type": "array", + "items": { + "$ref": "#/components/schemas/indices.get_data_stream_options.DataStreamWithOptions" + } + } + }, + "required": [ + "data_streams" + ] + } + } + } + } + }, + "x-state": "Generally available; Added in 8.19.0", + "x-metaTags": [ + { + "content": "Elasticsearch", + "name": "product_name" + } + ] + }, + "put": { + "tags": [ + "data stream" + ], + "summary": "Update data stream options", + "description": "Update the data stream options of the specified data streams.", + "operationId": "indices-put-data-stream-options", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "Comma-separated list of data streams used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams use `*` or `_all`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types.DataStreamNames" + }, + "style": "simple" + }, + { + "in": "query", + "name": "expand_wildcards", + "description": "Type of data stream that wildcard patterns can match.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `hidden`, `open`, `closed`, `none`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types.ExpandWildcards" + }, + "style": "form" + }, + { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types.Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types.Duration" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "failure_store": { + "description": "If defined, it will update the failure store configuration of every data stream resolved by the name expression.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamFailureStore" + } + ] + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types.AcknowledgedResponseBase" + } + } + } + } + }, + "x-state": "Generally available; Added in 8.19.0", + "x-metaTags": [ + { + "content": "Elasticsearch", + "name": "product_name" + } + ] + }, + "delete": { + "tags": [ + "data stream" + ], + "summary": "Delete data stream options", + "description": "Removes the data stream options from a data stream.", + "operationId": "indices-delete-data-stream-options", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "A comma-separated list of data streams of which the data stream options will be deleted.\nUse `*` to get all data streams", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types.DataStreamNames" + }, + "style": "simple" + }, + { + "in": "query", + "name": "expand_wildcards", + "description": "Whether wildcard expressions should get expanded to open or closed indices", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types.ExpandWildcards" + }, + "style": "form" + }, + { + "in": "query", + "name": "master_timeout", + "description": "The period to wait for a connection to the master node.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types.Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "The period to wait for a response.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types.Duration" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types.AcknowledgedResponseBase" + }, + "examples": { + "IndicesDeleteDataStreamOptionsResponseExample1": { + "description": "A successful response for deleting data stream options.", + "value": "{\n \"acknowledged\": true\n}" + } + } + } + } + } + }, + "x-state": "Generally available; Added in 8.19.0", + "x-metaTags": [ + { + "content": "Elasticsearch", + "name": "product_name" + } + ] + } + }, "/_index_template/{name}": { "get": { "tags": [ @@ -82860,6 +83099,18 @@ "$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover" } ] + }, + "data_stream_options": { + "x-state": "Generally available; Added in 8.19.0", + "oneOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamOptionsTemplate" + }, + { + "nullable": true, + "type": "string" + } + ] } } }, @@ -86048,6 +86299,77 @@ "fixed_interval" ] }, + "indices._types.DataStreamOptionsTemplate": { + "description": "Data stream options template contains the same information as DataStreamOptions but allows them to be set explicitly to null.", + "type": "object", + "properties": { + "failure_store": { + "oneOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamFailureStoreTemplate" + }, + { + "nullable": true, + "type": "string" + } + ] + } + } + }, + "indices._types.DataStreamFailureStoreTemplate": { + "description": "Template equivalent of DataStreamFailureStore that allows nullable values.", + "type": "object", + "properties": { + "enabled": { + "description": "If defined, it turns the failure store on/off (`true`/`false`) for this data stream. A data stream failure store\nthat's disabled (enabled: `false`) will redirect no new failed indices to the failure store; however, it will\nnot remove any existing data from the failure store.", + "default": "true", + "oneOf": [ + { + "type": "boolean" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "lifecycle": { + "description": "If defined, it specifies the lifecycle configuration for the failure store of this data stream.", + "oneOf": [ + { + "$ref": "#/components/schemas/indices._types.FailureStoreLifecycleTemplate" + }, + { + "nullable": true, + "type": "string" + } + ] + } + } + }, + "indices._types.FailureStoreLifecycleTemplate": { + "description": "Template equivalent of FailureStoreLifecycle that allows nullable values.", + "type": "object", + "properties": { + "data_retention": { + "description": "If defined, every document added to this data stream will be stored at least for this time frame.\nAny time after this duration the document could be deleted.\nWhen empty, every document in this data stream will be stored indefinitely.", + "oneOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "enabled": { + "description": "If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle\nthat's disabled (enabled: `false`) will have no effect on the data stream.", + "default": true, + "type": "boolean" + } + } + }, "_types.Level": { "type": "string", "enum": [ @@ -95151,6 +95473,80 @@ "name" ] }, + "indices.get_data_stream_options.DataStreamWithOptions": { + "type": "object", + "properties": { + "name": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.DataStreamName" + } + ] + }, + "options": { + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamOptions" + } + ] + } + }, + "required": [ + "name" + ] + }, + "indices._types.DataStreamOptions": { + "description": "Data stream options contain the configuration of data stream level features for a given data stream, for example,\nthe failure store configuration.", + "type": "object", + "properties": { + "failure_store": { + "description": "If defined, it specifies configuration for the failure store of this data stream.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamFailureStore" + } + ] + } + } + }, + "indices._types.DataStreamFailureStore": { + "description": "Data stream failure store contains the configuration of the failure store for a given data stream.", + "type": "object", + "properties": { + "enabled": { + "description": "If defined, it turns the failure store on/off (`true`/`false`) for this data stream. A data stream failure store\nthat's disabled (enabled: `false`) will redirect no new failed indices to the failure store; however, it will\nnot remove any existing data from the failure store.", + "default": true, + "type": "boolean" + }, + "lifecycle": { + "description": "If defined, it specifies the lifecycle configuration for the failure store of this data stream.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.FailureStoreLifecycle" + } + ] + } + } + }, + "indices._types.FailureStoreLifecycle": { + "description": "The failure store lifecycle configures the data stream lifecycle configuration for failure indices.", + "type": "object", + "properties": { + "data_retention": { + "description": "If defined, every document added to this data stream will be stored at least for this time frame.\nAny time after this duration the document could be deleted.\nWhen empty, every document in this data stream will be stored indefinitely.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] + }, + "enabled": { + "description": "If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle\nthat's disabled (enabled: `false`) will have no effect on the data stream.", + "default": true, + "type": "boolean" + } + } + }, "indices.get_data_stream_settings.DataStreamSettings": { "type": "object", "properties": { @@ -95348,6 +95744,18 @@ "$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover" } ] + }, + "data_stream_options": { + "x-state": "Generally available; Added in 8.19.0", + "oneOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamOptionsTemplate" + }, + { + "nullable": true, + "type": "string" + } + ] } } }, diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 73203937af..fc0374cd31 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -9260,6 +9260,169 @@ ] } }, + "/_data_stream/{name}/_options": { + "get": { + "tags": [ + "data stream" + ], + "summary": "Get data stream options", + "description": "Get the data stream options configuration of one or more data streams.", + "operationId": "indices-get-data-stream-options", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "Comma-separated list of data streams to limit the request.\nSupports wildcards (`*`).\nTo target all data streams, omit this parameter or use `*` or `_all`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types.DataStreamNames" + }, + "style": "simple" + }, + { + "in": "query", + "name": "expand_wildcards", + "description": "Type of data stream that wildcard patterns can match.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types.ExpandWildcards" + }, + "style": "form" + }, + { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types.Duration" + }, + "style": "form" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data_streams": { + "type": "array", + "items": { + "$ref": "#/components/schemas/indices.get_data_stream_options.DataStreamWithOptions" + } + } + }, + "required": [ + "data_streams" + ] + } + } + } + } + }, + "x-state": "Generally available", + "x-metaTags": [ + { + "content": "Elasticsearch", + "name": "product_name" + } + ] + }, + "put": { + "tags": [ + "data stream" + ], + "summary": "Update data stream options", + "description": "Update the data stream options of the specified data streams.", + "operationId": "indices-put-data-stream-options", + "parameters": [ + { + "in": "path", + "name": "name", + "description": "Comma-separated list of data streams used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams use `*` or `_all`.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types.DataStreamNames" + }, + "style": "simple" + }, + { + "in": "query", + "name": "expand_wildcards", + "description": "Type of data stream that wildcard patterns can match.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `hidden`, `open`, `closed`, `none`.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types.ExpandWildcards" + }, + "style": "form" + }, + { + "in": "query", + "name": "master_timeout", + "description": "Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types.Duration" + }, + "style": "form" + }, + { + "in": "query", + "name": "timeout", + "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types.Duration" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "failure_store": { + "description": "If defined, it will update the failure store configuration of every data stream resolved by the name expression.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamFailureStore" + } + ] + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/_types.AcknowledgedResponseBase" + } + } + } + } + }, + "x-state": "Generally available", + "x-metaTags": [ + { + "content": "Elasticsearch", + "name": "product_name" + } + ] + } + }, "/_data_stream/{name}/_settings": { "get": { "tags": [ @@ -48198,6 +48361,18 @@ "$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover" } ] + }, + "data_stream_options": { + "x-state": "Generally available", + "oneOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamOptionsTemplate" + }, + { + "nullable": true, + "type": "string" + } + ] } } }, @@ -58231,6 +58406,77 @@ "fixed_interval" ] }, + "indices._types.DataStreamOptionsTemplate": { + "description": "Data stream options template contains the same information as DataStreamOptions but allows them to be set explicitly to null.", + "type": "object", + "properties": { + "failure_store": { + "oneOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamFailureStoreTemplate" + }, + { + "nullable": true, + "type": "string" + } + ] + } + } + }, + "indices._types.DataStreamFailureStoreTemplate": { + "description": "Template equivalent of DataStreamFailureStore that allows nullable values.", + "type": "object", + "properties": { + "enabled": { + "description": "If defined, it turns the failure store on/off (`true`/`false`) for this data stream. A data stream failure store\nthat's disabled (enabled: `false`) will redirect no new failed indices to the failure store; however, it will\nnot remove any existing data from the failure store.", + "default": "true", + "oneOf": [ + { + "type": "boolean" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "lifecycle": { + "description": "If defined, it specifies the lifecycle configuration for the failure store of this data stream.", + "oneOf": [ + { + "$ref": "#/components/schemas/indices._types.FailureStoreLifecycleTemplate" + }, + { + "nullable": true, + "type": "string" + } + ] + } + } + }, + "indices._types.FailureStoreLifecycleTemplate": { + "description": "Template equivalent of FailureStoreLifecycle that allows nullable values.", + "type": "object", + "properties": { + "data_retention": { + "description": "If defined, every document added to this data stream will be stored at least for this time frame.\nAny time after this duration the document could be deleted.\nWhen empty, every document in this data stream will be stored indefinitely.", + "oneOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + }, + { + "nullable": true, + "type": "string" + } + ] + }, + "enabled": { + "description": "If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle\nthat's disabled (enabled: `false`) will have no effect on the data stream.", + "default": true, + "type": "boolean" + } + } + }, "_types.ClusterInfoTargets": { "oneOf": [ { @@ -61704,6 +61950,80 @@ "name" ] }, + "indices.get_data_stream_options.DataStreamWithOptions": { + "type": "object", + "properties": { + "name": { + "allOf": [ + { + "$ref": "#/components/schemas/_types.DataStreamName" + } + ] + }, + "options": { + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamOptions" + } + ] + } + }, + "required": [ + "name" + ] + }, + "indices._types.DataStreamOptions": { + "description": "Data stream options contain the configuration of data stream level features for a given data stream, for example,\nthe failure store configuration.", + "type": "object", + "properties": { + "failure_store": { + "description": "If defined, it specifies configuration for the failure store of this data stream.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamFailureStore" + } + ] + } + } + }, + "indices._types.DataStreamFailureStore": { + "description": "Data stream failure store contains the configuration of the failure store for a given data stream.", + "type": "object", + "properties": { + "enabled": { + "description": "If defined, it turns the failure store on/off (`true`/`false`) for this data stream. A data stream failure store\nthat's disabled (enabled: `false`) will redirect no new failed indices to the failure store; however, it will\nnot remove any existing data from the failure store.", + "default": true, + "type": "boolean" + }, + "lifecycle": { + "description": "If defined, it specifies the lifecycle configuration for the failure store of this data stream.", + "allOf": [ + { + "$ref": "#/components/schemas/indices._types.FailureStoreLifecycle" + } + ] + } + } + }, + "indices._types.FailureStoreLifecycle": { + "description": "The failure store lifecycle configures the data stream lifecycle configuration for failure indices.", + "type": "object", + "properties": { + "data_retention": { + "description": "If defined, every document added to this data stream will be stored at least for this time frame.\nAny time after this duration the document could be deleted.\nWhen empty, every document in this data stream will be stored indefinitely.", + "allOf": [ + { + "$ref": "#/components/schemas/_types.Duration" + } + ] + }, + "enabled": { + "description": "If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle\nthat's disabled (enabled: `false`) will have no effect on the data stream.", + "default": true, + "type": "boolean" + } + } + }, "indices.get_data_stream_settings.DataStreamSettings": { "type": "object", "properties": { @@ -61867,6 +62187,18 @@ "$ref": "#/components/schemas/indices._types.DataStreamLifecycleWithRollover" } ] + }, + "data_stream_options": { + "x-state": "Generally available", + "oneOf": [ + { + "$ref": "#/components/schemas/indices._types.DataStreamOptionsTemplate" + }, + { + "nullable": true, + "type": "string" + } + ] } } }, diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json index c4e151a82f..c10f202e7b 100644 --- a/output/schema/schema-serverless.json +++ b/output/schema/schema-serverless.json @@ -3664,6 +3664,42 @@ } ] }, + { + "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, + "stack": { + "since": "8.19.0", + "stability": "stable" + } + }, + "description": "Get data stream options.\n\nGet the data stream options configuration of one or more data streams.", + "docTag": "data stream", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", + "name": "indices.get_data_stream_options", + "request": { + "name": "Request", + "namespace": "indices.get_data_stream_options" + }, + "requestBodyRequired": false, + "response": { + "name": "Response", + "namespace": "indices.get_data_stream_options" + }, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "GET" + ], + "path": "/_data_stream/{name}/_options" + } + ] + }, { "availability": { "serverless": { @@ -3983,6 +4019,45 @@ } ] }, + { + "availability": { + "serverless": { + "stability": "stable", + "visibility": "public" + }, + "stack": { + "since": "8.19.0", + "stability": "stable" + } + }, + "description": "Update data stream options.\nUpdate the data stream options of the specified data streams.", + "docTag": "data stream", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", + "name": "indices.put_data_stream_options", + "request": { + "name": "Request", + "namespace": "indices.put_data_stream_options" + }, + "requestBodyRequired": false, + "requestMediaType": [ + "application/json" + ], + "response": { + "name": "Response", + "namespace": "indices.put_data_stream_options" + }, + "responseMediaType": [ + "application/json" + ], + "urls": [ + { + "methods": [ + "PUT" + ], + "path": "/_data_stream/{name}/_options" + } + ] + }, { "availability": { "serverless": { @@ -24315,7 +24390,7 @@ }, "examples": { "IndicesGetDataLifecycleResponseExample1": { - "description": "A successful response from `GET _lifecycle/stats?human&pretty`.", + "description": "A successful response from `GET /_data_stream/{name}/_lifecycle?human&pretty`.", "value": "{\n \"data_streams\": [\n {\n \"name\": \"my-data-stream-1\",\n \"lifecycle\": {\n \"enabled\": true,\n \"data_retention\": \"7d\"\n }\n },\n {\n \"name\": \"my-data-stream-2\",\n \"lifecycle\": {\n \"enabled\": true,\n \"data_retention\": \"7d\"\n }\n }\n ]\n}" } }, @@ -24457,6 +24532,96 @@ }, "specLocation": "indices/get_data_stream/IndicesGetDataStreamResponse.ts#L22-L24" }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Get data stream options.\n\nGet the data stream options configuration of one or more data streams.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "indices.get_data_stream_options" + }, + "path": [ + { + "description": "Comma-separated list of data streams to limit the request.\nSupports wildcards (`*`).\nTo target all data streams, omit this parameter or use `*` or `_all`.", + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "DataStreamNames", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "Type of data stream that wildcard patterns can match.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.", + "name": "expand_wildcards", + "required": false, + "serverDefault": "open", + "type": { + "kind": "instance_of", + "type": { + "name": "ExpandWildcards", + "namespace": "_types" + } + } + }, + { + "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + } + ], + "specLocation": "indices/get_data_stream_options/IndicesGetDataStreamOptionsRequest.ts#L24-L62" + }, + { + "body": { + "kind": "properties", + "properties": [ + { + "name": "data_streams", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "DataStreamWithOptions", + "namespace": "indices.get_data_stream_options" + } + } + } + } + ] + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "indices.get_data_stream_options" + }, + "specLocation": "indices/get_data_stream_options/IndicesGetDataStreamOptionsResponse.ts#L23-L25" + }, { "attachedBehaviors": [ "CommonQueryParameters" @@ -25337,6 +25502,115 @@ }, "specLocation": "indices/put_data_lifecycle/IndicesPutDataLifecycleResponse.ts#L22-L24" }, + { + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "If defined, it will update the failure store configuration of every data stream resolved by the name expression.", + "name": "failure_store", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DataStreamFailureStore", + "namespace": "indices._types" + } + } + } + ] + }, + "description": "Update data stream options.\nUpdate the data stream options of the specified data streams.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "kind": "request", + "name": { + "name": "Request", + "namespace": "indices.put_data_stream_options" + }, + "path": [ + { + "description": "Comma-separated list of data streams used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams use `*` or `_all`.", + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "DataStreamNames", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "Type of data stream that wildcard patterns can match.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `hidden`, `open`, `closed`, `none`.", + "name": "expand_wildcards", + "required": false, + "serverDefault": "open", + "type": { + "kind": "instance_of", + "type": { + "name": "ExpandWildcards", + "namespace": "_types" + } + } + }, + { + "description": "Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "name": "timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + } + ], + "specLocation": "indices/put_data_stream_options/IndicesPutDataStreamOptionsRequest.ts#L25-L80" + }, + { + "body": { + "codegenName": "result", + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + } + }, + "kind": "response", + "name": { + "name": "Response", + "namespace": "indices.put_data_stream_options" + }, + "specLocation": "indices/put_data_stream_options/IndicesPutDataStreamOptionsResponse.ts#L22-L25" + }, { "attachedBehaviors": [ "CommonQueryParameters" @@ -115280,7 +115554,7 @@ } } ], - "specLocation": "cluster/_types/ComponentTemplate.ts#L27-L30" + "specLocation": "cluster/_types/ComponentTemplate.ts#L28-L31" }, { "kind": "interface", @@ -115336,7 +115610,7 @@ } } ], - "specLocation": "cluster/_types/ComponentTemplate.ts#L32-L41" + "specLocation": "cluster/_types/ComponentTemplate.ts#L33-L42" }, { "kind": "interface", @@ -115443,9 +115717,41 @@ "namespace": "indices._types" } } + }, + { + "availability": { + "serverless": { + "stability": "stable" + }, + "stack": { + "since": "8.19.0", + "stability": "stable" + } + }, + "name": "data_stream_options", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "DataStreamOptionsTemplate", + "namespace": "indices._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } } ], - "specLocation": "cluster/_types/ComponentTemplate.ts#L43-L55" + "specLocation": "cluster/_types/ComponentTemplate.ts#L44-L61" }, { "attachedBehaviors": [ @@ -119084,6 +119390,148 @@ ], "specLocation": "indices/_types/DataStreamLifecycle.ts#L60-L72" }, + { + "description": "Data stream options template contains the same information as DataStreamOptions but allows them to be set explicitly to null.", + "kind": "interface", + "name": { + "name": "DataStreamOptionsTemplate", + "namespace": "indices._types" + }, + "properties": [ + { + "name": "failure_store", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "DataStreamFailureStoreTemplate", + "namespace": "indices._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + } + ], + "specLocation": "indices/_types/DataStreamOptions.ts#L36-L41" + }, + { + "description": "Template equivalent of DataStreamFailureStore that allows nullable values.", + "kind": "interface", + "name": { + "name": "DataStreamFailureStoreTemplate", + "namespace": "indices._types" + }, + "properties": [ + { + "description": "If defined, it turns the failure store on/off (`true`/`false`) for this data stream. A data stream failure store\nthat's disabled (enabled: `false`) will redirect no new failed indices to the failure store; however, it will\nnot remove any existing data from the failure store.", + "name": "enabled", + "required": false, + "serverDefault": "true", + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "description": "If defined, it specifies the lifecycle configuration for the failure store of this data stream.", + "name": "lifecycle", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "FailureStoreLifecycleTemplate", + "namespace": "indices._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + } + ], + "specLocation": "indices/_types/DataStreamFailureStore.ts#L39-L54" + }, + { + "description": "Template equivalent of FailureStoreLifecycle that allows nullable values.", + "kind": "interface", + "name": { + "name": "FailureStoreLifecycleTemplate", + "namespace": "indices._types" + }, + "properties": [ + { + "description": "If defined, every document added to this data stream will be stored at least for this time frame.\nAny time after this duration the document could be deleted.\nWhen empty, every document in this data stream will be stored indefinitely.", + "name": "data_retention", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } + }, + { + "description": "If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle\nthat's disabled (enabled: `false`) will have no effect on the data stream.", + "name": "enabled", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "indices/_types/DataStreamFailureStore.ts#L74-L90" + }, { "kind": "interface", "name": { @@ -123927,6 +124375,133 @@ ], "specLocation": "indices/_types/DataStream.ts#L129-L134" }, + { + "kind": "interface", + "name": { + "name": "DataStreamWithOptions", + "namespace": "indices.get_data_stream_options" + }, + "properties": [ + { + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "DataStreamName", + "namespace": "_types" + } + } + }, + { + "name": "options", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DataStreamOptions", + "namespace": "indices._types" + } + } + } + ], + "specLocation": "indices/get_data_stream_options/IndicesGetDataStreamOptionsResponse.ts#L27-L30" + }, + { + "description": "Data stream options contain the configuration of data stream level features for a given data stream, for example,\nthe failure store configuration.", + "kind": "interface", + "name": { + "name": "DataStreamOptions", + "namespace": "indices._types" + }, + "properties": [ + { + "description": "If defined, it specifies configuration for the failure store of this data stream.", + "name": "failure_store", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DataStreamFailureStore", + "namespace": "indices._types" + } + } + } + ], + "specLocation": "indices/_types/DataStreamOptions.ts#L25-L34" + }, + { + "description": "Data stream failure store contains the configuration of the failure store for a given data stream.", + "kind": "interface", + "name": { + "name": "DataStreamFailureStore", + "namespace": "indices._types" + }, + "properties": [ + { + "description": "If defined, it turns the failure store on/off (`true`/`false`) for this data stream. A data stream failure store\nthat's disabled (enabled: `false`) will redirect no new failed indices to the failure store; however, it will\nnot remove any existing data from the failure store.", + "name": "enabled", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "If defined, it specifies the lifecycle configuration for the failure store of this data stream.", + "name": "lifecycle", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "FailureStoreLifecycle", + "namespace": "indices._types" + } + } + } + ], + "specLocation": "indices/_types/DataStreamFailureStore.ts#L22-L37" + }, + { + "description": "The failure store lifecycle configures the data stream lifecycle configuration for failure indices.", + "kind": "interface", + "name": { + "name": "FailureStoreLifecycle", + "namespace": "indices._types" + }, + "properties": [ + { + "description": "If defined, every document added to this data stream will be stored at least for this time frame.\nAny time after this duration the document could be deleted.\nWhen empty, every document in this data stream will be stored indefinitely.", + "name": "data_retention", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "description": "If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle\nthat's disabled (enabled: `false`) will have no effect on the data stream.", + "name": "enabled", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "indices/_types/DataStreamFailureStore.ts#L56-L72" + }, { "kind": "interface", "name": { @@ -124103,7 +124678,7 @@ } } ], - "specLocation": "indices/_types/IndexTemplate.ts#L28-L81" + "specLocation": "indices/_types/IndexTemplate.ts#L29-L82" }, { "kind": "interface", @@ -124178,9 +124753,41 @@ "namespace": "indices._types" } } + }, + { + "availability": { + "serverless": { + "stability": "stable" + }, + "stack": { + "since": "8.19.0", + "stability": "stable" + } + }, + "name": "data_stream_options", + "required": false, + "type": { + "items": [ + { + "kind": "instance_of", + "type": { + "name": "DataStreamOptionsTemplate", + "namespace": "indices._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ], + "kind": "union_of" + } } ], - "specLocation": "indices/_types/IndexTemplate.ts#L96-L118" + "specLocation": "indices/_types/IndexTemplate.ts#L97-L124" }, { "kind": "interface", @@ -124216,7 +124823,7 @@ } } ], - "specLocation": "indices/_types/IndexTemplate.ts#L83-L94" + "specLocation": "indices/_types/IndexTemplate.ts#L84-L95" }, { "kind": "interface", diff --git a/output/schema/schema.json b/output/schema/schema.json index 70825d16c4..c46a540ed0 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -7025,17 +7025,29 @@ }, { "availability": { - "stack": { + "serverless": { "stability": "stable", - "visibility": "public" + "visibility": "private" + }, + "stack": { + "since": "8.19.0", + "stability": "stable" } }, - "description": "Deletes the data stream options of the selected data streams", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", + "description": "Delete data stream options.\n\nRemoves the data stream options from a data stream.", + "docId": "data-stream-delete-options", + "docTag": "data stream", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-delete-data-stream-options", "name": "indices.delete_data_stream_options", - "request": null, + "request": { + "name": "Request", + "namespace": "indices.delete_data_stream_options" + }, "requestBodyRequired": false, - "response": null, + "response": { + "name": "Response", + "namespace": "indices.delete_data_stream_options" + }, "responseMediaType": [ "application/json" ], @@ -7764,17 +7776,29 @@ }, { "availability": { - "stack": { + "serverless": { "stability": "stable", "visibility": "public" + }, + "stack": { + "since": "8.19.0", + "stability": "stable" } }, - "description": "Returns the data stream options of the selected data streams", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", + "description": "Get data stream options.\n\nGet the data stream options configuration of one or more data streams.", + "docId": "data-stream-get-options", + "docTag": "data stream", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-get-data-stream-options", "name": "indices.get_data_stream_options", - "request": null, + "request": { + "name": "Request", + "namespace": "indices.get_data_stream_options" + }, "requestBodyRequired": false, - "response": null, + "response": { + "name": "Response", + "namespace": "indices.get_data_stream_options" + }, "responseMediaType": [ "application/json" ], @@ -8394,20 +8418,32 @@ }, { "availability": { - "stack": { + "serverless": { "stability": "stable", "visibility": "public" + }, + "stack": { + "since": "8.19.0", + "stability": "stable" } }, - "description": "Updates the data stream options of the selected data streams", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html", + "description": "Update data stream options.\n\nUpdate the data stream options of the specified data streams.", + "docId": "data-stream-update-options", + "docTag": "data stream", + "docUrl": "https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-update-data-stream-options", "name": "indices.put_data_stream_options", - "request": null, + "request": { + "name": "Request", + "namespace": "indices.put_data_stream_options" + }, "requestBodyRequired": true, "requestMediaType": [ "application/json" ], - "response": null, + "response": { + "name": "Response", + "namespace": "indices.put_data_stream_options" + }, "responseMediaType": [ "application/json" ], @@ -121355,7 +121391,7 @@ } } ], - "specLocation": "cluster/_types/ComponentTemplate.ts#L27-L30" + "specLocation": "cluster/_types/ComponentTemplate.ts#L28-L31" }, { "kind": "interface", @@ -121411,7 +121447,7 @@ } } ], - "specLocation": "cluster/_types/ComponentTemplate.ts#L32-L41" + "specLocation": "cluster/_types/ComponentTemplate.ts#L33-L42" }, { "kind": "interface", @@ -121518,9 +121554,41 @@ "namespace": "indices._types" } } + }, + { + "availability": { + "serverless": { + "stability": "stable" + }, + "stack": { + "since": "8.19.0", + "stability": "stable" + } + }, + "name": "data_stream_options", + "required": false, + "type": { + "kind": "union_of", + "items": [ + { + "kind": "instance_of", + "type": { + "name": "DataStreamOptionsTemplate", + "namespace": "indices._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ] + } } ], - "specLocation": "cluster/_types/ComponentTemplate.ts#L43-L55" + "specLocation": "cluster/_types/ComponentTemplate.ts#L44-L61" }, { "kind": "interface", @@ -146225,6 +146293,102 @@ ], "specLocation": "indices/_types/DataStream.ts#L46-L133" }, + { + "kind": "interface", + "description": "Data stream failure store contains the configuration of the failure store for a given data stream.", + "name": { + "name": "DataStreamFailureStore", + "namespace": "indices._types" + }, + "properties": [ + { + "description": "If defined, it turns the failure store on/off (`true`/`false`) for this data stream. A data stream failure store\nthat's disabled (enabled: `false`) will redirect no new failed indices to the failure store; however, it will\nnot remove any existing data from the failure store.", + "name": "enabled", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + }, + { + "description": "If defined, it specifies the lifecycle configuration for the failure store of this data stream.", + "name": "lifecycle", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "FailureStoreLifecycle", + "namespace": "indices._types" + } + } + } + ], + "specLocation": "indices/_types/DataStreamFailureStore.ts#L22-L37" + }, + { + "kind": "interface", + "description": "Template equivalent of DataStreamFailureStore that allows nullable values.", + "name": { + "name": "DataStreamFailureStoreTemplate", + "namespace": "indices._types" + }, + "properties": [ + { + "description": "If defined, it turns the failure store on/off (`true`/`false`) for this data stream. A data stream failure store\nthat's disabled (enabled: `false`) will redirect no new failed indices to the failure store; however, it will\nnot remove any existing data from the failure store.", + "name": "enabled", + "required": false, + "serverDefault": "true", + "type": { + "kind": "union_of", + "items": [ + { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ] + } + }, + { + "description": "If defined, it specifies the lifecycle configuration for the failure store of this data stream.", + "name": "lifecycle", + "required": false, + "type": { + "kind": "union_of", + "items": [ + { + "kind": "instance_of", + "type": { + "name": "FailureStoreLifecycleTemplate", + "namespace": "indices._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ] + } + } + ], + "specLocation": "indices/_types/DataStreamFailureStore.ts#L39-L54" + }, { "kind": "interface", "name": { @@ -146495,6 +146659,63 @@ ], "specLocation": "indices/_types/DataStreamLifecycle.ts#L47-L58" }, + { + "kind": "interface", + "description": "Data stream options contain the configuration of data stream level features for a given data stream, for example,\nthe failure store configuration.", + "name": { + "name": "DataStreamOptions", + "namespace": "indices._types" + }, + "properties": [ + { + "description": "If defined, it specifies configuration for the failure store of this data stream.", + "name": "failure_store", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DataStreamFailureStore", + "namespace": "indices._types" + } + } + } + ], + "specLocation": "indices/_types/DataStreamOptions.ts#L25-L34" + }, + { + "kind": "interface", + "description": "Data stream options template contains the same information as DataStreamOptions but allows them to be set explicitly to null.", + "name": { + "name": "DataStreamOptionsTemplate", + "namespace": "indices._types" + }, + "properties": [ + { + "name": "failure_store", + "required": false, + "type": { + "kind": "union_of", + "items": [ + { + "kind": "instance_of", + "type": { + "name": "DataStreamFailureStoreTemplate", + "namespace": "indices._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ] + } + } + ], + "specLocation": "indices/_types/DataStreamOptions.ts#L36-L41" + }, { "kind": "interface", "name": { @@ -146651,6 +146872,90 @@ ], "specLocation": "indices/_types/DataStream.ts#L40-L44" }, + { + "kind": "interface", + "description": "The failure store lifecycle configures the data stream lifecycle configuration for failure indices.", + "name": { + "name": "FailureStoreLifecycle", + "namespace": "indices._types" + }, + "properties": [ + { + "description": "If defined, every document added to this data stream will be stored at least for this time frame.\nAny time after this duration the document could be deleted.\nWhen empty, every document in this data stream will be stored indefinitely.", + "name": "data_retention", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "description": "If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle\nthat's disabled (enabled: `false`) will have no effect on the data stream.", + "name": "enabled", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "indices/_types/DataStreamFailureStore.ts#L56-L72" + }, + { + "kind": "interface", + "description": "Template equivalent of FailureStoreLifecycle that allows nullable values.", + "name": { + "name": "FailureStoreLifecycleTemplate", + "namespace": "indices._types" + }, + "properties": [ + { + "description": "If defined, every document added to this data stream will be stored at least for this time frame.\nAny time after this duration the document could be deleted.\nWhen empty, every document in this data stream will be stored indefinitely.", + "name": "data_retention", + "required": false, + "type": { + "kind": "union_of", + "items": [ + { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ] + } + }, + { + "description": "If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle\nthat's disabled (enabled: `false`) will have no effect on the data stream.", + "name": "enabled", + "required": false, + "serverDefault": true, + "type": { + "kind": "instance_of", + "type": { + "name": "boolean", + "namespace": "_builtins" + } + } + } + ], + "specLocation": "indices/_types/DataStreamFailureStore.ts#L74-L90" + }, { "kind": "interface", "name": { @@ -148517,7 +148822,7 @@ } } ], - "specLocation": "indices/_types/IndexTemplate.ts#L28-L81" + "specLocation": "indices/_types/IndexTemplate.ts#L29-L82" }, { "kind": "interface", @@ -148553,7 +148858,7 @@ } } ], - "specLocation": "indices/_types/IndexTemplate.ts#L83-L94" + "specLocation": "indices/_types/IndexTemplate.ts#L84-L95" }, { "kind": "interface", @@ -148628,9 +148933,41 @@ "namespace": "indices._types" } } + }, + { + "availability": { + "serverless": { + "stability": "stable" + }, + "stack": { + "since": "8.19.0", + "stability": "stable" + } + }, + "name": "data_stream_options", + "required": false, + "type": { + "kind": "union_of", + "items": [ + { + "kind": "instance_of", + "type": { + "name": "DataStreamOptionsTemplate", + "namespace": "indices._types" + } + }, + { + "kind": "instance_of", + "type": { + "name": "null", + "namespace": "_builtins" + } + } + ] + } } ], - "specLocation": "indices/_types/IndexTemplate.ts#L96-L118" + "specLocation": "indices/_types/IndexTemplate.ts#L97-L124" }, { "kind": "interface", @@ -153581,6 +153918,106 @@ }, "specLocation": "indices/delete_data_stream/IndicesDeleteDataStreamResponse.ts#L22-L24" }, + { + "kind": "request", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Delete data stream options.\n\nRemoves the data stream options from a data stream.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "name": { + "name": "Request", + "namespace": "indices.delete_data_stream_options" + }, + "path": [ + { + "description": "A comma-separated list of data streams of which the data stream options will be deleted.\nUse `*` to get all data streams", + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "DataStreamNames", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "Whether wildcard expressions should get expanded to open or closed indices", + "name": "expand_wildcards", + "required": false, + "serverDefault": "open", + "type": { + "kind": "instance_of", + "type": { + "name": "ExpandWildcards", + "namespace": "_types" + } + } + }, + { + "description": "The period to wait for a connection to the master node.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "description": "The period to wait for a response.", + "name": "timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + } + ], + "specLocation": "indices/delete_data_stream_options/IndicesDeleteDataStreamOptionsRequest.ts#L24-L65" + }, + { + "kind": "response", + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + } + }, + "examples": { + "IndicesDeleteDataStreamOptionsResponseExample1": { + "description": "A successful response for deleting data stream options.", + "value": "{\n \"acknowledged\": true\n}" + } + }, + "name": { + "name": "Response", + "namespace": "indices.delete_data_stream_options" + }, + "specLocation": "indices/delete_data_stream_options/IndicesDeleteDataStreamOptionsResponse.ts#L22-L25" + }, { "kind": "request", "attachedBehaviors": [ @@ -156765,6 +157202,128 @@ }, "specLocation": "indices/get_data_stream/IndicesGetDataStreamResponse.ts#L22-L24" }, + { + "kind": "interface", + "name": { + "name": "DataStreamWithOptions", + "namespace": "indices.get_data_stream_options" + }, + "properties": [ + { + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "DataStreamName", + "namespace": "_types" + } + } + }, + { + "name": "options", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DataStreamOptions", + "namespace": "indices._types" + } + } + } + ], + "specLocation": "indices/get_data_stream_options/IndicesGetDataStreamOptionsResponse.ts#L27-L30" + }, + { + "kind": "request", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Get data stream options.\n\nGet the data stream options configuration of one or more data streams.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "name": { + "name": "Request", + "namespace": "indices.get_data_stream_options" + }, + "path": [ + { + "description": "Comma-separated list of data streams to limit the request.\nSupports wildcards (`*`).\nTo target all data streams, omit this parameter or use `*` or `_all`.", + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "DataStreamNames", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "Type of data stream that wildcard patterns can match.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `open`, `closed`, `hidden`, `none`.", + "name": "expand_wildcards", + "required": false, + "serverDefault": "open", + "type": { + "kind": "instance_of", + "type": { + "name": "ExpandWildcards", + "namespace": "_types" + } + } + }, + { + "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + } + ], + "specLocation": "indices/get_data_stream_options/IndicesGetDataStreamOptionsRequest.ts#L24-L63" + }, + { + "kind": "response", + "body": { + "kind": "properties", + "properties": [ + { + "name": "data_streams", + "required": true, + "type": { + "kind": "array_of", + "value": { + "kind": "instance_of", + "type": { + "name": "DataStreamWithOptions", + "namespace": "indices.get_data_stream_options" + } + } + } + } + ] + }, + "name": { + "name": "Response", + "namespace": "indices.get_data_stream_options" + }, + "specLocation": "indices/get_data_stream_options/IndicesGetDataStreamOptionsResponse.ts#L23-L25" + }, { "kind": "interface", "name": { @@ -159246,6 +159805,114 @@ }, "specLocation": "indices/put_data_lifecycle/IndicesPutDataLifecycleResponse.ts#L22-L24" }, + { + "kind": "request", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "properties", + "properties": [ + { + "description": "If defined, it will update the failure store configuration of every data stream resolved by the name expression.", + "name": "failure_store", + "required": false, + "type": { + "kind": "instance_of", + "type": { + "name": "DataStreamFailureStore", + "namespace": "indices._types" + } + } + } + ] + }, + "description": "Update data stream options.\n\nUpdate the data stream options of the specified data streams.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "name": { + "name": "Request", + "namespace": "indices.put_data_stream_options" + }, + "path": [ + { + "description": "Comma-separated list of data streams used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams use `*` or `_all`.", + "name": "name", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "DataStreamNames", + "namespace": "_types" + } + } + } + ], + "query": [ + { + "description": "Type of data stream that wildcard patterns can match.\nSupports comma-separated values, such as `open,hidden`.\nValid values are: `all`, `hidden`, `open`, `closed`, `none`.", + "name": "expand_wildcards", + "required": false, + "serverDefault": "open", + "type": { + "kind": "instance_of", + "type": { + "name": "ExpandWildcards", + "namespace": "_types" + } + } + }, + { + "description": "Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.", + "name": "master_timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + }, + { + "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", + "name": "timeout", + "required": false, + "serverDefault": "30s", + "type": { + "kind": "instance_of", + "type": { + "name": "Duration", + "namespace": "_types" + } + } + } + ], + "specLocation": "indices/put_data_stream_options/IndicesPutDataStreamOptionsRequest.ts#L25-L82" + }, + { + "kind": "response", + "body": { + "kind": "value", + "value": { + "kind": "instance_of", + "type": { + "name": "AcknowledgedResponseBase", + "namespace": "_types" + } + } + }, + "name": { + "name": "Response", + "namespace": "indices.put_data_stream_options" + }, + "specLocation": "indices/put_data_stream_options/IndicesPutDataStreamOptionsResponse.ts#L22-L25" + }, { "kind": "interface", "name": { diff --git a/output/typescript/types.ts b/output/typescript/types.ts index 8a0241a7e1..3d8f1f1306 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -9542,6 +9542,7 @@ export interface ClusterComponentTemplateSummary { mappings?: MappingTypeMapping aliases?: Record lifecycle?: IndicesDataStreamLifecycleWithRollover + data_stream_options?: IndicesDataStreamOptionsTemplate | null } export interface ClusterAllocationExplainAllocationDecision { @@ -11869,6 +11870,16 @@ export interface IndicesDataStream { timestamp_field: IndicesDataStreamTimestampField } +export interface IndicesDataStreamFailureStore { + enabled?: boolean + lifecycle?: IndicesFailureStoreLifecycle +} + +export interface IndicesDataStreamFailureStoreTemplate { + enabled?: boolean | null + lifecycle?: IndicesFailureStoreLifecycleTemplate | null +} + export interface IndicesDataStreamIndex { index_name: IndexName index_uuid: Uuid @@ -11900,6 +11911,14 @@ export interface IndicesDataStreamLifecycleWithRollover extends IndicesDataStrea rollover?: IndicesDataStreamLifecycleRolloverConditions } +export interface IndicesDataStreamOptions { + failure_store?: IndicesDataStreamFailureStore +} + +export interface IndicesDataStreamOptionsTemplate { + failure_store?: IndicesDataStreamFailureStoreTemplate | null +} + export interface IndicesDataStreamTimestampField { name: Field } @@ -11924,6 +11943,16 @@ export interface IndicesFailureStore { rollover_on_write: boolean } +export interface IndicesFailureStoreLifecycle { + data_retention?: Duration + enabled?: boolean +} + +export interface IndicesFailureStoreLifecycleTemplate { + data_retention?: Duration | null + enabled?: boolean +} + export interface IndicesFielddataFrequencyFilter { max: double min: double @@ -12100,6 +12129,7 @@ export interface IndicesIndexTemplateSummary { mappings?: MappingTypeMapping settings?: IndicesIndexSettings lifecycle?: IndicesDataStreamLifecycleWithRollover + data_stream_options?: IndicesDataStreamOptionsTemplate | null } export interface IndicesIndexVersioning { @@ -12584,6 +12614,15 @@ export interface IndicesDeleteDataStreamRequest extends RequestBase { export type IndicesDeleteDataStreamResponse = AcknowledgedResponseBase +export interface IndicesDeleteDataStreamOptionsRequest extends RequestBase { + name: DataStreamNames + expand_wildcards?: ExpandWildcards + master_timeout?: Duration + timeout?: Duration +} + +export type IndicesDeleteDataStreamOptionsResponse = AcknowledgedResponseBase + export interface IndicesDeleteIndexTemplateRequest extends RequestBase { name: Names master_timeout?: Duration @@ -12847,6 +12886,21 @@ export interface IndicesGetDataStreamResponse { data_streams: IndicesDataStream[] } +export interface IndicesGetDataStreamOptionsDataStreamWithOptions { + name: DataStreamName + options?: IndicesDataStreamOptions +} + +export interface IndicesGetDataStreamOptionsRequest extends RequestBase { + name: DataStreamNames + expand_wildcards?: ExpandWildcards + master_timeout?: Duration +} + +export interface IndicesGetDataStreamOptionsResponse { + data_streams: IndicesGetDataStreamOptionsDataStreamWithOptions[] +} + export interface IndicesGetDataStreamSettingsDataStreamSettings { name: string settings: IndicesIndexSettings @@ -13057,6 +13111,18 @@ export interface IndicesPutDataLifecycleRequest extends RequestBase { export type IndicesPutDataLifecycleResponse = AcknowledgedResponseBase +export interface IndicesPutDataStreamOptionsRequest extends RequestBase { + name: DataStreamNames + expand_wildcards?: ExpandWildcards + master_timeout?: Duration + timeout?: Duration + body?: { + failure_store?: IndicesDataStreamFailureStore + } +} + +export type IndicesPutDataStreamOptionsResponse = AcknowledgedResponseBase + export interface IndicesPutDataStreamSettingsDataStreamSettingsError { index: IndexName error: string diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv index 5c2347a03a..89e9afa3d9 100644 --- a/specification/_doc_ids/table.csv +++ b/specification/_doc_ids/table.csv @@ -153,9 +153,11 @@ dangling-indices-list,https://www.elastic.co/guide/en/elasticsearch/reference/{b data-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/date-processor.html,, data-stream-delete,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-delete-data-stream.html,, data-stream-delete-lifecycle,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-streams-delete-lifecycle.html,, +data-stream-delete-options,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-delete-data-stream-options,, data-stream-explain-lifecycle,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-streams-explain-lifecycle.html,, data-stream-get,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-get-data-stream.html,, data-stream-get-lifecycle,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-streams-get-lifecycle.html,, +data-stream-get-options,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-get-data-stream-options,, data-stream-lifecycle,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-stream-lifecycle.html,, data-stream-lifecycle-stats,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-streams-get-lifecycle-stats.html,, data-stream-path-param,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-create-data-stream.html#indices-create-data-stream-api-path-params,, @@ -164,6 +166,7 @@ data-stream-promote,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operati data-stream-put-lifecycle,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-put-data-lifecycle,, data-stream-stats-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-stream-stats-api.html,, data-stream-update,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-modify-data-stream,, +data-stream-update-options,https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-indices-update-data-stream-options,, data-streams,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/data-streams.html,, date-index-name-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/date-index-name-processor.html,, dcg,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#_discounted_cumulative_gain_dcg,, diff --git a/specification/cluster/_types/ComponentTemplate.ts b/specification/cluster/_types/ComponentTemplate.ts index 3d287fbe54..2c9c497157 100644 --- a/specification/cluster/_types/ComponentTemplate.ts +++ b/specification/cluster/_types/ComponentTemplate.ts @@ -21,6 +21,7 @@ import { IndexName, Metadata, Name, VersionNumber } from '@_types/common' import { TypeMapping } from '@_types/mapping/TypeMapping' import { AliasDefinition } from '@indices/_types/AliasDefinition' import { DataStreamLifecycleWithRollover } from '@indices/_types/DataStreamLifecycle' +import { DataStreamOptionsTemplate } from '@indices/_types/DataStreamOptions' import { IndexSettings } from '@indices/_types/IndexSettings' import { Dictionary } from '@spec_utils/Dictionary' @@ -52,4 +53,9 @@ export class ComponentTemplateSummary { * @availability serverless stability=stable */ lifecycle?: DataStreamLifecycleWithRollover + /** + * @availability stack since=8.19.0 stability=stable + * @availability serverless stability=stable + */ + data_stream_options?: DataStreamOptionsTemplate | null } diff --git a/specification/indices/_types/DataStreamFailureStore.ts b/specification/indices/_types/DataStreamFailureStore.ts new file mode 100644 index 0000000000..a60f0ceb08 --- /dev/null +++ b/specification/indices/_types/DataStreamFailureStore.ts @@ -0,0 +1,90 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { Duration } from '@_types/Time' + +/** + * Data stream failure store contains the configuration of the failure store for a given data stream. + */ +export class DataStreamFailureStore { + /** + * If defined, it turns the failure store on/off (`true`/`false`) for this data stream. A data stream failure store + * that's disabled (enabled: `false`) will redirect no new failed indices to the failure store; however, it will + * not remove any existing data from the failure store. + * @server_default true + */ + enabled?: boolean + /** + * If defined, it specifies the lifecycle configuration for the failure store of this data stream. + */ + lifecycle?: FailureStoreLifecycle +} + +/** + * Template equivalent of DataStreamFailureStore that allows nullable values. + */ +export class DataStreamFailureStoreTemplate { + /** + * If defined, it turns the failure store on/off (`true`/`false`) for this data stream. A data stream failure store + * that's disabled (enabled: `false`) will redirect no new failed indices to the failure store; however, it will + * not remove any existing data from the failure store. + * @server_default true + */ + enabled?: boolean | null + /** + * If defined, it specifies the lifecycle configuration for the failure store of this data stream. + */ + lifecycle?: FailureStoreLifecycleTemplate | null +} + +/** + * The failure store lifecycle configures the data stream lifecycle configuration for failure indices. + */ +export class FailureStoreLifecycle { + /** + * If defined, every document added to this data stream will be stored at least for this time frame. + * Any time after this duration the document could be deleted. + * When empty, every document in this data stream will be stored indefinitely. + */ + data_retention?: Duration + /** + * If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle + * that's disabled (enabled: `false`) will have no effect on the data stream. + * @server_default true + */ + enabled?: boolean +} + +/** + * Template equivalent of FailureStoreLifecycle that allows nullable values. + */ +export class FailureStoreLifecycleTemplate { + /** + * If defined, every document added to this data stream will be stored at least for this time frame. + * Any time after this duration the document could be deleted. + * When empty, every document in this data stream will be stored indefinitely. + */ + data_retention?: Duration | null + /** + * If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle + * that's disabled (enabled: `false`) will have no effect on the data stream. + * @server_default true + */ + enabled?: boolean +} diff --git a/specification/indices/_types/DataStreamOptions.ts b/specification/indices/_types/DataStreamOptions.ts new file mode 100644 index 0000000000..43aece3a35 --- /dev/null +++ b/specification/indices/_types/DataStreamOptions.ts @@ -0,0 +1,41 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { + DataStreamFailureStore, + DataStreamFailureStoreTemplate +} from '@indices/_types/DataStreamFailureStore' + +/** + * Data stream options contain the configuration of data stream level features for a given data stream, for example, + * the failure store configuration. + */ +export class DataStreamOptions { + /** + * If defined, it specifies configuration for the failure store of this data stream. + */ + failure_store?: DataStreamFailureStore +} + +/** + * Data stream options template contains the same information as DataStreamOptions but allows them to be set explicitly to null. + */ +export class DataStreamOptionsTemplate { + failure_store?: DataStreamFailureStoreTemplate | null +} diff --git a/specification/indices/_types/IndexTemplate.ts b/specification/indices/_types/IndexTemplate.ts index 423bba3c3b..11bc360164 100644 --- a/specification/indices/_types/IndexTemplate.ts +++ b/specification/indices/_types/IndexTemplate.ts @@ -21,6 +21,7 @@ import { IndexName, Metadata, Name, Names, VersionNumber } from '@_types/common' import { TypeMapping } from '@_types/mapping/TypeMapping' import { long } from '@_types/Numeric' import { DataStreamLifecycleWithRollover } from '@indices/_types/DataStreamLifecycle' +import { DataStreamOptionsTemplate } from '@indices/_types/DataStreamOptions' import { Dictionary } from '@spec_utils/Dictionary' import { Alias } from './Alias' import { IndexSettings } from './IndexSettings' @@ -115,4 +116,9 @@ export class IndexTemplateSummary { * @availability serverless stability=stable */ lifecycle?: DataStreamLifecycleWithRollover + /** + * @availability stack since=8.19.0 stability=stable + * @availability serverless stability=stable + */ + data_stream_options?: DataStreamOptionsTemplate | null } diff --git a/specification/indices/delete_data_stream_options/IndicesDeleteDataStreamOptionsRequest.ts b/specification/indices/delete_data_stream_options/IndicesDeleteDataStreamOptionsRequest.ts new file mode 100644 index 0000000000..35edb921dd --- /dev/null +++ b/specification/indices/delete_data_stream_options/IndicesDeleteDataStreamOptionsRequest.ts @@ -0,0 +1,65 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { RequestBase } from '@_types/Base' +import { DataStreamNames, ExpandWildcards } from '@_types/common' +import { Duration } from '@_types/Time' + +/** + * Delete data stream options. + * + * Removes the data stream options from a data stream. + * @rest_spec_name indices.delete_data_stream_options + * @availability stack since=8.19.0 stability=stable + * @availability serverless stability=stable visibility=private + * @doc_tag data stream + * @doc_id data-stream-delete-options + */ +export interface Request extends RequestBase { + urls: [ + { + path: '/_data_stream/{name}/_options' + methods: ['DELETE'] + } + ] + path_parts: { + /** + * A comma-separated list of data streams of which the data stream options will be deleted. + * Use `*` to get all data streams + */ + name: DataStreamNames + } + query_parameters: { + /** + * Whether wildcard expressions should get expanded to open or closed indices + * @server_default open + */ + expand_wildcards?: ExpandWildcards + /** + * The period to wait for a connection to the master node. + * @server_default 30s + */ + master_timeout?: Duration + /** + * The period to wait for a response. + * @server_default 30s + */ + timeout?: Duration + } +} diff --git a/specification/indices/delete_data_stream_options/IndicesDeleteDataStreamOptionsResponse.ts b/specification/indices/delete_data_stream_options/IndicesDeleteDataStreamOptionsResponse.ts new file mode 100644 index 0000000000..9e7bdb91cd --- /dev/null +++ b/specification/indices/delete_data_stream_options/IndicesDeleteDataStreamOptionsResponse.ts @@ -0,0 +1,25 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { AcknowledgedResponseBase } from '@_types/Base' + +export class Response { + /** @codegen_name result */ + body: AcknowledgedResponseBase +} diff --git a/specification/indices/delete_data_stream_options/examples/200_response/IndicesDeleteDataStreamOptionsResponseExample1.yaml b/specification/indices/delete_data_stream_options/examples/200_response/IndicesDeleteDataStreamOptionsResponseExample1.yaml new file mode 100644 index 0000000000..f0575c2b4c --- /dev/null +++ b/specification/indices/delete_data_stream_options/examples/200_response/IndicesDeleteDataStreamOptionsResponseExample1.yaml @@ -0,0 +1,5 @@ +# summary: '' +description: A successful response for deleting data stream options. +# type: response +# response_code: 200 +value: "{\n \"acknowledged\": true\n}" diff --git a/specification/indices/get_data_stream_options/IndicesGetDataStreamOptionsRequest.ts b/specification/indices/get_data_stream_options/IndicesGetDataStreamOptionsRequest.ts new file mode 100644 index 0000000000..ca5768ce29 --- /dev/null +++ b/specification/indices/get_data_stream_options/IndicesGetDataStreamOptionsRequest.ts @@ -0,0 +1,63 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { RequestBase } from '@_types/Base' +import { DataStreamNames, ExpandWildcards } from '@_types/common' +import { Duration } from '@_types/Time' + +/** + * Get data stream options. + * + * Get the data stream options configuration of one or more data streams. + * @rest_spec_name indices.get_data_stream_options + * @availability stack since=8.19.0 stability=stable + * @availability serverless stability=stable visibility=public + * @doc_tag data stream + * @doc_id data-stream-get-options + */ +export interface Request extends RequestBase { + urls: [ + { + path: '/_data_stream/{name}/_options' + methods: ['GET'] + } + ] + path_parts: { + /** + * Comma-separated list of data streams to limit the request. + * Supports wildcards (`*`). + * To target all data streams, omit this parameter or use `*` or `_all`. + */ + name: DataStreamNames + } + query_parameters: { + /** + * Type of data stream that wildcard patterns can match. + * Supports comma-separated values, such as `open,hidden`. + * Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + * @server_default open + */ + expand_wildcards?: ExpandWildcards + /** + * Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. + * @server_default 30s + */ + master_timeout?: Duration + } +} diff --git a/specification/indices/get_data_stream_options/IndicesGetDataStreamOptionsResponse.ts b/specification/indices/get_data_stream_options/IndicesGetDataStreamOptionsResponse.ts new file mode 100644 index 0000000000..d8bd5e8974 --- /dev/null +++ b/specification/indices/get_data_stream_options/IndicesGetDataStreamOptionsResponse.ts @@ -0,0 +1,30 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { DataStreamName } from '@_types/common' +import { DataStreamOptions } from '@indices/_types/DataStreamOptions' + +export class Response { + body: { data_streams: DataStreamWithOptions[] } +} + +class DataStreamWithOptions { + name: DataStreamName + options?: DataStreamOptions +} diff --git a/specification/indices/put_data_stream_options/IndicesPutDataStreamOptionsRequest.ts b/specification/indices/put_data_stream_options/IndicesPutDataStreamOptionsRequest.ts new file mode 100644 index 0000000000..286d25aaff --- /dev/null +++ b/specification/indices/put_data_stream_options/IndicesPutDataStreamOptionsRequest.ts @@ -0,0 +1,82 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { RequestBase } from '@_types/Base' +import { DataStreamNames, ExpandWildcards } from '@_types/common' +import { Duration } from '@_types/Time' +import { DataStreamFailureStore } from '@indices/_types/DataStreamFailureStore' + +/** + * Update data stream options. + * + * Update the data stream options of the specified data streams. + * @rest_spec_name indices.put_data_stream_options + * @availability stack since=8.19.0 stability=stable + * @availability serverless stability=stable visibility=public + * @doc_tag data stream + * @doc_id data-stream-update-options + */ +export interface Request extends RequestBase { + urls: [ + { + path: '/_data_stream/{name}/_options' + methods: ['PUT'] + } + ] + path_parts: { + /** + * Comma-separated list of data streams used to limit the request. + * Supports wildcards (`*`). + * To target all data streams use `*` or `_all`. + */ + name: DataStreamNames + } + query_parameters: { + /** + * Type of data stream that wildcard patterns can match. + * Supports comma-separated values, such as `open,hidden`. + * Valid values are: `all`, `hidden`, `open`, `closed`, `none`. + * @server_default open + */ + expand_wildcards?: ExpandWildcards + /** + * Period to wait for a connection to the master node. If no response is + * received before the timeout expires, the request fails and returns an + * error. + * @server_default 30s + */ + master_timeout?: Duration + /** + * Period to wait for a response. + * If no response is received before the timeout expires, the request fails and returns an error. + * @server_default 30s + */ + timeout?: Duration + } + /* + * This is DataStreamOptions from @indices/_types/DataStreamOptions.ts, + * but kept as a properties body to avoid a breaking change + */ + body: { + /** + * If defined, it will update the failure store configuration of every data stream resolved by the name expression. + */ + failure_store?: DataStreamFailureStore + } +} diff --git a/specification/indices/put_data_stream_options/IndicesPutDataStreamOptionsResponse.ts b/specification/indices/put_data_stream_options/IndicesPutDataStreamOptionsResponse.ts new file mode 100644 index 0000000000..9e7bdb91cd --- /dev/null +++ b/specification/indices/put_data_stream_options/IndicesPutDataStreamOptionsResponse.ts @@ -0,0 +1,25 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import { AcknowledgedResponseBase } from '@_types/Base' + +export class Response { + /** @codegen_name result */ + body: AcknowledgedResponseBase +}